ChartPanelLegend¶
Definition¶
Extends¶
Extended By¶
None
Description¶
Panel for Chart Legend
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. |
| ChartPanelLayer | getChart() | ChartPanel | Returns the chart panel this layer belongs to. |
| 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 |
| ChartPanelLayer | getDatamodel() | Datamodel | Returns the underlying datamodel used by the layer. |
| ChartPanelLayer | getFormula(fieldname) | String | Returns the formula for the given field. |
| 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. |
| ChartPanelLegend | getHeight() | Integer | Gets the height of the legend |
| 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. |
| ChartPanelLayer | getPlot() | ChartPanelPlot | Returns the plot this layer belongs to. |
| ChartPanelLegend | getReferencedSeries() | Set | Returns the referenced series from the legend |
| ChartPanelLayer | getSelected() | Table | get the rows from underlying data that are represented by selected items in this layer |
| ChartPanelLayer | getStyle(styleKey, index) | String | Returns the value associated with the supplied style key in this panel's style as a string. Returns Null if key not found. |
| ChartPanelLayer | getStyle(styleKey) | String | Returns the value for a particular style given the style code, which can be obtained by clicking on the style name. Returns Null if key not found. |
| ChartPanelLegend | getTitle() | String | Gets the title of the legend |
| ChartPanelLegend | getWidth() | Integer | Gets the width of the legend |
| ChartPanelLayer | getXAxis() | ChartPanelAxis | Returns the x-axis of the layer. |
| ChartPanelLayer | getYAxis() | ChartPanelAxis | Returns the y-axis of the layer. |
| ChartPanelLayer | getZPosition() | Integer | Returns the z-position of the layer. |
| 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. |
| ChartPanelLayer | resetFormulas() | Boolean | Resets the formulas to the default (as set in the heatmap's Setting panel). |
| ChartPanelLayer | setFormula(fieldname, value) | String | Sets the formula for the given field. For field name, use xLbl for X Groupings, yLbl for Y Groupings, name for Group By, and where for Where clause. |
| 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.
getChart()¶
ChartPanel ChartPanelLayer::getChart()
Description¶
Returns the chart panel this layer belongs to.
getChildren()¶
List DashboardResource::getChildren()
Description¶
Returns a list of the child dashboard resources.
getClassName()¶
Description¶
Returns the string name of this object's class type.
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
getDatamodel()¶
Datamodel ChartPanelLayer::getDatamodel()
Description¶
Returns the underlying datamodel used by the layer.
getFormula(fieldname)¶
String ChartPanelLayer::getFormula(String fieldname)
Description¶
Returns the formula for the given field.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| fieldname | String | Field Name in the layer |
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.
getHeight()¶
Integer ChartPanelLegend::getHeight()
Description¶
Gets the height of the legend
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.
getPlot()¶
ChartPanelPlot ChartPanelLayer::getPlot()
Description¶
Returns the plot this layer belongs to.
getReferencedSeries()¶
Set ChartPanelLegend::getReferencedSeries()
Description¶
Returns the referenced series from the legend
getSelected()¶
Table ChartPanelLayer::getSelected()
Description¶
get the rows from underlying data that are represented by selected items in this layer
getStyle(styleKey,index)¶
String ChartPanelLayer::getStyle(String styleKey, Number index)
Description¶
Returns the value associated with the supplied style key in this panel's style as a string. Returns Null if key not found.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| styleKey | String | the key associated with this portlets style |
| index | Number | If the style is a list, which element in the list to return |
getStyle(styleKey)¶
String ChartPanelLayer::getStyle(String styleKey)
Description¶
Returns the value for a particular style given the style code, which can be obtained by clicking on the style name. Returns Null if key not found.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| styleKey | String | the key associated with this portlet's style |
getTitle()¶
String ChartPanelLegend::getTitle()
Description¶
Gets the title of the legend
getWidth()¶
Integer ChartPanelLegend::getWidth()
Description¶
Gets the width of the legend
getXAxis()¶
ChartPanelAxis ChartPanelLayer::getXAxis()
Description¶
Returns the x-axis of the layer.
getYAxis()¶
ChartPanelAxis ChartPanelLayer::getYAxis()
Description¶
Returns the y-axis of the layer.
getZPosition()¶
Integer ChartPanelLayer::getZPosition()
Description¶
Returns the z-position of the layer.
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.
resetFormulas()¶
Boolean ChartPanelLayer::resetFormulas()
Description¶
Resets the formulas to the default (as set in the heatmap's Setting panel).
setFormula(fieldname,value)¶
String ChartPanelLayer::setFormula(String fieldname, String value)
Description¶
Sets the formula for the given field. For field name, use xLbl for X Groupings, yLbl for Y Groupings, name for Group By, and where for Where clause.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| fieldname | String | Field Name in the layer. See description for a list of fields. |
| value | String |
toJson()¶
Description¶
Returns a json representation of this object.