1771 Technologies Logo

Components

ColumnManagerProps<T>

The properties for the Column Manager component of Graphite Grid. The Column Manager is a standalone component used to manage columns within Graphite Grid.

Type parameters

Type parameter
T

Properties

  • Name
    aggButtonClassName?
    Type
    string
    Description

    The CSS class to apply to the aggregation dropdown button. This button is

    shown when a column is aggregatable and allows selection of an aggregation

    method.

  • Name
    aggButtonStyle?
    Type
    CSSProperties
    Description

    The CSS styles to apply to the aggregation dropdown button. This button is

    shown when a column is aggregatable and allows selection of an aggregation

    method.

  • Name
    aggContainerClassName?
    Type
    string
    Description

    The CSS class to apply to the container of the aggregation dropdown

    options.

  • Name
    aggContainerStyle?
    Type
    CSSProperties
    Description

    The CSS styles to apply to the container of the aggregation dropdown

    options.

  • Name
    aggOptionClassName?
    Type
    string
    Description

    The CSS class to apply to the individual aggregation items in the

    aggregation dropdown.

  • Name
    aggOptionStyle?
    Type
    CSSProperties
    Description

    The CSS styles to apply to the individual aggregation items in the

    aggregation dropdown.

  • Name
    centerSectionClassName?
    Type
    string
    Description

    The CSS class to apply to the center column section. This section contains

    columns that are not pinned.

  • Name
    centerSectionStyle?
    Type
    CSSProperties
    Description

    The CSS styles to apply to the center column section. This section contains

    columns that are not pinned.

  • Name
    className?
    Type
    string
    Description

    The CSS class to apply to the main Column Manager container.

  • Name
    columnHiddenIcon?
    Type
    () => ReactNode
    Description

    The icon to display when a column is hidden.

  • Name
    columnNotHidableIcon?
    Type
    () => ReactNode
    Description

    The icon to display when a column cannot change its visibility via

    the Column Manager.

  • Name
    columnVisibleIcon?
    Type
    () => ReactNode
    Description

    The icon to display when a column is visible.

  • Name
    contentRenderer?
    Type
    (props: object) => ReactNode
    Description

    The React component to use to render the content of a column row in the

    Column Manager.

  • Name
    endSectionClassName?
    Type
    string
    Description

    The CSS class to apply to the end column section. This section contains

    rows for each column that is pinned to the end.

  • Name
    endSectionStyle?
    Type
    CSSProperties
    Description

    The CSS styles to apply to the end column section. This section contains

    rows for each column that is pinned to the end.

  • Name
    getAggregationsForColumn?
    Type
    (params: object) => (null | BuiltInFunctions | ColumnMeasure<T>)[]
    Description

    A function that returns the aggregations that may be applied to a column. By default, the built-in aggregations (min, max, first, etc.) are returned.

  • Name
    groupClassName?
    Type
    string
    Description

    The CSS class to apply to the rows that represent a column group. Columns

    may be grouped hierarchically in the Column Manager. Each group receives

    its own row.

  • Name
    groupContentRenderer?
    Type
    (props: object) => ReactNode
    Description

    The React component to use to render the content of a group row in the Column Manager. Only the content is changed by this prop. The move icons will still be displayed.

  • Name
    groupStyle?
    Type
    CSSProperties
    Description

    The CSS styles to apply to the rows that represent a column group. Columns

    may be grouped hierarchically in the Column Manager. Each group receives

    its own row.

  • Name
    moveIcon?
    Type
    () => ReactNode
    Description

    The icon to display for the move activator of the Column Manager.

  • Name
    movePlaceholder?
    Type
    (props: ColumnManagerMovePlaceholderProps<T>) => ReactNode
    Description

    A React component to render when columns in the Column Manager are being reordered. The component follows the mouse cursor.

  • Name
    notPinnableIcon?
    Type
    () => ReactNode
    Description

    The icon to display when a column cannot change its pin state via

    the Column Manager.

  • Name
    pinEndIcon?
    Type
    () => ReactNode
    Description

    The icon to display when a column is pinned to the end.

  • Name
    pinStartIcon?
    Type
    () => ReactNode
    Description

    The icon to display when a column is pinned to the start.

  • Name
    rowClassName?
    Type
    string
    Description

    The CSS class to apply to a row that will render a column in the Column

    Manager.

  • Name
    rowStyles?
    Type
    CSSProperties
    Description

    The CSS styles to apply to a row that will render a column in the Column

    Manager.

  • Name
    startSectionClassName?
    Type
    string
    Description

    The CSS class to apply to the start column section. This section contains

    rows for each column that is pinned to the start.

  • Name
    startSectionStyle?
    Type
    CSSProperties
    Description

    The CSS styles to apply to the start column section. This section contains

    rows for each column that is pinned to the start.

  • Name
    state
    Type
    GraphiteGridState<T>
    Description

    The Graphite Grid state that the Column Manager should operate on.

  • Name
    style?
    Type
    CSSProperties
    Description

    The CSS styles to apply to the main Column Manager container.

  • Name
    unpinnedIcon?
    Type
    () => ReactNode
    Description

    The icon to display when a column is not pinned.