DashboardResource¶
Definition¶
Extends¶
Extended By¶
- BloombergPipeProcessor
- SurfacePanel
- FormTimeRangeField
- ScrollPanel
- FormTextField
- FilterPanel
- Processor
- ChartPanelAxis
- TabsPanel
- FormPanel
- FormField
- SurfacePanelLayer
- FormRelationshipButton
- FormTextareaField
- MenuItem
- FormDivField
- FormSelectField
- Session
- FormUploadField
- Tab
- DividerPanel
- TablePanel
- FormDateRangeField
- FormDateTimeField
- FormDateField
- HeatmapPanel
- TreePanelGrouping
- FormPasswordField
- FormImageField
- Panel
- ChartPanelPlot
- FormRangeSliderField
- FormColorPickerField
- FormMultiSelectField
- Layout
- FormCheckboxField
- FormMultiCheckboxField
- ChartPanelLegend
- ChartPanelLayer
- TablePanelColumn
- SurfacePanelAxis
- ChartPanel
- FormGradientColorPickerField
- Relationship
- FormRadioField
- Datamodel
- TreePanel
- FormSliderField
- TreePanelColumn
- FormButtonField
- FormTimeField
Description¶
Represents all dashboard resources within the AMI dashboard, these include panels, menus, datamodels, relationships, layouts, etc
Method Summary¶
| Owner | Name | Return Type | Description |
|---|---|---|---|
| DashboardResource | getCallback(callbackName) | Callback | Returns a callback by name |
| DashboardResource | getCallbacks() | Map | Returns a map of all callback definitions. |
| DashboardResource | getChildren() | List | Returns a list of the child dashboard resources. |
| 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 this resources 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. |
| DashboardResource | getLRI() | String | Returns the Localized Resource Indicator (LRI) as a string. LRI is the unique identifier of this resource with the parent element. |
| DashboardResource | getOwner() | DashboardResource | Returns the DashboardResource that owns this object. |
| 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 json representation of this object. |
Method Definitions¶
getCallback(callbackName)¶
Callback DashboardResource::getCallback(String callbackName)
Description¶
Returns a callback by name
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| callbackName | String | method name of callback |
getCallbacks()¶
Map DashboardResource::getCallbacks()
Description¶
Returns a map of all callback definitions.
getChildren()¶
List DashboardResource::getChildren()
Description¶
Returns a list of the child dashboard resources.
getDRI()¶
String DashboardResource::getDRI()
Description¶
Returns the Dashboard Resource Indicator (DRI) as a string. DRI is the unique identifier of this resources within the entire dashboard.
getDashboardResourceType()¶
String DashboardResource::getDashboardResourceType()
Description¶
Returns the Dashboard Resource Type as a string
getFormula(formulaName)¶
Formula DashboardResource::getFormula(String formulaName)
Description¶
Returns a Formula given the formula name.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| formulaName | String | name of the formula to return |
getFormulaNames()¶
Set DashboardResource::getFormulaNames()
Description¶
Returns a set of the names of all formulas for this object.
getFormulas()¶
Map DashboardResource::getFormulas()
Description¶
Returns a map of all available formulas for this object. The key is the formula name.
getLRI()¶
String DashboardResource::getLRI()
Description¶
Returns the Localized Resource Indicator (LRI) as a string. LRI is the unique identifier of this resource with the parent element.
getOwner()¶
DashboardResource DashboardResource::getOwner()
Description¶
Returns the DashboardResource that owns this object.
invokeCallback(callbackName,args)¶
Object DashboardResource::invokeCallback(String callbackName, Object ... args)
Description¶
Executes the specified callback definition and returns the result from the callback.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| callbackName | String | method name of callback |
| args | Object ... | arguments |
isTransient()¶
Boolean DashboardResource::isTransient()
Description¶
Returns true if this is transient, false otherwise. Transient objects are not saved to the layout.