Options
All
  • Public
  • Public/Protected
  • All
Menu

A configuration for one subgrid - a basic layouting unit

Hierarchy

  • Subgrid

Index

Constructors

Properties

_asyncRenderingConfig: AsyncRenderingConfiguration
_asyncRenderingTimeout: number

The elements that are contained in the subgrid

_existingIdentifiers: Set<string> = ...

Grid area identifiers that are already in use

_grid: string[][] = []

A 2D representation of the grid element IDs

_renderedContent$: BehaviorSubject<DatafieldGridLayoutElement[]>

The elements that are contained in the subgrid and have already been rendered to the user

_runningTitleCount: IncrementingCounter = ...

Counter to assure element ID uniqueness

cols: number
gridAreas: string

the css gridAreas configuration, that determines the layout of the grids content

subgridId: string

Accessors

Methods

  • addRow(row: string[]): void
  • assureUniqueness(identifier: string): string
  • createGridAreasString(): void
  • destroy(): void
  • determineKeptFields(subgrid: Subgrid): void
  • Determines which elements from the provided subgrid are contained in this subgrid. Marks these elements as kept and displays them. Marks the remaining elements as new.

    New elements can be displayed asynchronously over time by calling the [renderContentOverTime]{@link Subgrid#renderContentOverTime} method.

    Parameters

    • subgrid: Subgrid

      the "previous" subgrid that is used to compute the element "difference"

    Returns void

  • displayAllFields(): void
  • fillEmptySpace(): void
  • finalize(): void
  • getGridColumns(): string
  • renderContentOverTime(callback: (() => void), first?: boolean): void
  • If elements are not sorted into new and kept, marks all elements as new. The [determineKeptFields]{@link Subgrid#determineKeptFields} method can be used to mark elements as kept.

    Then pushes the new elements with the kept elements into the output array over time as specified by the AsyncRenderingConfiguration provided in the subgrids constructor.

    Parameters

    • callback: (() => void)

      the function that is called once all new elements were pushed into the output array

        • (): void
        • Returns void

    • first: boolean = false

      whether this is the first subgrid that si rendered. If this is the first subgrid then on the initial rendering of elements a batch of new fields alongside the loader elements is displayed so that some content is immediately available. Otherwise The initial batch contains only loader elements. Being first effectively shortens the rendering by one batch, since the first loader-only batch is skipped.

    Returns void

  • spreadFieldRenderingOverTime(callback: (() => void), iteration?: number): void

Generated using TypeDoc