PivotGridConfiguratorProps

Represents the props of the KendoReact PivotGridConfigurator component.

NameTypeDefaultDescription

className?

string

Sets the className property of the top-most element of the PivotGridConfigurator in addition to the default k-pivotgrid-configurator class.

columnAxes?

PivotGridAxis[]

The configuration of the column axes.

data?

PivotGridField[]

Sets the data of the PivotGridConfigurator.

The data represents all fields available in the configurator.

editor?

CustomComponent<PivotGridConfiguratorEditorProps>

Overrides the default editor component.

The default component is: PivotGridConfiguratorEditor.

filter?

FilterDescriptor[]

The descriptors by which the data is filtered.

form?

CustomComponent<FormProps>

Overrides the default form component.

The default component is: KendoReactForm.

formElement?

CustomComponent<FormElementProps>

Overrides the default formElement component.

The default component is: KendoReactFormElement.

horizontal?

boolean

Renders the PivotGridConfigurator in horizontal orientation.

id?

string

Sets the id property of the top-most element of the PivotGridConfigurator.

measureAxes?

PivotGridAxis[]

The configuration of the measure axes.

onAxisFilterFieldExpand?

(event?: PivotGridAxisFilterFieldExpandEvent) => void

A callback, fired whenever an AxisFilterField is expanded.

onAxisFilterFieldsExpandChange?

(event?: PivotGridAxisFilterFieldsExpandChangeEvent) => void

A callback, fired whenever the expanded state of the AxisFilterFields is changed.

onColumnAxesChange?

(event: PivotGridConfiguratorAxesChangeEvent) => void

A callback, fired whenever the columnAxes property should change.

onFieldsEditorFieldCheck?

(event: PivotGridFieldsEditorFieldCheckEvent) => void

A callback, fired whenever a field is checked.

onFieldsEditorFieldExpand?

(event: PivotGridFieldsEditorFieldExpandEvent) => void

A callback, fired whenever a field is expanded.

onFilterChange?

(event: PivotGridConfiguratorFilterChangeEvent) => void

A callback, fired whenever the filter property should change.

onMeasureAxesChange?

(event: PivotGridConfiguratorAxesChangeEvent) => void

A callback, fired whenever the measureAxes property should change.

onRowAxesChange?

(event: PivotGridConfiguratorAxesChangeEvent) => void

A callback, fired whenever the rowAxes property should change.

onSortChange?

(event: PivotGridConfiguratorSortChangeEvent) => void

A callback, fired whenever the sort property should change.

rowAxes?

PivotGridAxis[]

The configuration of the row axes.

sort?

SortDescriptor[]

The descriptors by which the data is sorted.

style?

React.CSSProperties

Sets the style property of the top-most element of the PivotGridConfigurator.

tabIndex?

number

Sets the tabIndex property of the top-most element of the PivotGridConfigurator.