The requested page is not available for the requested platform. You are viewing the content for Default platform.

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)

Optional Parameters

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

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

Properties

dashboardItem Property

Declaration

dashboardItem: ko.Observable<string>

Property Value

Type Description
ko.Observable<string>

item Property

Declaration

item: DashboardItem

Property Value

Type Description
DashboardItem

itemType Property

Declaration

itemType: ko.Observable<string>

Property Value

Type Description
ko.Observable<string>

parentNode Property

Declaration

parentNode: ko.Observable<any>

Property Value

Type Description
ko.Observable<any>

weight Property

Specifies the relative size of the layout item/group.

Declaration

weight: ko.Observable<number>

Property Value

Type Description
ko.Observable<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

Name Type 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

Name Type Description
itemToInsert DashboardLayoutNode | DashboardItem
position LayoutItemInsertPosition

moveTo(targetItem, position) Method

Declaration

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

Parameters

Name Type Description
targetItem DashboardLayoutNode
position LayoutItemInsertPosition

remove Method

Declaration

remove(): void