Class MasterDetailService

constructor

• new MasterDetailService(scope, createNestedScope): MasterDetailService

• Parameters

  • scope: TableScope

  • createNestedScope: NestedTableScopeFactory

  Returns MasterDetailService

Readonly options

collapseAll

• collapseAll(): number

• Collapses all detail rows (their contents are destroyed). No event per row.

  Returns number

  the number of rows that were collapsed

computeExtras

• computeExtras(): undefined | {
      heights: number[];
      rowIndices: number[];
  }

• The display indices and heights of the expanded master rows that are shown – the extras of the body row layout. Called by RenderScope when the row layout is built (after filtering, sorting, editing, a detail toggle …): one pass over the shown rows. Removes expanded rows that no longer exist in the model (getAllRows()).

  Returns undefined | {
      heights: number[];
      rowIndices: number[];
  }

  the extras, undefined without expanded rows

decorateCell

• decorateCell(cell, rowIndex, columnIndex): void

• Decorates a body cell of the toggle column of a master row with the expand icon (ge-table-detail-toggle).

  Parameters

  • cell: HTMLDivElement

    the rendered cell

  • rowIndex: number

    display index

  • columnIndex: number

    model column index

  Returns void

destroy

• destroy(): void

• Called when the table is destroyed: destroys all detail contents and removes the layer.

  Returns void

expandAll

• expandAll(): number

• Expands all master rows that are shown (their contents are created only when they scroll into view). No event per row.

  Returns number

  the number of rows that were expanded

getDetailElement

• getDetailElement(rowOrIndex): undefined | HTMLDivElement

• The container of a detail row (the element detailRenderer renders into) – only while its content exists.

  Parameters

  • rowOrIndex: unknown

    display index or row object

  Returns undefined | HTMLDivElement

  the container

getExpandedRows

• getExpandedRows(): unknown[]

• The expanded master rows (row objects; for models without row objects: undefined).

  Returns unknown[]

getLayer

• getLayer(): undefined | HTMLDivElement

• The detail layer (undefined without master/detail).

  Returns undefined | HTMLDivElement

getMasterRowIndexOf

• getMasterRowIndexOf(node): number

• The display index of the master row a DOM node belongs to (a detail row or something in it).

  Parameters

  • node: null | Node

    a node in the detail layer

  Returns number

  the display index, -1 if none

hasExpanded

• hasExpanded(): boolean

• True if at least one master row is expanded.

  Returns boolean

hasTabTarget

• hasTabTarget(rowIndex): boolean

• True if Tab on the master row rowIndex goes into its open detail row (a focusable element in it) – Excel-style editing then leaves Tab to this service.

  Parameters

  • rowIndex: number

    display row index of the focused cell

  Returns boolean

  true with a tab target

  Since

  1.1.99

isActive

• isActive(): boolean

• True if master/detail is configured (and the body is flat).

  Returns boolean

isExpanded

• isExpanded(rowOrIndex): boolean

• True if a row (display index or row object) is expanded.

  Parameters

  • rowOrIndex: unknown

    display index or row object

  Returns boolean

  whether its detail row is open

isExpandedAt

• isExpandedAt(rowIndex): boolean

• True if the master row at a display index is expanded.

  Parameters

  • rowIndex: number

    display index

  Returns boolean

  whether its detail row is open

isInLayer

• isInLayer(evt): boolean

• True if an event comes from a detail row (or a nested table in it) – the outer table ignores it.

  Parameters

  • evt: Event

    a DOM event while it is dispatched

  Returns boolean

  whether its path contains the detail layer

isMasterAt

• isMasterAt(rowIndex): boolean

• True if the row at a display index can be expanded (MasterDetailOptionsIf.isMaster).

  Parameters

  • rowIndex: number

    display index

  Returns boolean

  whether it is a master row

keyOf

• keyOf(row, rowIndex): unknown

• The id of a master row: options.getRowId, autoRestoreOptions.getRowId, the row object or its index.

  Parameters

  • row: unknown

  • rowIndex: number

  Returns unknown

layoutVisible

• layoutVisible(triples): void

• Shows the detail rows in view (called by RenderScope after the body rows were rendered): creates missing contents, sets their positions, hides the ones that left the view and destroys the oldest hidden contents beyond MasterDetailOptionsIf.maxRenderedDetails.

  Parameters

  • triples: number[]

    rowIndex, top, height of each detail row in view; top relative to the body top

  Returns void

refresh

• refresh(rowOrIndex): boolean

• Destroys the content of a detail row and creates it again (e.g. after the row's data changed).

  Parameters

  • rowOrIndex: unknown

    display index or row object

  Returns boolean

  false if the row is not expanded

setBounds

• setBounds(left, top, width, height): void

• Position and size of the layer: the visible body including the fixed columns, without the scroll bars.

  Parameters

  • left: number

    px in the host

  • top: number

    px in the host (below the header)

  • width: number

    px

  • height: number

    px

  Returns void

setExpanded

• setExpanded(rowOrIndex, expanded, source?): boolean

• Expands or collapses a master row. The table repaints and reports the change (TableScope).

  Parameters

  • rowOrIndex: unknown

    display index or row object

  • expanded: boolean

    the new state

  • Optional source: GeDetailEventSource = "api"

    what changed it (for the event)

  Returns boolean

  false if nothing changed (no master row, already in that state, no master/detail)

setExpandedRows

• setExpandedRows(rows, source?): boolean

• Expands exactly these rows and collapses all others – the restore of the table state. Rows that are no master rows are skipped. No event per row.

  Parameters

  • rows: readonly unknown[]

    row objects of the body model

  • Optional source: GeDetailEventSource = "api"

    what changed it

  Returns boolean

  true if something changed

startRenderPass

• startRenderPass(): void

• Called at the start of the body render pass: the column of the expand icon.

  Returns void