Highcharts Grid
    Preparing search index...

    Class Column

    Represents a column in the data grid.

    Index

    Constructors

    constructor

    Properties

    cells data? dataType filtering? header? id index options sorting? viewport

    Methods

    createCellContent format getCellValue getWidth init loadData registerCell setHoveredState setSyncedState unregisterCell update

    Constructors

    • Constructs a column in the data grid.

      Parameters

      • viewport: Table

        The viewport (table) the column belongs to.

      • id: string

        The id of the column (name in the Data Table).

      • index: number

        The index of the column.

      Returns Column

    Properties

    cells: Cell[] = []

    The cells of the column.

    data?: Column

    The data of the column. Shouldn't be used directly in all cases, because it's not guaranteed to be defined (e.g. when using the lazy loading, RemoteDataProvider).

    dataType: ColumnDataType = 'string'

    Type of the data in the column.

    filtering?: ColumnFiltering

    Filtering column module.

    header?: HeaderCell

    The wrapper for content of head.

    id: string

    The id of the column (name in the Data Table).

    index: number

    The index of the column in the viewport.

    options: NoIdColumnOptions

    The options of the column as a proxy that provides merged access to original options and defaults if not defined in the individual options.

    sorting?: ColumnSorting

    Sorting column module.

    viewport: Table

    The viewport (table) the column belongs to.

    Methods

    • Returns the formatted string where the templating context is the column.

      Parameters

      • template: string

        The template string.

      Returns string

      The formatted string.

    • Resolves the raw value for a table cell.

      Parameters

      • cell: TableCell

        The cell to resolve the value for.

      Returns Promise<CellType>

    • Returns the width of the column in pixels.

      Returns number

    • Initializes the column data-related properties.

      Returns Promise<void>

    • Loads the data of the column from the viewport's data table.

      Returns void

    • Registers a cell in the column.

      Parameters

      • cell: Cell

        The cell to register.

      Returns void

    • Adds or removes the hovered CSS class to the column element and its cells.

      Parameters

      • hovered: boolean

        Whether the column should be hovered.

      Returns void

    • Adds or removes the synced CSS class to the column element and its cells.

      Parameters

      • synced: boolean

        Whether the column should have synced state.

      Returns void

    • Unregister a cell from the column.

      Parameters

      • cell: Cell

        The cell to unregister.

      Returns void

    Settings

    On This Page

    Constructors
    Properties
    Methods