ChartPanelAxis¶
Definition¶
Extends¶
Extended By¶
None
Description¶
Panel for Chart Axis
Method Summary¶
| Owner | Name | Return Type | Description |
|---|---|---|---|
| ChartPanelAxis | getAxisTitle() | String | Returns the title of the axis. |
| DashboardResource | getCallback(callbackName) | Callback | Returns a callback by name |
| DashboardResource | getCallbacks() | Map | Returns a map of all callback definitions. |
| ChartPanelAxis | getChart() | ChartPanel | Returns the chart panel this axis 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 |
| 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. |
| ChartPanelAxis | getMaxValue() | Double | Returns a Double that is the maximum value of the axis. |
| ChartPanelAxis | getMinValue() | Double | Returns a Double that is the minimum value of the axis. |
| ChartPanelAxis | getOffset() | Integer | Returns the integer offset of the axis. |
| DashboardResource | getOwner() | DashboardResource | Returns the DashboardResource that owns this object. |
| ChartPanelAxis | getPlotPosition() | Integer | Returns the column position if the axis is horizontal, otherwise returns the row position. |
| ChartPanelAxis | getVisibleLength() | Double | Returns a Double that is the visible length of the axis in pixels |
| ChartPanelAxis | getVisibleMaxValue() | Double | Returns a Double that is the maximum visible value of the axis |
| ChartPanelAxis | getVisibleMinValue() | Double | Returns a Double that is the minimum visible value on the axis |
| ChartPanelAxis | getVisibleOffset() | Double | Returns the Double offset of the visible part of the axis in pixels |
| ChartPanelAxis | getZoom() | Double | Returns a Double that is the zoom of the axis |
| DashboardResource | invokeCallback(callbackName, args) | Object | Executes the specified callback definition and returns the result from the callback. |
| ChartPanelAxis | isReverse() | Boolean | Returns true if axis is reversed, false otherwise. |
| DashboardResource | isTransient() | Boolean | Returns true if this is transient, false otherwise. Transient objects are not saved to the layout. |
| ChartPanelAxis | isVertical() | Boolean | Returns true if axis is vertical, false if horizontal. |
| ChartPanelAxis | isZoomed() | Boolean | Returns true is axis has been zoomed, false otherwise. |
| ChartPanelAxis | setAxisTitle(title) | Boolean | Sets the title of the axis to specified value. |
| ChartPanelAxis | setMajorTickUnit(unit) | Boolean | Sets the major tick unit on the axis to a specified value. |
| ChartPanelAxis | setMaxValue(max) | Boolean | Sets the max value of the axis to a specified value. |
| ChartPanelAxis | setMinValue(min) | Boolean | Sets the min value of the axis to a specified value. |
| ChartPanelAxis | setMinorTickUnit(unit) | Boolean | Sets the minor tick unit on the axis to a specified value. |
| ChartPanelAxis | setVisibleOffset(offset) | Boolean | Sets the visible offset the axis to the specified value. |
| ChartPanelAxis | setZoom(zoom) | Boolean | Sets the zoom of the axis to specified value. |
| ChartPanelAxis | setZoomByMinMax(min, max) | Boolean | Sets the zoom and the zoom location by inferring based on min and max value |
| Object | toJson() | String | Returns a json representation of this object. |
Method Definitions¶
getAxisTitle()¶
String ChartPanelAxis::getAxisTitle()
Description¶
Returns the title of the axis.
getChart()¶
ChartPanel ChartPanelAxis::getChart()
Description¶
Returns the chart panel this axis belongs to.
getMaxValue()¶
Double ChartPanelAxis::getMaxValue()
Description¶
Returns a Double that is the maximum value of the axis.
getMinValue()¶
Double ChartPanelAxis::getMinValue()
Description¶
Returns a Double that is the minimum value of the axis.
getOffset()¶
Integer ChartPanelAxis::getOffset()
Description¶
Returns the integer offset of the axis.
getPlotPosition()¶
Integer ChartPanelAxis::getPlotPosition()
Description¶
Returns the column position if the axis is horizontal, otherwise returns the row position.
getVisibleLength()¶
Double ChartPanelAxis::getVisibleLength()
Description¶
Returns a Double that is the visible length of the axis in pixels
getVisibleMaxValue()¶
Double ChartPanelAxis::getVisibleMaxValue()
Description¶
Returns a Double that is the maximum visible value of the axis
getVisibleMinValue()¶
Double ChartPanelAxis::getVisibleMinValue()
Description¶
Returns a Double that is the minimum visible value on the axis
getVisibleOffset()¶
Double ChartPanelAxis::getVisibleOffset()
Description¶
Returns the Double offset of the visible part of the axis in pixels
getZoom()¶
Double ChartPanelAxis::getZoom()
Description¶
Returns a Double that is the zoom of the axis
isReverse()¶
Boolean ChartPanelAxis::isReverse()
Description¶
Returns true if axis is reversed, false otherwise.
isVertical()¶
Boolean ChartPanelAxis::isVertical()
Description¶
Returns true if axis is vertical, false if horizontal.
isZoomed()¶
Boolean ChartPanelAxis::isZoomed()
Description¶
Returns true is axis has been zoomed, false otherwise.
setAxisTitle(title)¶
Boolean ChartPanelAxis::setAxisTitle(String title)
Description¶
Sets the title of the axis to specified value.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| title | String | Axis title, ex: Country |
setMajorTickUnit(unit)¶
Boolean ChartPanelAxis::setMajorTickUnit(Number unit)
Description¶
Sets the major tick unit on the axis to a specified value.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| unit | Number | major tick unit on the axis |
setMaxValue(max)¶
Boolean ChartPanelAxis::setMaxValue(Number max)
Description¶
Sets the max value of the axis to a specified value.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| max | Number | new axis max value |
setMinValue(min)¶
Boolean ChartPanelAxis::setMinValue(Number min)
Description¶
Sets the min value of the axis to a specified value.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| min | Number | new axis min value |
setMinorTickUnit(unit)¶
Boolean ChartPanelAxis::setMinorTickUnit(Number unit)
Description¶
Sets the minor tick unit on the axis to a specified value.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| unit | Number | minor tick unit on the axis |
setVisibleOffset(offset)¶
Boolean ChartPanelAxis::setVisibleOffset(Number offset)
Description¶
Sets the visible offset the axis to the specified value.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| offset | Number | new offset |
setZoom(zoom)¶
Boolean ChartPanelAxis::setZoom(Number zoom)
Description¶
Sets the zoom of the axis to specified value.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| zoom | Number | new zoom |
setZoomByMinMax(min,max)¶
Boolean ChartPanelAxis::setZoomByMinMax(Number min, Number max)
Description¶
Sets the zoom and the zoom location by inferring based on min and max value
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| min | Number | new min value |
| max | Number | new max value |