PivotGridConfiguratorEditorProps

Premium

Represents the props of the KendoReact PivotGridConfiguratorEditor component.

Name	Type	Default	Description
allowSubmit	boolean		Shows whether the form can be submitted. When true and form is valid, you can submit. When true and form is invalid, you can show all validation errors. Use this to control the disabled state of Submit buttons. jsx console.log(props.allowSubmit);
columnAxesEditor?	CustomComponent<PivotGridAxesEditorProps>		Overrides the default columnAxesEditor component. The default component is: PivotGridAxesEditor.
columnAxesLabel?	CustomComponent<FieldProps intersected with LabelProps>		Overrides the default columnAxesLabel component. The default component is: KendoReactLabel.
data	PivotGridField[]		Sets the data of the PivotGridConfiguratorEditor. The data represents all fields available in the configurator.
errors	KeyValue<string>		Contains current validation errors organized by field path. jsx console.log(props.errors);
fieldsEditor?	CustomComponent<PivotGridFieldsEditorProps>		Overrides the default fieldsEditor component. The default component is: PivotGridFieldsEditor.
fieldsLabel?	CustomComponent<FieldProps intersected with LabelProps>		Overrides the default fieldsLabel component. The default component is: KendoReactLabel.
horizontal?	boolean	false	Renders the PivotGridConfiguratorEditor in horizontal orientation.
measureAxesEditor?	CustomComponent<PivotGridAxesEditorProps>		Overrides the default measureAxesEditor component. The default component is: PivotGridAxesEditor.
measureAxesLabel?	CustomComponent<FieldProps intersected with LabelProps>		Overrides the default measureAxesLabel component. The default component is: KendoReactLabel.
modified	boolean		Shows whether any field value has changed from its initial value. Becomes true when any field value changes for the first time. jsx console.log(props.modified);
onAxisFilterFieldExpand?	(event: PivotGridAxisFilterFieldExpandEvent intersected with { currentTarget: PivotGridConfiguratorEditorHandle; }) => void		A callback, fired whenever an AxisFilterField is expanded.
onAxisFilterFieldsExpandChange?	(event: PivotGridAxisFilterFieldsExpandChangeEvent) => void		A callback, fired whenever expanded state of the AxisFilterFields is changed.
onChange	(name: string, options: { value: any; }) => void		A callback for emitting changes to a specific field without using the Field component (see example). Use onChange only if you cannot achieve the desired behavior through the Field component. jsx props.onChange("user.name", { value: "John Doe" });
onFieldsEditorFieldCheck?	(event: PivotGridFieldsEditorFieldCheckEvent intersected with { currentTarget: PivotGridConfiguratorEditorHandle; }) => void		A callback, fired whenever a FieldEditorField is checked.
onFieldsEditorFieldExpand?	(event: PivotGridFieldsEditorFieldExpandEvent intersected with { currentTarget: PivotGridConfiguratorEditorHandle; }) => void		A callback, fired whenever a FieldEditorField is expanded.
onFormReset	() => void		Resets the form to its initial state. jsx <Button onClick={props.onFormReset}>Reset</Button>
onSubmit	(event: SyntheticEvent<any>) => void		Submits the form when called. Use this with the onClick property of Submit buttons. jsx const handleSubmit = event => console.log("Form submitted"); <Button onClick={props.onSubmit}>Submit</Button>
rowAxesEditor?	CustomComponent<PivotGridAxesEditorProps>		Overrides the default rowAxesEditor component. The default component is: PivotGridAxesEditor.
rowAxesLabel?	CustomComponent<FieldProps intersected with LabelProps>		Overrides the default rowAxesLabel component. The default component is: KendoReactLabel.
submitted	boolean		Shows whether the form has been successfully submitted. Use this to detect if the user is leaving before saving changes. jsx console.log(props.submitted);
touched	boolean		Shows whether the user has interacted with any field. Becomes true when any field loses focus or the user tries to submit. jsx console.log(props.touched);
valid	boolean		Shows whether the form passes all validation rules. Becomes false if any field fails validation. jsx console.log(props.valid);
valueGetter	(name: string) => any		A callback for getting the value of a field without using the Field component (see example). Useful for creating and modifying the UI based on the field values. jsx const value = props.valueGetter("user.name"); console.log(value);
visited	boolean		Shows whether the user has focused on any field. Becomes true when any field receives focus or the user tries to submit. jsx console.log(props.visited);