Reference > AmiScript API > Classes

TreePanelColumnGrouping¶

Definition¶

1	`TreePanelColumnGrouping var = .... ;`

Extends¶

Extended By¶

None

Description¶

Represents a grouping of columns within a TreePanel. Accessible via treePanel.getColumnGroupings().

Method Summary¶

Owner	Name	Return Type	Description
TreePanelColumnGrouping	collapse()	TreePanelColumnGrouping	Collapses this column grouping (hides its expanded columns, shows its collapsed column). No-op if the grouping is not collapsible. Returns this grouping.
DashboardResource	commit()	Object	Commits transient changes, promoting overrides to persisted values. If transient, makes permanent.
TreePanelColumnGrouping	expand()	TreePanelColumnGrouping	Expands this column grouping (shows its expanded columns, hides its collapsed column). No-op if the grouping is not collapsible. Returns this grouping.
DashboardResource	getCallback(callbackName)	Callback	Returns a callback by name
DashboardResource	getCallbackNames()	List	Returns the callback names defined for this dashboard resource. Use session.getDevTools().getCallbackEditor(resource, callbackName) to edit one, and call editor.open() when you want to show the UI.
DashboardResource	getCallbacks()	Map	Returns a map of all callback definitions.
DashboardResource	getChildren()	List	Returns a list of the child dashboard resources.
TreePanelColumnGrouping	getChildrenOnClosed()	TreePanelColumn	Returns the TreePanelColumn shown when the grouping is collapsed.
TreePanelColumnGrouping	getChildrenOnOpen()	List	Returns the list of TreePanelColumn objects shown when the grouping is expanded.
Object	getClassName()	String	Returns the string name of this object's class type.
DashboardResource	getDRI()	String	Returns the Dashboard Resource Indicator (DRI) as a string. DRI is the unique identifier of an object within the entire dashboard.
DashboardResource	getDashboardResourceType()	String	Returns the Dashboard Resource Type as a string
DashboardResource	getFormula(formulaName)	Formula	Returns a Formula given the formula name.
DashboardResource	getFormulaNames()	Set	Returns a set of the names of all formulas for this object.
DashboardResource	getFormulas()	Map	Returns a map of all available formulas for this object. The key is the formula name.
TreePanelColumnGrouping	getId()	String	Returns the column grouping id.
DashboardResource	getLRI()	String	Returns the Localized Resource Indicator (LRI) as a string. LRI is the unique identifier of this resource with the parent element.
TreePanelColumnGrouping	getOwner()	TreePanel	Returns the TreePanel that owns this object.
TreePanelColumnGrouping	getTitle()	String	Returns the column grouping title.
DashboardResource	invokeCallback(callbackName, args)	Object	Executes the specified callback definition and returns the result from the callback.
DashboardResource	isTransient()	Boolean	Returns true if this is transient, false otherwise. Transient objects are not saved to the layout.
Object	toJson()	String	Returns a string of a json representation of this object.

Method Definitions¶

collapse()¶

TreePanelColumnGrouping TreePanelColumnGrouping::collapse()

Description¶

Collapses this column grouping (hides its expanded columns, shows its collapsed column). No-op if the grouping is not collapsible. Returns this grouping.

commit()¶

Object DashboardResource::commit()

Description¶

Commits transient changes, promoting overrides to persisted values. If transient, makes permanent.

expand()¶

TreePanelColumnGrouping TreePanelColumnGrouping::expand()

Description¶

Expands this column grouping (shows its expanded columns, hides its collapsed column). No-op if the grouping is not collapsible. Returns this grouping.

getCallback(callbackName)¶

Callback DashboardResource::getCallback(String callbackName)

Description¶

Returns a callback by name

Parameter Definition¶

Name	Type	Description
callbackName	String	method name of callback

getCallbackNames()¶

List DashboardResource::getCallbackNames()

Description¶

Returns the callback names defined for this dashboard resource. Use session.getDevTools().getCallbackEditor(resource, callbackName) to edit one, and call editor.open() when you want to show the UI.