sap.makit.Chart.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.makit.Chart with name
sClassName
and enriches it with the information contained in
oClassInfo
.
oClassInfo
might contain the same kind of informations as described in Element.extend.
Parameters:
{string} | sClassName | name of the class to be created |
{object} | oClassInfo? | object literal with informations about the class |
{function} | FNMetaImpl? | constructor function for the metadata object. If not given, it defaults to sap.ui.core.ElementMetadata. |
Returns:
{function} | the created class / constructor function |
Returns a metadata object for class sap.makit.Chart.
Returns:
Attach event handler
fnFunction
to the 'doubletap' event of this
sap.makit.Chart
.
. When called, the context of the event handler (its
this
) will be bound to
oListener if specified otherwise to this sap.makit.Chart
.
itself. Double tap event on the chart
Parameters:
{object} | oData? | An application specific payload object, that will be passed to the event handler along with the event object when firing the event. |
{function} | fnFunction | The function to call, when the event occurs. |
{object} | oListener? | Context object to call the event handler with. Defaults to this sap.makit.Chart . itself. |
Returns:
Attach event handler
fnFunction
to the 'longpress' event of this
sap.makit.Chart
.
. When called, the context of the event handler (its
this
) will be bound to
oListener if specified otherwise to this sap.makit.Chart
.
itself. Long press event on the chart
Parameters:
{object} | oData? | An application specific payload object, that will be passed to the event handler along with the event object when firing the event. |
{function} | fnFunction | The function to call, when the event occurs. |
{object} | oListener? | Context object to call the event handler with. Defaults to this sap.makit.Chart . itself. |
Returns:
Attach event handler
fnFunction
to the 'tap' event of this
sap.makit.Chart
.
. When called, the context of the event handler (its
this
) will be bound to
oListener if specified otherwise to this sap.makit.Chart
.
itself. Single tap event on the chart
Parameters:
{object} | oData? | An application specific payload object, that will be passed to the event handler along with the event object when firing the event. |
{function} | fnFunction | The function to call, when the event occurs. |
{object} | oListener? | Context object to call the event handler with. Defaults to this sap.makit.Chart . itself. |
Returns:
Detach event handler
fnFunction
from the 'doubletap' event of this
sap.makit.Chart
.
The passed function and listener object must match the ones used for event registration.
Parameters:
{function} | fnFunction | The function to call, when the event occurs. |
{object} | oListener | Context object on which the given function had to be called. |
Returns:
Detach event handler
fnFunction
from the 'longpress' event of this
sap.makit.Chart
.
The passed function and listener object must match the ones used for event registration.
Parameters:
{function} | fnFunction | The function to call, when the event occurs. |
{object} | oListener | Context object on which the given function had to be called. |
Returns:
Detach event handler
fnFunction
from the 'tap' event of this
sap.makit.Chart
.
The passed function and listener object must match the ones used for event registration.
Parameters:
{function} | fnFunction | The function to call, when the event occurs. |
{object} | oListener | Context object on which the given function had to be called. |
Returns:
Fire event doubletap to attached listeners.
Parameters:
{Map} | mArguments? | the arguments to pass along with the event. |
Returns:
Fire event longpress to attached listeners.
Parameters:
{Map} | mArguments? | the arguments to pass along with the event. |
Returns:
Fire event tap to attached listeners.
Parameters:
{Map} | mArguments? | the arguments to pass along with the event. |
Returns:
Getter for property
height
. The height of the Chart
Default value is 100%
Returns:
Getter for property
legendPosition
. Legend position all chart types except Bar chart. Default position for Pie/Donut chart is Left. All other chart's default position is None. Note: the default legend position is set when the chart type is set first time, subsequent change to the chart type will keep using initial legend position unless it is changed explicitly by user.
Default value is empty/undefined
Returns:
getLineThickness(): float
Getter for property
lineThickness
. Specify the line thickness of the line graph. Only applies to Line chart type.
Default value is 1
Returns:
{float} | the value of property lineThickness |
getMaxSliceCount(): int
Getter for property
maxSliceCount
. Set the maximum number of slices in a Pie/Donut chart. If exceeding the specified value, the rest will be categorised into a single slice. Only applies to Pie/Donut.
Default value is 12
Returns:
{int} | the value of property maxSliceCount |
getNumberOfCategories()
See the generated JSDoc for the documentation of this public function
getNumberOfVisibleCategories(): int
Getter for property
numberOfVisibleCategories
. The number of categories that will be visible on the chart at any time. The minimum value is 2. If not set, the number of visible categories will be automatically adjusted depending on the screen size
Default value is empty/undefined
Returns:
{int} | the value of property numberOfVisibleCategories |
getPrimaryColorPalette(): any
Getter for property
primaryColorPalette
. Allow a chart’s color palette to be modified without affecting the other charts' color palette. If not set, the chart will use the default color palette defined in the theme. Accept an array of color in string format or hex format. e.g. 0xff0000 "red" "rgb(255,0,0)"
Default value is empty/undefined
Returns:
{any} | the value of property primaryColorPalette |
getRangeSelectorStartPosition(): int
Getter for property
rangeSelectorStartPosition
. Specify the range selector start position, default value is 0.
Default value is 0
Returns:
{int} | the value of property rangeSelectorStartPosition |
getSelectedCategory()
See the generated JSDoc for the documentation of this public function
getSelectedCategoryGroup()
See the generated JSDoc for the documentation of this public function
getSelectedSeries()
See the generated JSDoc for the documentation of this public function
getShowRangeSelector(): boolean
Getter for property
showRangeSelector
. Specify whether the range selector should be visible.
Default value is true
Returns:
{boolean} | the value of property showRangeSelector |
getShowTableValue(): boolean
Getter for property
showTableValue
. Toggle to display the table value on a Bar chart. Only applies to Bar chart.
Default value is true
Returns:
{boolean} | the value of property showTableValue |
getShowTableView(): boolean
Getter for property
showTableView
. Toggle to display table view
Default value is false
Returns:
{boolean} | the value of property showTableView |
getShowTotalValue(): boolean
Getter for property
showTotalValue
. Specify whether to show the sum of the value for Waterfall/Waterfall Bar chart. Only applies to Waterfall/WaterfallBar chart.
Default value is false
Returns:
{boolean} | the value of property showTotalValue |
Getter for property
type
. Chart type
Default value is Column
Returns:
Getter for property
width
. The width of the Chart
Default value is 100%
Returns:
Setter for property
height
.
Default value is 100%
Parameters:
Returns:
Setter for property
legendPosition
.
Default value is empty/undefined
Parameters:
Returns:
Setter for property
lineThickness
.
Default value is 1
Parameters:
{float} | fLineThickness | new value for property lineThickness |
Returns:
Setter for property
maxSliceCount
.
Default value is 12
Parameters:
{int} | iMaxSliceCount | new value for property maxSliceCount |
Returns:
Setter for property
numberOfVisibleCategories
.
Default value is empty/undefined
Parameters:
{int} | iNumberOfVisibleCategories | new value for property numberOfVisibleCategories |
Returns:
setRangeSelectorStartPosition
(iRangeSelectorStartPosition): sap.makit.Chart Setter for property
rangeSelectorStartPosition
.
Default value is 0
Parameters:
{int} | iRangeSelectorStartPosition | new value for property rangeSelectorStartPosition |
Returns:
Setter for property
showRangeSelector
.
Default value is true
Parameters:
{boolean} | bShowRangeSelector | new value for property showRangeSelector |
Returns:
Setter for property
showTableValue
.
Default value is true
Parameters:
{boolean} | bShowTableValue | new value for property showTableValue |
Returns:
Setter for property
showTableView
.
Default value is false
Parameters:
{boolean} | bShowTableView | new value for property showTableView |
Returns:
Setter for property
showTotalValue
.
Default value is false
Parameters:
{boolean} | bShowTotalValue | new value for property showTotalValue |
Returns:
Setter for property
type
.
Default value is Column
Parameters:
Returns:
Setter for property
width
.
Default value is 100%
Parameters:
Returns:
Adds some column oColumn
to the aggregation named columns
.
Parameters:
- Deprecated:
- Since version 1.38. MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control will not be supported anymore from 1.38.
Returns:
Binder for aggregation columns
.
Parameters:
{string} | sPath | path to a list in the model |
{sap.ui.core.Element} | oTemplate | the control template for this aggregation |
{sap.ui.model.Sorter} | oSorter | the initial sort order (optional) |
{array} | aFilters | the predefined filters for this aggregation (optional) |
- Deprecated:
- Since version 1.38. MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control will not be supported anymore from 1.38.
Returns:
Binder for aggregation rows
.
Parameters:
{string} | sPath | path to a list in the model |
{sap.ui.core.Element} | oTemplate | the control template for this aggregation |
{sap.ui.model.Sorter} | oSorter | the initial sort order (optional) |
{array} | aFilters | the predefined filters for this aggregation (optional) |
- Deprecated:
- Since version 1.38. MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control will not be supported anymore from 1.38.
Returns:
Destroys the categoryAxis in the aggregation named categoryAxis
.
- Deprecated:
- Since version 1.38. MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control will not be supported anymore from 1.38.
Returns:
Destroys all the categoryRegions in the aggregation named categoryRegions
.
- Deprecated:
- Since version 1.38. MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control will not be supported anymore from 1.38.
Returns:
Destroys all the columns in the aggregation named columns
.
- Deprecated:
- Since version 1.38. MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control will not be supported anymore from 1.38.
Returns:
Destroys the series in the aggregation named series
.
- Deprecated:
- Since version 1.38. MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control will not be supported anymore from 1.38.
Returns:
Destroys the valueAxis in the aggregation named valueAxis
.
- Deprecated:
- Since version 1.38. MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control will not be supported anymore from 1.38.
Returns:
Destroys the valueBubble in the aggregation named valueBubble
.
- Deprecated:
- Since version 1.38. MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control will not be supported anymore from 1.38.
Returns:
Destroys all the values in the aggregation named values
.
- Deprecated:
- Since version 1.38. MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control will not be supported anymore from 1.38.
Returns:
Getter for aggregation categoryAxis
.
Category Axis property of the Chart. Accepts only an instance of CategoryAxis element.
- Deprecated:
- Since version 1.38. MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control will not be supported anymore from 1.38.
Returns:
Getter for aggregation categoryRegions
.
Data region property of the chart's Categories
- Deprecated:
- Since version 1.38. MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control will not be supported anymore from 1.38.
Returns:
Getter for aggregation columns
.
The data column map of the chart.
- Deprecated:
- Since version 1.38. MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control will not be supported anymore from 1.38.
Returns:
Getter for aggregation rows
.
The data rows of the chart. User should bind these to their data source
- Deprecated:
- Since version 1.38. MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control will not be supported anymore from 1.38.
Returns:
Getter for aggregation series
.
Data region property of the chart's Series
- Deprecated:
- Since version 1.38. MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control will not be supported anymore from 1.38.
Returns:
Getter for aggregation valueAxis
.
Value Axis property of the Chart. Accept only an instance of ValueAxis element.
- Deprecated:
- Since version 1.38. MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control will not be supported anymore from 1.38.
Returns:
Getter for aggregation valueBubble
.
Value Bubble property of the Chart. Accept only an instance of ValueBubble element.
- Deprecated:
- Since version 1.38. MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control will not be supported anymore from 1.38.
Returns:
Getter for aggregation values
.
Data region property of the chart's Values
- Deprecated:
- Since version 1.38. MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control will not be supported anymore from 1.38.
Returns:
indexOfCategoryRegion(oCategoryRegion): int
Checks for the provided sap.makit.Category
in the aggregation named categoryRegions
and returns its index if found or -1 otherwise.
Parameters:
- Deprecated:
- Since version 1.38. MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control will not be supported anymore from 1.38.
Returns:
{int} | the index of the provided control in the aggregation if found, or -1 otherwise |
indexOfColumn(oColumn): int
Checks for the provided sap.makit.Column
in the aggregation named columns
and returns its index if found or -1 otherwise.
Parameters:
- Deprecated:
- Since version 1.38. MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control will not be supported anymore from 1.38.
Returns:
{int} | the index of the provided control in the aggregation if found, or -1 otherwise |
indexOfRow(oRow): int
Checks for the provided sap.makit.Row
in the aggregation named rows
and returns its index if found or -1 otherwise.
Parameters:
- Deprecated:
- Since version 1.38. MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control will not be supported anymore from 1.38.
Returns:
{int} | the index of the provided control in the aggregation if found, or -1 otherwise |
indexOfValue(oValue): int
Checks for the provided sap.makit.Value
in the aggregation named values
and returns its index if found or -1 otherwise.
Parameters:
- Deprecated:
- Since version 1.38. MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control will not be supported anymore from 1.38.
Returns:
{int} | the index of the provided control in the aggregation if found, or -1 otherwise |
Inserts a column into the aggregation named columns
.
Parameters:
{sap.makit.Column} | oColumn | the column to insert; if empty, nothing is inserted |
{int} | iIndex | the 0 -based index the column should be inserted at; for a negative value of iIndex , the column is inserted at position 0; for a value greater than the current size of the aggregation, the column is inserted at the last position |
- Deprecated:
- Since version 1.38. MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control will not be supported anymore from 1.38.
Returns:
Removes all the controls in the aggregation named columns
.
Additionally unregisters them from the hosting UIArea.
- Deprecated:
- Since version 1.38. MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control will not be supported anymore from 1.38.
Returns:
Removes an column from the aggregation named columns
.
Parameters:
- Deprecated:
- Since version 1.38. MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control will not be supported anymore from 1.38.
Returns:
Unbinder for aggregation columns
.
- Deprecated:
- Since version 1.38. MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control will not be supported anymore from 1.38.
Returns:
Unbinder for aggregation rows
.
- Deprecated:
- Since version 1.38. MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control will not be supported anymore from 1.38.
Returns: