All docs
V21.2
21.2
21.1
The page you are viewing does not exist in version 21.1. This link will take you to the root page.
20.2
The page you are viewing does not exist in version 20.2. This link will take you to the root page.
20.1
The page you are viewing does not exist in version 20.1. This link will take you to the root page.
19.2
The page you are viewing does not exist in version 19.2. This link will take you to the root page.
19.1
The page you are viewing does not exist in version 19.1. This link will take you to the root page.
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.

LayoutOptions Class

Contains dashboard layout settings.

Declaration

export class LayoutOptions extends SerializableModel

Remarks

The following code snippet specifies the height and aligns the dashboard’s content horizontally:

Handle the DashboardControlOptions.onDashboardInitializing event and call the custom setLayout function:

function setLayout(e) {
    if (e.dashboard.id == "dashboard2") {
        e.dashboard.layoutOptions.width.mode("Auto");
        e.dashboard.layoutOptions.height.mode("Fixed");
        e.dashboard.layoutOptions.height.value(3000);
    }

constructor

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

Declaration

constructor(
    model?: any,
    serializer?: IModelSerializer,
    info?: ISerializationInfoArray
)

Parameters

Name Type Description
model any

A model of the layout options.

serializer IModelSerializer

An object used for dashboard deserialization. Do not pass this parameter directly.

info ISerializationInfoArray

An array of objects that provide serialization info.

Properties

height Property

Provides access to the dashboard surface‘s height options.

Declaration

height: LayoutDimensionOptions

Property Value

Type Description
LayoutDimensionOptions

A LayoutDimensionOptions object that contains options for dimensions of a dashboard surface.

width Property

Provides access to the dashboard surface‘s width options.

Declaration

width: LayoutDimensionOptions

Property Value

Type Description
LayoutDimensionOptions

A LayoutDimensionOptions object that contains options for dimensions of a dashboard surface.

Methods

getInfo Method

For internal use.

Declaration

getInfo(): ISerializationInfoArray

Returns

Type Description
ISerializationInfoArray

An array of objects that provide serialization info.