@universal-ember/table
    Preparing search index...

    Interface Table<DataType>

    interface Table<DataType = unknown> {
        "[COLUMN_META_KEY]": WeakMap<Column<unknown>, Map<Class<unknown>, any>>;
        "[ROW_META_KEY]": WeakMap<
            Row<Record<string, unknown>>,
            Map<Class<unknown>, any>,
        >;
        "[TABLE_KEY]": string;
        "[TABLE_META_KEY]": Map<Class<unknown>, any>;
        args: { named: TableConfig<DataType> };
        columns: MappedArray<ColumnConfig<DataType>[], Column<DataType>>;
        modifiers: {
            columnHeader: FunctionBasedModifier<{}>;
            container: FunctionBasedModifier<{}>;
            row: FunctionBasedModifier<{}>;
        };
        preferences: TablePreferences;
        rows: MappedArray<DataType[], Row<DataType>>;
        scrollContainerElement?: HTMLElement;
        scrollContainerHeight?: number;
        scrollContainerWidth?: number;
        get config(): TableConfig<DataType>;
        get plugins(): Plugin<unknown>[];
        modify(_: [] | undefined, named: TableConfig<DataType>): void;
        pluginOf<Instance extends BasePlugin<any>>(
            klass: Class<Instance>,
        ): Instance | undefined;
        resetScrollContainer(): void;
        resetToDefaults(): void;
    }

    Type Parameters

    • DataType = unknown

    Hierarchy

    Index

    Properties

    [COLUMN_META_KEY] [ROW_META_KEY] [TABLE_KEY] [TABLE_META_KEY] args columns modifiers preferences rows scrollContainerElement? scrollContainerHeight? scrollContainerWidth?

    Accessors

    config plugins

    Methods

    modify pluginOf resetScrollContainer resetToDefaults

    Properties

    "[COLUMN_META_KEY]": WeakMap<Column<unknown>, Map<Class<unknown>, any>> = ...
    "[ROW_META_KEY]": WeakMap<
        Row<Record<string, unknown>>,
        Map<Class<unknown>, any>,
    > = ...
    "[TABLE_KEY]": string = ...
    "[TABLE_META_KEY]": Map<Class<unknown>, any> = ...
    args: { named: TableConfig<DataType> }

    Lazy way to delay consuming arguments until they are needed.

    columns: MappedArray<ColumnConfig<DataType>[], Column<DataType>> = ...
    modifiers: {
        columnHeader: FunctionBasedModifier<{}>;
        container: FunctionBasedModifier<{}>;
        row: FunctionBasedModifier<{}>;
    } = ...

    Collection of utility modifiers that are the result of composing modifiers from plugins.

    Using this is optional, and you can "just" use modifiers from specific plugins in specific places if you wish -- but these exists as a "convenience".

    These are all no-use, no-cost utilities

    preferences: TablePreferences

    Interact with, save, modify, etc the preferences for the table, plugins, columns, etc

    rows: MappedArray<DataType[], Row<DataType>> = ...
    scrollContainerElement?: HTMLElement
    scrollContainerHeight?: number

    Unused for now, may be used in the future. This data is collected along with the scrollContainerWidth, (which is currently in use)

    scrollContainerWidth?: number

    Used to help determine how much space we can give to columns. As we generate widths for columns, the columns' widths must add up to about this number.

    Accessors

    • get plugins(): Plugin<unknown>[]
      Private

      For all configured plugins, instantiates each one. If the plugins argument changes to the Table (either directly or through headlessTable, all state is lost and re-created)

      Returns Plugin<unknown>[]

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods