@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>;
        columns: MappedArray<ColumnConfig<DataType>[], Column<DataType>>;
        modifiers: {
            columnHeader: FunctionBasedModifier<{}>;
            container: FunctionBasedModifier<{}>;
            row: FunctionBasedModifier<{}>;
        };
        rows: MappedArray<DataType[], Row<DataType>>;
        scrollContainerElement?: HTMLElement;
        scrollContainerHeight?: number;
        scrollContainerWidth?: number;
        get config(): TableConfig<DataType>;
        get plugins(): Plugin<unknown>[];
        get preferences(): TablePreferences;
        pluginOf<Instance extends BasePlugin<any>>(
            klass: Class<Instance>,
        ): Instance | undefined;
        resetScrollContainer(): void;
        resetToDefaults(): void;
    }

    Type Parameters

    • DataType = unknown
    Index

    Properties

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

    Accessors

    config plugins preferences

    Methods

    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> = ...
    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

    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 preferences(): TablePreferences

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

      When the preferences config is a function, the preferences are restored again every time the tracked data that the function reads changes.

      Returns TablePreferences

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods