ChartPanel¶
Definition¶
Extends¶
Extended By¶
None
Description¶
A visualization Panel of type Chart
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. |
| ChartPanel | getAxis(position, rowOrColumn, offset) | ChartPanelAxis | Returns the axis located in the given position. |
| ChartPanel | getAxisCount(position, rowOrColumn) | Integer | Returns the number of axes in a given position. |
| ChartPanel | getAxises() | List | Returns a list of axes this panel holds. |
| 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. |
| ChartPanel | getColumnsCount() | Integer | Returns the number of columns in this chart. |
| 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. |
| 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. |
| ChartPanel | getPlot(x, y) | ChartPanelPlot | Returns the plot specified by the x and y position. |
| ChartPanel | getPlots() | List | Returns a list of plots this panel holds. |
| ChartPanel | getRowsCount() | Integer | Returns the number of rows in this chart. |
| 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 |
| 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. |
| DashboardResource | invokeCallback(callbackName, args) | Object | Executes the specified callback definition and returns the result from the callback. |
| Panel | isPoppedOut() | Boolean | Returns true if this panel is popped out. |
| 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(). |
| Panel | setDownstreamMode(mode) | String | Sets and returns the mode for sending data downstream to realtime panels. The modes are OFF or SELECTED_OR_ALL. |
| Panel | setTitle(title) | Boolean | Sets the title of the panel with the given value |
| Panel | setValue(key, value) | Boolean | Adds the key value pair to this portlet's attributes and return true if successful. |
| ChartPanel | toImagePng(widthPx, heightPx, printBg) | Binary | Converts this chart into a PNG with an option to print the actual background color (printBg=true) or clear background (printBg=false) |
| ChartPanel | toImagePngForPlot(plotX, plotY, widthPx, heightPx) | Binary | Converts a plot within this chart to an image with a clear white background. |
| ChartPanel | toImagePngForPlotWithBg(plotX, plotY, widthPx, heightPx) | Binary | Converts a plot within this chart to an image with the bacgkround color as configured. |
| Object | toJson() | String | Returns a json representation of this object. |
Method Definitions¶
getAxis(position,rowOrColumn,offset)¶
ChartPanelAxis ChartPanel::getAxis(String position, Integer rowOrColumn, Integer offset)
Description¶
Returns the axis located in the given position.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| position | String | Expected Values: LEFT |
| rowOrColumn | Integer | usually 0, unless there are multiple plots. |
| offset | Integer | Usually 0, unless multiple axes side by side. |
getAxisCount(position,rowOrColumn)¶
Integer ChartPanel::getAxisCount(String position, Integer rowOrColumn)
Description¶
Returns the number of axes in a given position.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| position | String | Expected Values: LEFT |
| rowOrColumn | Integer | Usually 0, unless there are multiple plots. |
getAxises()¶
List ChartPanel::getAxises()
Description¶
Returns a list of axes this panel holds.
getColumnsCount()¶
Integer ChartPanel::getColumnsCount()
Description¶
Returns the number of columns in this chart.
getPlot(x,y)¶
ChartPanelPlot ChartPanel::getPlot(Integer x, Integer y)
Description¶
Returns the plot specified by the x and y position.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| x | Integer | x position |
| y | Integer | y position |
getPlots()¶
List ChartPanel::getPlots()
Description¶
Returns a list of plots this panel holds.
getRowsCount()¶
Integer ChartPanel::getRowsCount()
Description¶
Returns the number of rows in this chart.
toImagePng(widthPx,heightPx,printBg)¶
Binary ChartPanel::toImagePng(Number widthPx, Number heightPx, Boolean printBg)
Description¶
Converts this chart into a PNG with an option to print the actual background color (printBg=true) or clear background (printBg=false)
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| widthPx | Number | width of PNG image in px |
| heightPx | Number | height of PNG image in px |
| printBg | Boolean | whether to print background color as seen or clear |
toImagePngForPlot(plotX,plotY,widthPx,heightPx)¶
Binary ChartPanel::toImagePngForPlot(Integer plotX, Integer plotY, Number widthPx, Number heightPx)
Description¶
Converts a plot within this chart to an image with a clear white background.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| plotX | Integer | x location of plot to get an image for(0=left most) |
| plotY | Integer | y location of plot to get an image for(0=bottom most) |
| widthPx | Number | width in px |
| heightPx | Number | hieght in px |
toImagePngForPlotWithBg(plotX,plotY,widthPx,heightPx)¶
Binary ChartPanel::toImagePngForPlotWithBg(Integer plotX, Integer plotY, Number widthPx, Number heightPx)
Description¶
Converts a plot within this chart to an image with the bacgkround color as configured.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| plotX | Integer | x location of plot to get an image for(0=left most) |
| plotY | Integer | y location of plot to get an image for(0=bottom most) |
| widthPx | Number | width in px |
| heightPx | Number | hieght in px |