Variable metaConst

Type Declaration

• withFeature: {
      forColumn<FeatureName extends string, Data = unknown>(
          column: Column<Data>,
          featureName: FeatureName,
      ): ColumnFeatures[FeatureName];
      forTable<FeatureName extends string, Data = unknown>(
          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

    • forColumn<FeatureName extends string, Data = unknown>(
          column: Column<Data>,
          featureName: FeatureName,
      ): ColumnFeatures[FeatureName]

      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

    • forTable<FeatureName extends string, Data = unknown>(
          table: Table<Data>,
          featureName: FeatureName,
      ): TableFeatures[FeatureName]

      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

  • forColumn<P extends BasePlugin<any>, Data = unknown>(
        column: Column<Data>,
        klass: Class<P>,
    ): ColumnMetaFor<SignatureFrom<P>>

    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

    • P extends BasePlugin<any>
    • Data = unknown

    Parameters

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

    Returns ColumnMetaFor<SignatureFrom<P>>

• forRow: function

  • forRow<P extends BasePlugin<any>, Data = unknown>(
        row: Row<Data>,
        klass: Class<P>,
    ): RowMetaFor<SignatureFrom<P>>

    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

    • P extends BasePlugin<any>
    • Data = unknown

    Parameters

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

    Returns RowMetaFor<SignatureFrom<P>>

• forTable: function

  • forTable<P extends BasePlugin<any>, Data = unknown>(
        table: Table<Data>,
        klass: Class<P>,
    ): TableMetaFor<SignatureFrom<P>>

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

    Type Parameters

    • P extends BasePlugin<any>
    • Data = unknown

    Parameters

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

    Returns TableMetaFor<SignatureFrom<P>>