Skip to main content

ColumnPickerData

The ColumnPicker component expects and returns an array of objects conforming to the ColumnPickerData structure. This structure defines the properties needed by the component to render and manage columns.

interface ColumnPickerData {
/**
* A unique identifier for the column. Used internally for sorting and identification.
* Should correspond to a unique key in your data (e.g., a field name).
*/
id: string | number;
/**
* The title or header text displayed for the column in the picker UI.
*/
title: string;
/**
* A boolean indicating whether the column is currently visible.
*/
isVisible: boolean;
}

Example Object:

{
id: 'col1',
title: 'Column 1',
isVisible: true,
}

When the component returns updated column arrays via onColumnsChange or onDataBound, the objects will include id, title, and isVisible .