All docs
V18.2
19.1 (preview)
18.2
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.

DashboardLayoutNode Class

Serves as the base class for layout items and groups.

Declaration

export abstract class DashboardLayoutNode extends TypedSerializableModel implements ILayoutItemViewModelProvider

constructor

Initializes a new instance of the DashboardLayoutNode class.

Declaration

constructor(dashboardLayoutItemJSON?: any, serializer?: DxDesigner.Analytics.Utils.ModelSerializer)

Parameters

Type Name Description
any dashboardLayoutItemJSON
DxDesigner.Analytics.Utils.ModelSerializer serializer

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

Properties

dashboardItem Property

Declaration

dashboardItem: KnockoutObservable<string>

Property Value

Type Description
KnockoutObservable<string>

item Property

Declaration

item: DashboardItem

Property Value

Type Description
DashboardItem

itemType Property

Declaration

itemType: KnockoutObservable<string>

Property Value

Type Description
KnockoutObservable<string>

parentNode Property

Declaration

parentNode: KnockoutObservable<any>

Property Value

Type Description
KnockoutObservable<any>

weight Property

Specifies the relative size of the layout item/group.

Declaration

weight: KnockoutObservable<number>

Property Value

Type Description
KnockoutObservable<number>

A number that specifies the relative size of the layout item/group.

Remarks

The weight property specifies the size of the layout item/group relative to the total weight of the parent's layout items/groups.

Methods

findLayoutItem(dashboardItem) Method

Declaration

findLayoutItem(dashboardItem: DashboardItem): DashboardLayoutNode

Parameters

Type Name Description
DashboardItem dashboardItem

Returns

Type Description
DashboardLayoutNode

getInfo Method

For internal use.

Declaration

getInfo(): DxDesigner.Analytics.Utils.ISerializationInfo[]

Returns

Type Description
DxDesigner.Analytics.Utils.ISerializationInfo[]

insert(itemToInsert, position) Method

Declaration

insert(itemToInsert: DashboardLayoutNode | DashboardItem, position: LayoutItemInsertPosition): void

Parameters

Type Name Description
DashboardLayoutNode | DashboardItem itemToInsert
LayoutItemInsertPosition position

moveTo(targetItem, position) Method

Declaration

moveTo(targetItem: DashboardLayoutNode, position: LayoutItemInsertPosition): void

Parameters

Type Name Description
DashboardLayoutNode targetItem
LayoutItemInsertPosition position

remove Method

Declaration

remove(): void