SectionOptions Interface

Contains options for a new section in the Dashboard Item Menu and Data Item Menu.

Declaration

export interface SectionOptions

Remarks

Handle the OptionsPanelExtensionOptions.onCustomizeSections or BindingPanelExtensionOptions.onCustomizeDataItemContainerSections events and call the e.addSection method. Pass a SectionOptions object as the addSection method’s parameter. Use the SectionOptions.items property to specify editors for a new section.

The following code adds a new section to the Options menu. Handle the onCustomizeSections event and use the CustomizeSectionsEventArgs.addSection method to add a new section.

var Model = DevExpress.Dashboard.Model;

const axisMaxValueConstantProperty = {
    ownerType: Model.ChartItem,
    propertyName: "AxisMaxValueConstant",
    defaultValue: 100,
    valueType: 'number'
};
Model.registerCustomProperty(axisMaxValueConstantProperty);
// ...
function onCustomizeSections(args) {
    args.addSection({
        title: "Primary Axis Max Value (Custom)",
        items: [
            {
                dataField: axisMaxValueConstantProperty.propertyName,
                editorType: "dxNumberBox",
                label: {
                    text: "Value",
                }
            }
        ]
    })
}

Properties

items Property

Specifies a simple form with DevExtreme widgets that is placed in a new section.

Declaration

items: Array<dxFormSimpleItem>

Property Value

Type	Description
Array<dxFormSimpleItem>	A SimpleItem object that is a simple form with widgets.

onContentReady Property

Declaration

onContentReady?: (e: {
    component?: dxForm;
    element?: dxElement;
}) => void

Property Value

Type
(e: {component: dxForm, element: dxElement}) => void

onFieldDataChanged Property

Declaration

onFieldDataChanged?: (e: {
    component?: dxForm;
    element?: dxElement;
    model?: any;
    dataField?: string;
    value?: any;
}) => any

Property Value

Type
(e: {component: dxForm, dataField: string, element: dxElement, model: any, value: any}) => any

onInitialized Property

Declaration

onInitialized?: (e: {
    component?: dxForm;
    element?: dxElement;
}) => void

Property Value

Type
(e: {component: dxForm, element: dxElement}) => void

title Property

Specifies a new section’s title.

Declaration

title: string

Property Value

Type	Description
string	A string that is a section name.