Usage
Typescript Import Format
//To use this interface, import as below.
import {GridHeaderMetadata} from "ojs/ojdatagridprovider";
For additional information visit:
Interface for metadata property for the header returned to the DataGrid from the GridHeaderItem#metadata.
Fields
-
description :string
-
Additional information to display to the user via popup.
- Since:
- 18.0.0
-
(nullable) expanded :('expanded'|'collapsed')
-
Whether a header is able to be expanded or collapsed. By default (if null) header is not expandable or collapsible.
- Since:
- 12.0.0
-
(nullable) filter :('filterable'|'filtered')
-
Controls whether the column header is filtered, filterable, or unfilterable (null). The DataGrid component will investigate this metadata to trigger UI events to control column based filtering.
- Since:
- 16.0.0
-
(nullable) showRequired :boolean
-
If a field is required.
- Since:
- 13.0.0
-
(nullable) sortDirection :('ascending'|'descending'|'unsorted')
-
The direction the header is sorted, unsorted if no sort order, null if sorting not supported on this header.
- Since:
- 12.0.0
-
(nullable) treeDepth :number
-
If data is hierarchical, the depth of the node.
- Since:
- 12.0.0