Skip to main content

DashboardLayoutNode Class

Serves as the base class for layout items and groups.

#Declaration

TypeScript
export abstract class DashboardLayoutNode extends TypedSerializableModel implements ILayoutItemViewModelProvider

#Implements

ILayoutItemViewModelProvider

#Inherited Members

#constructor

Initializes a new instance of the DashboardLayoutNode class.

#Declaration

TypeScript
constructor(
    dashboardLayoutItemJSON?: any,
    serializer?: DevExpress.Analytics.Utils.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

TypeScript
dashboardItem: ko.Observable<string>

#Property Value

Type Description
Observable<string>

A component name of the dashboard item.

#item Property

#Declaration

TypeScript
get item(): DevExpress.Dashboard.Model.DashboardItem
set item(newItem: DevExpress.Dashboard.Model.DashboardItem)

#Property Value

Type
DashboardItem

#itemType Property

#Declaration

TypeScript
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

TypeScript
parentNode: ko.Observable<any>

#Property Value

Type Description
Observable<any>

A DashboardLayoutGroup that is the immediate parent layout group to which the current layout item/group belongs.

#weight Property

Specifies the relative size of the layout item/group.

#Declaration

TypeScript
weight: ko.Observable<number>

#Property Value

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

#dispose Method

Disposes of all resources associated with this DashboardLayoutNode.

#Declaration

TypeScript
dispose(): void

#findLayoutItem(dashboardItem) Method

#Declaration

TypeScript
findLayoutItem(
    dashboardItem: DevExpress.Dashboard.Model.DashboardItem
): DashboardLayoutNode

#Parameters

Name Type
dashboardItem DashboardItem

#Returns

Type
DashboardLayoutNode

#getInfo Method

For internal use.

#Declaration

TypeScript
getInfo(): DevExpress.Analytics.Utils.ISerializationInfoArray

#Returns

Type
ISerializationInfoArray

#insert(itemToInsert, position) Method

Inserts the layout item according to the specified position.

#Declaration

TypeScript
insert(
    itemToInsert: DashboardLayoutNode | DevExpress.Dashboard.Model.DashboardItem,
    position: LayoutItemInsertPosition
): void

#Parameters

Name Type Description
itemToInsert DashboardItem | DashboardLayoutNode

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

TypeScript
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

TypeScript
remove(): void