DashboardLayoutGroup Class

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

Declaration

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.

Inherited Members

dashboardItem

disposed

itemType

parentNode

weight

item

getInfo

insert(itemToInsert, position)

moveTo(targetItem, position)

remove

Inheritance

SerializableModel

TypedSerializableModel

DashboardLayoutNode

DashboardLayoutGroup

DashboardLayoutRootGroup

DashboardLayoutTabPage

DashboardLayoutTabContainer

constructor

Initializes a new instance of the DashboardLayoutGroup class.

Declaration

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

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

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

dispose(): void

findLayoutItem(dashboardItem) Method

Declaration

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

Parameters

Name	Type
dashboardItem	DashboardItem

Returns

Type
DashboardLayoutNode

getItemsRecursive Method

Declaration

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

Returns

Type
DashboardLayoutNode[]

getNodesRecursive Method

Declaration

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

Returns

Type
DashboardLayoutNode[]