Skip to main content
All docs
V24.2

LayoutOptionEditorExtension Class

A Web Dashboard extension that allows users to change the dashboard layout options.

#Declaration

TypeScript
export class LayoutOptionEditorExtension extends DisposableObject implements IExtension

#Remarks

When registered, the LayoutOptionEditorExtension adds the layout options to the designer toolbar.

To get access to the LayoutOptionEditorExtension settings, call the control’s findExtension(extensionName) method and pass the extension’s name as a parameter.

JavaScript
var ext = dashboardControl.findExtension('layoutOptionEditor');

To remove this item from the menu, call the unregisterExtension(extensionNames) method and pass the extension’s unique name as a parameter:

JavaScript
dashboardControl.unregisterExtension('layoutOptionEditor');

You can also call the control’s option method to change the extension options.

#Implements

IExtension

#Inheritance

DisposableObject
LayoutOptionEditorExtension

#constructor(dashboardControl)

Initializes a new instance of the LayoutOptionEditorExtension class with specified settings.

#Declaration

TypeScript
constructor(
    dashboardControl: DevExpress.Dashboard.DashboardControl
)

#Parameters

Name Type
dashboardControl DashboardControl

#Properties

#name Property

#Declaration

TypeScript
name: string

#Property Value

Type
string

#Methods

#dispose Method

Releases resources associated with a LayoutOptionEditorExtension instance.

#Declaration

TypeScript
dispose(): void

#start Method

#Declaration

TypeScript
start(): void

#stop Method

#Declaration

TypeScript
stop(): void