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

item

itemType

parentNode

weight

getInfo

insert(itemToInsert, position)

moveTo(targetItem, position)

remove

Inheritance

DashboardLayoutGroup

DashboardLayoutRootGroup

DashboardLayoutTabPage

DashboardLayoutTabContainer

constructor

Initializes a new instance of the DashboardLayoutGroup class.

Declaration

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

Parameters

Name	Type	Description
modelJson	any	A JSON object used for a dashboard deserialization. Do not pass this parameter directly.
serializer	DxDesigner.Analytics.Utils.ModelSerializer	An object used for a 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<DashboardLayoutNode>

Property Value

Type	Description
ObservableArray<DashboardLayoutNode>	A collection of DashboardLayoutNode descendants representing child layout groups and items.

orientation Property

Declaration

orientation: ko.Observable<DashboardLayoutGroupOrientation>

Property Value

Type
Observable<DashboardLayoutGroupOrientation>

Methods

findLayoutItem(dashboardItem) Method

Declaration

findLayoutItem(
    dashboardItem: DashboardItem
): DashboardLayoutNode

Parameters

Name	Type
dashboardItem	DashboardItem

Returns

Type
DashboardLayoutNode

getItemsRecursive Method

Declaration

getItemsRecursive(): Array<DashboardLayoutNode>

Returns

Type
Array<DashboardLayoutNode>

getNodesRecursive Method

Declaration

getNodesRecursive(): Array<DashboardLayoutNode>

Returns

Type
Array<DashboardLayoutNode>