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¶
getHeight()¶
Integer ChartPanelLegend::getHeight()
Description¶
Gets the height of the legend
getReferencedSeries()¶
Set ChartPanelLegend::getReferencedSeries()
Description¶
Returns the referenced series from the legend
getTitle()¶
String ChartPanelLegend::getTitle()
Description¶
Gets the title of the legend
getWidth()¶
Integer ChartPanelLegend::getWidth()
Description¶
Gets the width of the legend