1771 Technologies Logo

Grid API

MeasureApi

Provides API functions for interacting with grid measures.

Properties

  • Name
    getMeasureModel
    Type
    () => MeasureModel
    Description

    Returns the current measure model applied to the grid.

  • Name
    setMeasureModel
    Type
    (newModel: MeasureModel) => void
    Description

    Applies a new measure model to the grid. The measure model is an array of column Ids. These Ids must satisfy two constraints:

    • The Id must be present in the column definitions provided to the grid.
    • The column must have a value set for the ColumnDefinition.measure property.

    Any values that do not meet these constraints will be filtered out before applying the measure model to the grid state.