CombinationChart

The CombinationChart control.

Deprecated API: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.

Since: 1.12.

Constructor Summary

new sap.makit.CombinationChart(sId?, mSettings?)Constructor for a new CombinationChart.

Event Summary

doubletap(oControlEvent)Double tap event on the chart

longpress(oControlEvent)Long press event on the chart

tap(oControlEvent)Single tap event on the chart

Events borrowed from class sap.ui.core.Control

validateFieldGroup

Events borrowed from class sap.ui.base.ManagedObject

formatError, modelContextChange, parseError, validationError, validationSuccess

Method Summary

sap.makit.CombinationChart.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.makit.CombinationChart with name sClassName and enriches it with the information contained in oClassInfo.

sap.makit.CombinationChart.getMetadata()Returns a metadata object for class sap.makit.CombinationChart.

attachDoubletap(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'doubletap' event of this sap.makit.CombinationChart.

attachLongpress(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'longpress' event of this sap.makit.CombinationChart.

attachTap(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'tap' event of this sap.makit.CombinationChart.

detachDoubletap(fnFunction, oListener)Detach event handler fnFunction from the 'doubletap' event of this sap.makit.CombinationChart.

detachLongpress(fnFunction, oListener)Detach event handler fnFunction from the 'longpress' event of this sap.makit.CombinationChart.

detachTap(fnFunction, oListener)Detach event handler fnFunction from the 'tap' event of this sap.makit.CombinationChart.

fireDoubletap(mArguments?)Fire event doubletap to attached listeners.

fireLongpress(mArguments?)Fire event longpress to attached listeners.

fireTap(mArguments?)Fire event tap to attached listeners.

getHeight()Getter for property height.

getLegendPosition()Getter for property legendPosition.

getNumberOfCategories()See the generated JSDoc for the documentation of this public function

getNumberOfVisibleCategories()Getter for property numberOfVisibleCategories.

getPrimaryColorPalette()Getter for property primaryColorPalette.

getRangeSelectorStartPosition()Getter for property rangeSelectorStartPosition.

getSecondaryColorPalette()Getter for property secondaryColorPalette.

getSelectedCategory()See the generated JSDoc for the documentation of this public function

getSelectedCategoryGroup()See the generated JSDoc for the documentation of this public function

getShowRangeSelector()Getter for property showRangeSelector.

getShowTableValue()Getter for property showTableValue.

getWidth()Getter for property width.

setHeight(sHeight)Setter for property height.

setLegendPosition(oLegendPosition)Setter for property legendPosition.

setNumberOfVisibleCategories(iNumberOfVisibleCategories)Setter for property numberOfVisibleCategories.

setPrimaryColorPalette(oPrimaryColorPalette)Setter for property primaryColorPalette.

setRangeSelectorStartPosition(iRangeSelectorStartPosition)Setter for property rangeSelectorStartPosition.

setSecondaryColorPalette(oSecondaryColorPalette)Setter for property secondaryColorPalette.

setShowRangeSelector(bShowRangeSelector)Setter for property showRangeSelector.

setShowTableValue(bShowTableValue)Setter for property showTableValue.

setWidth(sWidth)Setter for property width.

destroyCategoryAxis()Destroys the categoryAxis in the aggregation named categoryAxis.

destroyCategoryRegions()Destroys all the categoryRegions in the aggregation named categoryRegions.

destroyLayers()Destroys all the layers in the aggregation named layers.

destroyPrimaryValueAxis()Destroys the primaryValueAxis in the aggregation named primaryValueAxis.

destroySecondaryValueAxis()Destroys the secondaryValueAxis in the aggregation named secondaryValueAxis.

destroyValueBubble()Destroys the valueBubble in the aggregation named valueBubble.

getCategoryAxis()Getter for aggregation categoryAxis.

getCategoryRegions()Getter for aggregation categoryRegions.

getLayers()Getter for aggregation layers.

getPrimaryValueAxis()Getter for aggregation primaryValueAxis.

getSecondaryValueAxis()Getter for aggregation secondaryValueAxis.

getValueBubble()Getter for aggregation valueBubble.

indexOfCategoryRegion(oCategoryRegion)Checks for the provided sap.makit.Category in the aggregation named categoryRegions and returns its index if found or -1 otherwise.

indexOfLayer(oLayer)Checks for the provided sap.makit.Layer in the aggregation named layers and returns its index if found or -1 otherwise.

Methods borrowed from class sap.ui.core.Control

Methods borrowed from class sap.ui.core.Element

Methods borrowed from class sap.ui.base.ManagedObject

addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty

Methods borrowed from class sap.ui.base.EventProvider

attachEvent, attachEventOnce, detachEvent, hasListeners

Constructor Detail

new sap.makit.CombinationChart(sId?, mSettings?)

Constructor for a new CombinationChart.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers.

If the name of a setting is ambiguous (e.g. a property has the same name as an event), then the framework assumes property, aggregation, association, event in that order. To override this automatic resolution, one of the prefixes "aggregation:", "association:" or "event:" can be added to the name of the setting (such a prefixed name must be enclosed in single or double quotes).

The supported settings are:

Properties
- width : sap.ui.core.CSSSize (default: '100%')
- height : sap.ui.core.CSSSize (default: '100%')
- showRangeSelector : boolean (default: true)
- legendPosition : sap.makit.LegendPosition (default: sap.makit.LegendPosition.Left)
- primaryColorPalette : any
- secondaryColorPalette : any
- showTableValue : boolean (default: true)
- numberOfVisibleCategories : int
- rangeSelectorStartPosition : int (default: 0)
Aggregations
- categoryRegions : sap.makit.Category[]
- layers : sap.makit.Layer[]
- categoryAxis : sap.makit.CategoryAxis
- primaryValueAxis : sap.makit.ValueAxis
- secondaryValueAxis : sap.makit.ValueAxis
- valueBubble : sap.makit.ValueBubble
Associations
Events
- doubletap : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- tap : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- longpress : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

Parameters:

{string}	sId?	id for the new control, generated automatically if no id is given
{object}	mSettings?	initial settings for the new control

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.

Event Detail

doubletap(oControlEvent)

Double tap event on the chart

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters

longpress(oControlEvent)

Long press event on the chart

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters

tap(oControlEvent)

Single tap event on the chart

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters

Method Detail

sap.makit.CombinationChart.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.makit.CombinationChart 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

sap.makit.CombinationChart.getMetadata(): sap.ui.base.Metadata

Returns a metadata object for class sap.makit.CombinationChart.

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

attachDoubletap(oData?, fnFunction, oListener?): sap.makit.CombinationChart

Attach event handler fnFunction to the 'doubletap' event of this sap.makit.CombinationChart.
. When called, the context of the event handler (its this) will be bound to

oListener if specified otherwise to this sap.makit.CombinationChart.
 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.CombinationChart`. itself.

Returns:

{sap.makit.CombinationChart} this to allow method chaining

 attachLongpress(oData?, fnFunction, oListener?): sap.makit.CombinationChart
 Attach event handler fnFunction to the 'longpress' event of this sap.makit.CombinationChart.
. When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.makit.CombinationChart.
 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.CombinationChart.
 itself. 
Returns:
{sap.makit.CombinationChart} this to allow method chaining

 attachTap(oData?, fnFunction, oListener?): sap.makit.CombinationChart
 Attach event handler fnFunction to the 'tap' event of this sap.makit.CombinationChart.
. When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.makit.CombinationChart.
 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.CombinationChart.
 itself. 
Returns:
{sap.makit.CombinationChart} this to allow method chaining

 detachDoubletap(fnFunction, oListener): sap.makit.CombinationChart
 Detach event handler fnFunction from the 'doubletap' event of this sap.makit.CombinationChart.
 
 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:
{sap.makit.CombinationChart} this to allow method chaining

 detachLongpress(fnFunction, oListener): sap.makit.CombinationChart
 Detach event handler fnFunction from the 'longpress' event of this sap.makit.CombinationChart.
 
 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:
{sap.makit.CombinationChart} this to allow method chaining

 detachTap(fnFunction, oListener): sap.makit.CombinationChart
 Detach event handler fnFunction from the 'tap' event of this sap.makit.CombinationChart.
 
 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:
{sap.makit.CombinationChart} this to allow method chaining

 fireDoubletap(mArguments?): sap.makit.CombinationChart
 Fire event doubletap to attached listeners. 
Parameters:
{Map} mArguments?  the arguments to pass along with the event. 
Returns:
{sap.makit.CombinationChart} this to allow method chaining

 fireLongpress(mArguments?): sap.makit.CombinationChart
 Fire event longpress to attached listeners. 
Parameters:
{Map} mArguments?  the arguments to pass along with the event. 
Returns:
{sap.makit.CombinationChart} this to allow method chaining

 fireTap(mArguments?): sap.makit.CombinationChart
 Fire event tap to attached listeners. 
Parameters:
{Map} mArguments?  the arguments to pass along with the event. 
Returns:
{sap.makit.CombinationChart} this to allow method chaining

 getHeight(): sap.ui.core.CSSSize
 Getter for property height. The height of the Chart 
 Default value is 100%
Returns:
{sap.ui.core.CSSSize}  the value of property height

 getLegendPosition(): sap.makit.LegendPosition
 Getter for property legendPosition. Legend position for Pie /Donut chart only. 
 Default value is Left
Returns:
{sap.makit.LegendPosition}  the value of property legendPosition

 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 combination chart’s primary axis color palette to be modified without affecting 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

 getSecondaryColorPalette(): any
 Getter for property secondaryColorPalette. Allow a combination chart’s secondary axis color palette to be modified without affecting 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 secondaryColorPalette

 getSelectedCategory()
 See the generated JSDoc for the documentation of this public function

 getSelectedCategoryGroup()
 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

 getWidth(): sap.ui.core.CSSSize
 Getter for property width. The width of the Chart 
 Default value is 100%
Returns:
{sap.ui.core.CSSSize}  the value of property width

 setHeight(sHeight): sap.makit.CombinationChart
 Setter for property height. 
 Default value is 100%
Parameters:
{sap.ui.core.CSSSize} sHeight  new value for property height
Returns:
{sap.makit.CombinationChart} this to allow method chaining

 setLegendPosition(oLegendPosition): sap.makit.CombinationChart
 Setter for property legendPosition. 
 Default value is Left
Parameters:
{sap.makit.LegendPosition} oLegendPosition  new value for property legendPosition
Returns:
{sap.makit.CombinationChart} this to allow method chaining

 setNumberOfVisibleCategories(iNumberOfVisibleCategories): sap.makit.CombinationChart
 Setter for property numberOfVisibleCategories. 
 Default value is empty/undefined
Parameters:
{int} iNumberOfVisibleCategories  new value for property numberOfVisibleCategories
Returns:
{sap.makit.CombinationChart} this to allow method chaining

 setPrimaryColorPalette(oPrimaryColorPalette): sap.makit.CombinationChart
 Setter for property primaryColorPalette. 
 Default value is empty/undefined
Parameters:
{any} oPrimaryColorPalette  new value for property primaryColorPalette
Returns:
{sap.makit.CombinationChart} this to allow method chaining

 setRangeSelectorStartPosition(iRangeSelectorStartPosition): sap.makit.CombinationChart
 Setter for property rangeSelectorStartPosition. 
 Default value is 0
Parameters:
{int} iRangeSelectorStartPosition  new value for property rangeSelectorStartPosition
Returns:
{sap.makit.CombinationChart} this to allow method chaining

 setSecondaryColorPalette(oSecondaryColorPalette): sap.makit.CombinationChart
 Setter for property secondaryColorPalette. 
 Default value is empty/undefined
Parameters:
{any} oSecondaryColorPalette  new value for property secondaryColorPalette
Returns:
{sap.makit.CombinationChart} this to allow method chaining

 setShowRangeSelector(bShowRangeSelector): sap.makit.CombinationChart
 Setter for property showRangeSelector. 
 Default value is true
Parameters:
{boolean} bShowRangeSelector  new value for property showRangeSelector
Returns:
{sap.makit.CombinationChart} this to allow method chaining

 setShowTableValue(bShowTableValue): sap.makit.CombinationChart
 Setter for property showTableValue. 
 Default value is true
Parameters:
{boolean} bShowTableValue  new value for property showTableValue
Returns:
{sap.makit.CombinationChart} this to allow method chaining

 setWidth(sWidth): sap.makit.CombinationChart
 Setter for property width. 
 Default value is 100%
Parameters:
{sap.ui.core.CSSSize} sWidth  new value for property width
Returns:
{sap.makit.CombinationChart} this to allow method chaining

 destroyCategoryAxis(): sap.makit.CombinationChart
 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:
{sap.makit.CombinationChart} this to allow method chaining

 destroyCategoryRegions(): sap.makit.CombinationChart
 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:
{sap.makit.CombinationChart} this to allow method chaining

 destroyLayers(): sap.makit.CombinationChart
 Destroys all the layers in the aggregation named layers. 
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:
{sap.makit.CombinationChart} this to allow method chaining

 destroyPrimaryValueAxis(): sap.makit.CombinationChart
 Destroys the primaryValueAxis in the aggregation named primaryValueAxis. 
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:
{sap.makit.CombinationChart} this to allow method chaining

 destroySecondaryValueAxis(): sap.makit.CombinationChart
 Destroys the secondaryValueAxis in the aggregation named secondaryValueAxis. 
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:
{sap.makit.CombinationChart} this to allow method chaining

 destroyValueBubble(): sap.makit.CombinationChart
 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:
{sap.makit.CombinationChart} this to allow method chaining

 getCategoryAxis(): sap.makit.CategoryAxis
 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:
{sap.makit.CategoryAxis}

 getCategoryRegions(): sap.makit.Category[]
 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:
{sap.makit.Category[]}

 getLayers(): sap.makit.Layer[]
 Getter for aggregation layers.
 The collection of charts 
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:
{sap.makit.Layer[]}

 getPrimaryValueAxis(): sap.makit.ValueAxis
 Getter for aggregation primaryValueAxis.
 Property of the Combination Chart's primary Value Axis. 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:
{sap.makit.ValueAxis}

 getSecondaryValueAxis(): sap.makit.ValueAxis
 Getter for aggregation secondaryValueAxis.
 Property of the Combination Chart's secondary Value Axis. 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:
{sap.makit.ValueAxis}

 getValueBubble(): sap.makit.ValueBubble
 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:
{sap.makit.ValueBubble}

 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:
{sap.makit.Category} oCategoryRegion  the categoryRegion whose index is looked for. 
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

 indexOfLayer(oLayer): int
 Checks for the provided sap.makit.Layer in the aggregation named layers and returns its index if found or -1 otherwise. 
Parameters:
{sap.makit.Layer} oLayer  the layer whose index is looked for. 
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