DashboardLayoutNode Class

Serves as the base class for layout items and groups.

Declaration

export abstract class DashboardLayoutNode extends TypedSerializableModel implements ILayoutItemViewModelProvider

Inheritance

DashboardLayoutNode

DashboardLayoutGroup

DashboardLayoutItem

constructor

Initializes a new instance of the DashboardLayoutNode class.

Declaration

constructor(
    dashboardLayoutItemJSON?: any,
    serializer?: ModelSerializer
)

Parameters

Name	Type	Description
dashboardLayoutItemJSON	any
serializer	ModelSerializer	An object used for dashboard deserialization. Do not pass this parameter directly.

Properties

dashboardItem Property

Gets the dashboard item/group which is displayed in the current layout item/group.

Declaration

dashboardItem: ko.Observable<string>

Property Value

Type
Observable<string>

item Property

Declaration

item: DashboardItem

Property Value

Type
DashboardItem

itemType Property

Declaration

itemType: ko.Observable<string>

Property Value

Type
Observable<string>

parentNode Property

Gets the immediate parent layout group to which the current layout item/group belongs.

Declaration

parentNode: ko.Observable<any>

Property Value

Type
Observable<any>

weight Property

Specifies the relative size of the layout item/group.

Declaration

weight: ko.Observable<number>

Property Value

Type
Observable<number>

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
dashboardItem	DashboardItem

Returns

Type
DashboardLayoutNode

getInfo Method

For internal use.

Declaration

getInfo(): ISerializationInfoArray

Returns

Type
ISerializationInfoArray

insert(itemToInsert, position) Method

Inserts the layout item according to the specified position.

Declaration

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

Parameters

Name	Type	Description
itemToInsert	DashboardLayoutNode | DashboardItem	A dashboard item whose layout item will be inserted to the left of the current layout item/group.
position	LayoutItemInsertPosition	The position where the layout item is inserted.

moveTo(targetItem, position) Method

Moves the current layout item/group according to the specified layout item/group.

Declaration

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

Parameters

Name	Type	Description
targetItem	DashboardLayoutNode	The layout item/group according to which the current layout item/group will be placed.
position	LayoutItemInsertPosition	A new position.

remove Method

Declaration

remove(): void