Variable metaConst

meta: {
    withFeature: {
        forColumn<FeatureName, Data>(column: Column<Data>, featureName: FeatureName): ColumnFeatures[FeatureName];
        forTable<FeatureName, Data>(table: Table<Data>, featureName: FeatureName): TableFeatures[FeatureName];
    };
    forColumn<P, Data>(column: Column<Data>, klass: Class<P>): ColumnMetaFor<SignatureFrom<P>>;
    forRow<P, Data>(row: Row<Data>, klass: Class<P>): RowMetaFor<SignatureFrom<P>>;
    forTable<P, Data>(table: Table<Data>, klass: Class<P>): TableMetaFor<SignatureFrom<P>>;
} = ...

Type declaration

  • withFeature: {
        forColumn<FeatureName, Data>(column: Column<Data>, featureName: FeatureName): ColumnFeatures[FeatureName];
        forTable<FeatureName, Data>(table: Table<Data>, featureName: FeatureName): TableFeatures[FeatureName];
    }

    Instead of finding meta based on column or table instances, you can search for meta based on feature strings, such as columnWidth

    • forColumn:function
      • for a given column and feature name, return the "ColumnMeta" for that feature. This is useful when plugins may depend on one another but may not necessarily care which plugin is providing what behavior.

        For example, multiple column-focused plugins may care about width or visibility

        Type Parameters

        • FeatureName extends string

        • Data = unknown

        Parameters

        • column: Column<Data>
        • featureName: FeatureName

        Returns ColumnFeatures[FeatureName]

    • forTable:function
      • for a given table and feature name, return the "TableMeta" for that feature. This is useful when plugins may depend on one another but may not necessarily care which plugin is providing that behavior.

        For example, multiple column-focused plugins may care about width or visibility.

        Type Parameters

        • FeatureName extends string

        • Data = unknown

        Parameters

        • table: Table<Data>
        • featureName: FeatureName

        Returns TableFeatures[FeatureName]

  • forColumn:function
    • For a given column and plugin, return the meta / state bucket for the plugin<->column instance pair.

      Note that this requires the column instance to exist on the table.

      Type Parameters

      Parameters

      • column: Column<Data>
      • klass: Class<P>

      Returns ColumnMetaFor<SignatureFrom<P>>

  • forRow:function
    • For a given row and plugin, return the meta / state bucket for the plugin<->row instance pair.

      Note that this requires the row instance to exist on the table.

      Type Parameters

      Parameters

      • row: Row<Data>
      • klass: Class<P>

      Returns RowMetaFor<SignatureFrom<P>>

  • forTable:function
    • For a given table and plugin, return the meta / state bucket for the plugin<->table instance pair.

      Type Parameters

      Parameters

      • table: Table<Data>
      • klass: Class<P>

      Returns TableMetaFor<SignatureFrom<P>>

Generated using TypeDoc