Skip to main content

DashboardLayoutGroup Class

A layout group used to arrange layout items or other groups within a dashboard.

#Declaration

TypeScript
export class DashboardLayoutGroup extends DashboardLayoutNode

#Remarks

Use the DashboardLayoutGroup.childNodes property to get access to the collection of child layout groups and items that constitute the current layout group. The DashboardLayoutGroup.orientation property specifies the orientation of layout items/groups within the group.

The DashboardLayoutNode.weight property allows you to specify the relative size of the layout group.

#constructor

Initializes a new instance of the DashboardLayoutGroup class.

#Declaration

TypeScript
constructor(
    modelJson?: any,
    serializer?: DevExpress.Analytics.Utils.ModelSerializer
)

#Parameters

Name Type Description
modelJson any

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

serializer ModelSerializer

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

#Properties

#childNodes Property

Provides access to the collection of child layout groups and items.

#Declaration

TypeScript
childNodes: ko.ObservableArray<DevExpress.Dashboard.Model.DashboardLayoutNode>

#Property Value

Type Description
ObservableArray<DashboardLayoutNode>

A collection of the DashboardLayoutNode objects.

#orientation Property

Specifies the value that indicates the orientation of layout items/groups within the group.

#Declaration

TypeScript
orientation: ko.Observable<DevExpress.Dashboard.Model.DashboardLayoutGroupOrientation>

#Property Value

Type Description
Observable<DashboardLayoutGroupOrientation>

The DashboardLayoutGroupOrientation value that indicates the orientation of layout items/groups within the group.

#Methods

#dispose Method

Disposes of all resources associated with this DashboardLayoutGroup.

#Declaration

TypeScript
dispose(): void

#findLayoutItem(dashboardItem) Method

#Declaration

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

#Parameters

Name Type
dashboardItem DashboardItem

#Returns

Type
DashboardLayoutNode

#getItemsRecursive Method

#Declaration

TypeScript
getItemsRecursive(): Array<DevExpress.Dashboard.Model.DashboardLayoutNode>

#Returns

Type
DashboardLayoutNode[]

#getNodesRecursive Method

#Declaration

TypeScript
getNodesRecursive(): Array<DevExpress.Dashboard.Model.DashboardLayoutNode>

#Returns

Type
DashboardLayoutNode[]