HeatmapPanel¶
Definition¶
Extends¶
Extended By¶
None
Description¶
Panel for Heatmap
Method Summary¶
| Owner | Name | Return Type | Description |
|---|---|---|---|
| Panel | addPanelNextToMe(position, configuration) | DividerPanel | Adds a new panel adjacent to this panel by creating a divider portlet. The divider portlet is returned. |
| Panel | bringToFront() | Object | Makes this panel visible and bring its containing window to the front. |
| Panel | callCommand(applicationId, cmdId, arguments) | String | Calls the given command. Returns commandUid (String) on success, otherwise null. |
| Panel | callCommand(applicationId, cmdId, arguments) | String | Calls the given command. Returns the commandUid (String) for this command call or null on failure. |
| Panel | callRelationship(relationshipName) | Boolean | Reruns the relationship targeting this panel based on name. Returns true on success. |
| Panel | callRelationshipId(relationshipId) | Boolean | Reruns the relationship targeting this panel based on id. Returns true on success. |
| Panel | clearUserSelection() | Object | Clears the user's selection. |
| Panel | close() | Object | Removes this transient panel. Note this will throw an error if the target panel is not transient. |
| Panel | deletePanel() | Object | Removes this transient panel. Note this will throw an error if the target panel is not transient |
| Panel | exportConfig() | Map | Exports this panel's configuration to a map. |
| Panel | exportConfig(includeRelationships, includeDatamodels) | Map | Exports this panel's configuration to a map, with the options to include external relationships and external datamodels. |
| Panel | exportConfigIncludeExternalRelationships() | Map | Exports this panels configuration with external relationships |
| Panel | exportUserPreferences() | Map | Exports this panel's user preferences to a map. |
| 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. |
| Panel | getCurrentRelationship() | Relationship | Returns the Relationship object currently applied to this panel. |
| 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 |
| Panel | getDatamodels() | Object | Returns a set of datamodels that were used in this panel. |
| Panel | getDownstreamMode() | String | Returns status of send data downstream to realtime panels. The statuses are OFF or SELECTED_OR_ALL. |
| 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. |
| HeatmapPanel | getGroupByFormula() | String | Returns the formula used in the Group By Field. |
| HeatmapPanel | getHeatFormula() | String | Returns the formula used in the Heat field. |
| Panel | getId() | String | Returns this panel's ID (as defined in settings). |
| DashboardResource | getLRI() | String | Returns the Localized Resource Indicator (LRI) as a string. LRI is the unique identifier of this resource with the parent element. |
| Panel | getLayout() | Layout | Returns layout that owns this panel. |
| Panel | getLocation() | Rectangle | Returns a Rectangle object that stores the location of this panel relative to the upper left corner of the browser, not including the 3Forge header. |
| Panel | getMenu() | MenuItem | Returns this panel's root custom context menu. |
| DashboardResource | getOwner() | DashboardResource | Returns the DashboardResource that owns this object. |
| Panel | getParent() | Panel | Returns the parent panel of this panel. |
| HeatmapPanel | getRatio() | Double | Returns the ratio |
| HeatmapPanel | getSelectedRow() | Table | Returns the selected rows of this heatmap. Columns are TopGrouping, SubGrouping, Heat and Size. |
| HeatmapPanel | getSelectedUnderlyingRows() | Table | Returns the underlying rows of the selected nodes. |
| HeatmapPanel | getSizeFormula() | String | Returns the formula used in the Size field. |
| HeatmapPanel | getStickyness() | Integer | Returns the stickyness |
| Panel | 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. |
| Panel | getStyle(styleKey, index) | String | Returns the value for a particular style given the style code at the specified position. The style code can be obtained by clicking on the style name. Returns Null if key not found, returns the first value in the list if position is out of bound. |
| Panel | getStyleNumber(styleKey) | Number | Returns the numeric value associated with the supplied style key in this portlets style. Null if key not found, or value is not a number. Ex: using this method for text align will return null as its values are not numeric. |
| Panel | getStyleSet() | StyleSet | Returns the StyleSet for this panel. |
| Panel | getTitle() | String | Returns this panel's title |
| HeatmapPanel | getTooltipFormula() | String | Returns the formula used in the Tooltip field. |
| HeatmapPanel | getTopLevelGroupingFormula() | String | Returns the formula used in the Top Level Grouping field. |
| Panel | getType() | String | Returns the type of this panel, either: html, div_v, div_h, tabs, or one of the AMI visualization types. |
| Panel | getUid() | String | Returns this panel's ami-generated ID. |
| Panel | getValue(key) | Object | Returns the value associated with key from this portlet's attributes. Returns null if key does not exist. |
| Panel | getWindow() | Window | Returns the window that owns this panel. |
| HeatmapPanel | highlightNode(list of paths, color) | Boolean | Highlights or resets the border of a specific node given a list of grouping path and a hex color. Returns true if border color is changed as a result, false if grouping path is invalid or color is the same as before. This will not override the selected node border color and will NOT be saved in the layout. Pass in null for color to reset border color to default. |
| DashboardResource | invokeCallback(callbackName, args) | Object | Executes the specified callback definition and returns the result from the callback. |
| HeatmapPanel | isHighlighted(list of paths) | Boolean | Returns true if a node is highlighted, false if path is invalid or node is not highlighted. |
| Panel | isPoppedOut() | Boolean | Returns true if this panel is popped out. |
| HeatmapPanel | isSelected(list of paths) | Boolean | Returns true if a node is selected, false if path is invalid or node is not selected. |
| DashboardResource | isTransient() | Boolean | Returns true if this is transient, false otherwise. Transient objects are not saved to the layout. |
| Panel | isUndocked() | Boolean | Returns true if this panel is undocked. |
| Panel | isVisible() | Boolean | Returns true if this panel is visible. |
| Panel | minimize() | Object | Minimizes the window, same as calling getWindow().minimize(). |
| HeatmapPanel | selectNode(list of path, shouldSelect) | Boolean | Selects the specific node given a list of grouping path. Returns true if selection has been changed as a result, false if grouping path is valid or selection did not change. |
| Panel | setDownstreamMode(mode) | String | Sets and returns the mode for sending data downstream to realtime panels. The modes are OFF or SELECTED_OR_ALL. |
| HeatmapPanel | setGroupByFormula(formula) | Boolean | Sets the formula used in the Group By field. Returns true on success. |
| HeatmapPanel | setHeatFormula(formula) | Boolean | Sets the formula used in heat field. Returns true upon success |
| HeatmapPanel | setRatio(ratio) | Boolean | Sets the ratio of the heatmap with the given ratio. |
| HeatmapPanel | setSizeFormula(formula) | Boolean | Sets the formula used in the Size field. Returns true on success. |
| HeatmapPanel | setStickyness(stickyness) | Boolean | Sets the stickyness of the heatmap with the given stickyness. |
| Panel | setTitle(title) | Boolean | Sets the title of the panel with the given value |
| HeatmapPanel | setTooltipFormula(formula) | Boolean | Sets the formula used in the Tooltip field. Returns true on success. |
| HeatmapPanel | setTopLevelGroupingFormula(formula) | Boolean | Sets the formula used in the Top Level Grouping field. Returns true on success. |
| Panel | setValue(key, value) | Boolean | Adds the key value pair to this portlet's attributes and return true if successful. |
| Object | toJson() | String | Returns a json representation of this object. |
| HeatmapPanel | toPng(widthPx, heightPx) | Binary | Converts a Heatmap panel to PNG |
Method Definitions¶
getGroupByFormula()¶
String HeatmapPanel::getGroupByFormula()
Description¶
Returns the formula used in the Group By Field.
getHeatFormula()¶
String HeatmapPanel::getHeatFormula()
Description¶
Returns the formula used in the Heat field.
getRatio()¶
Double HeatmapPanel::getRatio()
Description¶
Returns the ratio
getSelectedRow()¶
Table HeatmapPanel::getSelectedRow()
Description¶
Returns the selected rows of this heatmap. Columns are TopGrouping, SubGrouping, Heat and Size.
getSelectedUnderlyingRows()¶
Table HeatmapPanel::getSelectedUnderlyingRows()
Description¶
Returns the underlying rows of the selected nodes.
getSizeFormula()¶
String HeatmapPanel::getSizeFormula()
Description¶
Returns the formula used in the Size field.
getStickyness()¶
Integer HeatmapPanel::getStickyness()
Description¶
Returns the stickyness
getTooltipFormula()¶
String HeatmapPanel::getTooltipFormula()
Description¶
Returns the formula used in the Tooltip field.
getTopLevelGroupingFormula()¶
String HeatmapPanel::getTopLevelGroupingFormula()
Description¶
Returns the formula used in the Top Level Grouping field.
highlightNode(list of paths,color)¶
Boolean HeatmapPanel::highlightNode(List list of paths, String color)
Description¶
Highlights or resets the border of a specific node given a list of grouping path and a hex color. Returns true if border color is changed as a result, false if grouping path is invalid or color is the same as before. This will not override the selected node border color and will NOT be saved in the layout. Pass in null for color to reset border color to default.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| list of paths | List | The list of grouping paths that lead to the node, starts from the top level grouping. For example, if your heatmap is grouped by Continent, then Country, then City, to change the border color of a node named Paris, pass in a list of string where the first element is Europe, second is France, last is Paris. Note that if top level grouping is not set in the heatmap formula, then user should use the default top level grouping name set by AMI, which is "1.0" |
| color | String | A valid hex color, e.g. #ff0000, or null to reset to default |
isHighlighted(list of paths)¶
Boolean HeatmapPanel::isHighlighted(List list of paths)
Description¶
Returns true if a node is highlighted, false if path is invalid or node is not highlighted.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| list of paths | List | The list of paths that lead to the node, starts from the top level grouping. For example, if your heatmap is grouped by Continent, then Country, then City, to check the status of a node named Paris, pass in a list of string where the first element is Europe, second is France, last is Paris. |
isSelected(list of paths)¶
Boolean HeatmapPanel::isSelected(List list of paths)
Description¶
Returns true if a node is selected, false if path is invalid or node is not selected.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| list of paths | List | The list of paths that lead to the node, starts from the top level grouping. For example, if your heatmap is grouped by Continent, then Country, then City, to check the status of a node named Paris, pass in a list of string where the first element is Europe, second is France, last is Paris. |
selectNode(list of path,shouldSelect)¶
Boolean HeatmapPanel::selectNode(List list of path, Boolean shouldSelect)
Description¶
Selects the specific node given a list of grouping path. Returns true if selection has been changed as a result, false if grouping path is valid or selection did not change.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| list of path | List | The list of paths that lead to the node, starts from the top level grouping. For example, if your heatmap is grouped by Continent, then Country, then City, to select a node named Paris, pass in a list of string where the first element is Europe, second is France, last is Paris. |
| shouldSelect | Boolean | If true, selects, otherwise deselects. Note that onSelected callback will fire only if selection status changed as a result. |
setGroupByFormula(formula)¶
Boolean HeatmapPanel::setGroupByFormula(String formula)
Description¶
Sets the formula used in the Group By field. Returns true on success.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| formula | String | formula, ex: Region |
setHeatFormula(formula)¶
Boolean HeatmapPanel::setHeatFormula(String formula)
Description¶
Sets the formula used in heat field. Returns true upon success
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| formula | String | formula, ex: sum(quantity) |
setRatio(ratio)¶
Boolean HeatmapPanel::setRatio(Double ratio)
Description¶
Sets the ratio of the heatmap with the given ratio.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| ratio | Double |
setSizeFormula(formula)¶
Boolean HeatmapPanel::setSizeFormula(String formula)
Description¶
Sets the formula used in the Size field. Returns true on success.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| formula | String | formula, ex: sum(quantity) |
setStickyness(stickyness)¶
Boolean HeatmapPanel::setStickyness(Integer stickyness)
Description¶
Sets the stickyness of the heatmap with the given stickyness.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| stickyness | Integer |
setTooltipFormula(formula)¶
Boolean HeatmapPanel::setTooltipFormula(String formula)
Description¶
Sets the formula used in the Tooltip field. Returns true on success.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| formula | String | formula, ex: sum(quantity) |
setTopLevelGroupingFormula(formula)¶
Boolean HeatmapPanel::setTopLevelGroupingFormula(String formula)
Description¶
Sets the formula used in the Top Level Grouping field. Returns true on success.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| formula | String | formula, ex: Region |
toPng(widthPx,heightPx)¶
Binary HeatmapPanel::toPng(Number widthPx, Number heightPx)
Description¶
Converts a Heatmap panel to PNG
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| widthPx | Number | width of PNG image in px |
| heightPx | Number | height of PNG image in px |