sap.ca.ui.charts.ChartToolBar.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ca.ui.charts.ChartToolBar 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.ca.ui.charts.ChartToolBar.
Returns:
Adds some chart oChart
to the aggregation named charts
.
Parameters:
Returns:
Attach event handler
fnFunction
to the 'firstDimensionKeySelected' event of this
sap.ca.ui.charts.ChartToolBar
.
. When called, the context of the event handler (its
this
) will be bound to
oListener if specified otherwise to this sap.ca.ui.charts.ChartToolBar
.
itself. Event fired when a user selects an item from the first select box. This event is providing the item selectedKey as parameter
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.ca.ui.charts.ChartToolBar . itself. |
Returns:
Attach event handler
fnFunction
to the 'personalizationPressed' event of this
sap.ca.ui.charts.ChartToolBar
.
. When called, the context of the event handler (its
this
) will be bound to
oListener if specified otherwise to this sap.ca.ui.charts.ChartToolBar
.
itself. Event fired when a user clicks on the personalization icon
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.ca.ui.charts.ChartToolBar . itself. |
Returns:
Attach event handler
fnFunction
to the 'secondDimensionKeySelected' event of this
sap.ca.ui.charts.ChartToolBar
.
. When called, the context of the event handler (its
this
) will be bound to
oListener if specified otherwise to this sap.ca.ui.charts.ChartToolBar
.
itself. Event fired when a user selects an item from the second select box. This event is providing the item selectedKey as parameter
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.ca.ui.charts.ChartToolBar . itself. |
Returns:
Destroys all the charts in the aggregation named charts
.
Returns:
Destroys the toolBar in the aggregation named toolBar
.
Returns:
Detach event handler
fnFunction
from the 'firstDimensionKeySelected' event of this
sap.ca.ui.charts.ChartToolBar
.
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 'personalizationPressed' event of this
sap.ca.ui.charts.ChartToolBar
.
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 'secondDimensionKeySelected' event of this
sap.ca.ui.charts.ChartToolBar
.
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 firstDimensionKeySelected to attached listeners.
Parameters:
{Map} | mArguments? | the arguments to pass along with the event. |
Returns:
Fire event personalizationPressed to attached listeners.
Parameters:
{Map} | mArguments? | the arguments to pass along with the event. |
Returns:
Fire event secondDimensionKeySelected to attached listeners.
Parameters:
{Map} | mArguments? | the arguments to pass along with the event. |
Returns:
Getter for aggregation
charts
.
The charts to display. Theses charts are sap.ui.core/Control that implements the following properties: - showLegend: boolean - icon: string (expected a string such as "sap-icon://line-chart")
If the inserted control is an sap.m.Table, the icon is automatically set to "sap-icon://table-chart"
Returns:
getChartTitle(): string
Getter for property
chartTitle
. The string to display instead of the select boxes if there are no dimensions to display
Default value is empty/undefined
Returns:
{string} | the value of property chartTitle |
getFirstDimensionKeyPath(): string
Getter for property
firstDimensionKeyPath
. Model path to the first select box items key
Default value is empty/undefined
Returns:
{string} | the value of property firstDimensionKeyPath |
getFirstDimensionPath(): string
Getter for property
firstDimensionPath
. Model path to the dimensions to display into the first select box
Default value is empty/undefined
Returns:
{string} | the value of property firstDimensionPath |
getFirstDimensionSelect(): string
The sap.m.Select inserted into the toolBar for handling the firstDimension selection
Returns:
{string} | Id of the element which is the current target of the firstDimensionSelect association, or null |
getFirstDimensionTextPath(): string
Getter for property
firstDimensionTextPath
. Model path to the first select box items displayed text
Default value is empty/undefined
Returns:
{string} | the value of property firstDimensionTextPath |
getFullScreen(): boolean
Getter for property
fullScreen
. Display the chart and the toolbar in full screen or normal mode
Default value is false
Returns:
{boolean} | the value of property fullScreen |
getSecondDimensionKeyPath(): string
Getter for property
secondDimensionKeyPath
. Model path to the second select box items key
Default value is empty/undefined
Returns:
{string} | the value of property secondDimensionKeyPath |
getSecondDimensionPath(): string
Getter for property
secondDimensionPath
. Model path to the dimensions to display into the second select box
Default value is empty/undefined
Returns:
{string} | the value of property secondDimensionPath |
getSecondDimensionSelect(): string
The sap.m.Select inserted into the toolBar for handling the secondDimension selection
Returns:
{string} | Id of the element which is the current target of the secondDimensionSelect association, or null |
getSecondDimensionTextPath(): string
Getter for property
secondDimensionTextPath
. Model path to the displayed select box items displayed text
Default value is empty/undefined
Returns:
{string} | the value of property secondDimensionTextPath |
getSelectedChart(): string
The ui5 control displayed
Returns:
{string} | Id of the element which is the current target of the selectedChart association, or null |
getShowFullScreen(): boolean
Getter for property
showFullScreen
. Display or not the full screen icon into the ChartToolBar
Default value is false
Returns:
{boolean} | the value of property showFullScreen |
getShowLegend(): boolean
Getter for property
showLegend
. Display or not the legend on the contained charts.
Default value is true
Returns:
{boolean} | the value of property showLegend |
getShowPersonalization(): boolean
Getter for property
showPersonalization
. Display or not the personalization icon into the ChartToolBar
Default value is false
Returns:
{boolean} | the value of property showPersonalization |
Getter for aggregation toolBar
.
The composite sap.m.Bar used for rendering select boxes and icons.
Returns:
indexOfChart(oChart): int
Checks for the provided sap.ui.core.Control
in the aggregation named charts
and returns its index if found or -1 otherwise.
Parameters:
Returns:
{int} | the index of the provided control in the aggregation if found, or -1 otherwise |
Inserts a chart into the aggregation named charts
.
Parameters:
{sap.ui.core.Control} | oChart | the chart to insert; if empty, nothing is inserted |
{int} | iIndex | the 0 -based index the chart should be inserted at; for a negative value of iIndex , the chart is inserted at position 0; for a value greater than the current size of the aggregation, the chart is inserted at the last position |
Returns:
Removes all the controls in the aggregation named charts
.
Additionally unregisters them from the hosting UIArea.
Returns:
Removes an chart from the aggregation named charts
.
Parameters:
Returns:
Setter for property
chartTitle
.
Default value is empty/undefined
Parameters:
{string} | sChartTitle | new value for property chartTitle |
Returns:
Setter for property
firstDimensionKeyPath
.
Default value is empty/undefined
Parameters:
{string} | sFirstDimensionKeyPath | new value for property firstDimensionKeyPath |
Returns:
Setter for property
firstDimensionPath
.
Default value is empty/undefined
Parameters:
{string} | sFirstDimensionPath | new value for property firstDimensionPath |
Returns:
The sap.m.Select inserted into the toolBar for handling the firstDimension selection
Parameters:
{string|sap.m.Select} | vFirstDimensionSelect | Id of an element which becomes the new target of this firstDimensionSelect association. Alternatively, an element instance may be given. |
Returns:
Setter for property
firstDimensionTextPath
.
Default value is empty/undefined
Parameters:
{string} | sFirstDimensionTextPath | new value for property firstDimensionTextPath |
Returns:
Setter for property
fullScreen
.
Default value is false
Parameters:
{boolean} | bFullScreen | new value for property fullScreen |
Returns:
Setter for property
secondDimensionKeyPath
.
Default value is empty/undefined
Parameters:
{string} | sSecondDimensionKeyPath | new value for property secondDimensionKeyPath |
Returns:
Setter for property
secondDimensionPath
.
Default value is empty/undefined
Parameters:
{string} | sSecondDimensionPath | new value for property secondDimensionPath |
Returns:
The sap.m.Select inserted into the toolBar for handling the secondDimension selection
Parameters:
{string|sap.m.Select} | vSecondDimensionSelect | Id of an element which becomes the new target of this secondDimensionSelect association. Alternatively, an element instance may be given. |
Returns:
Setter for property
secondDimensionTextPath
.
Default value is empty/undefined
Parameters:
{string} | sSecondDimensionTextPath | new value for property secondDimensionTextPath |
Returns:
The ui5 control displayed
Parameters:
{string|sap.ui.core.Control} | vSelectedChart | Id of an element which becomes the new target of this selectedChart association. Alternatively, an element instance may be given. |
Returns:
Setter for property
showFullScreen
.
Default value is false
Parameters:
{boolean} | bShowFullScreen | new value for property showFullScreen |
Returns:
Setter for property
showLegend
.
Default value is true
Parameters:
{boolean} | bShowLegend | new value for property showLegend |
Returns:
Setter for property
showPersonalization
.
Default value is false
Parameters:
{boolean} | bShowPersonalization | new value for property showPersonalization |
Returns:
Setter for the aggregated toolBar
.
Parameters:
Returns: