sap.apb.makit.Chart class

MAKit Chart

Version: 1.0

Syntax

new Chart( [sId], [mSettings] )

Constructor for a new Chart. Accepts an object literal <code>mSettings</code> 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
    • #getType type : sap.apb.makit.ChartType (default: sap.apb.makit.ChartType.Column)
    • #getCategorySortOrder categorySortOrder : sap.apb.makit.SortOrder (default: sap.apb.makit.SortOrder.None)
    • #getDataSource dataSource : string
    • height : sap.ui.core.CSSSize (default: '100%')
    • #getLegendPosition legendPosition : sap.apb.makit.LegendPosition (default: sap.apb.makit.LegendPosition.None)
    • #getLineThickness lineThickness : float (default: 1)
    • #getMaxSliceCount maxSliceCount : int (default: 12)
    • #getMetadataFile metadataFile : sap.ui.core.URI
    • #getShowRangeSelector showRangeSelector : boolean (default: true)
    • #getShowTableView showTableView : boolean (default: false)
    • #getShowTableValue showTableValue : boolean (default: true)
    • #getShowToolbar showToolbar : boolean (default: true)
    • #getWidth width : sap.ui.core.CSSSize (default: '100%')
  • Aggregations
  • Associations
  • Events
    • sap.apb.makit.Chart#event:doubletap doubletap : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • sap.apb.makit.Chart#event:tap tap : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

Extends

Parameters

Name Type Argument Description
sId string (optional) id for the new control, generated automatically if no id is given
mSettings object (optional) initial settings for the new control

Methods

Name Description
attachDoubletap( [oData], fnFunction, [oListener] ) Attach event handler <code>fnFunction</code> to the 'doubletap' event of this <code>sap.apb.makit.Chart</code>.
attachTap( [oData], fnFunction, [oListener] ) Attach event handler <code>fnFunction</code> to the 'tap' event of this <code>sap.apb.makit.Chart</code>.
detachDoubletap( fnFunction, oListener ) Detach event handler <code>fnFunction</code> from the 'doubletap' event of this <code>sap.apb.makit.Chart</code>.
detachTap( fnFunction, oListener ) Detach event handler <code>fnFunction</code> from the 'tap' event of this <code>sap.apb.makit.Chart</code>.
extend( sClassName, [oClassInfo], [FNMetaImpl] )  
fireDoubletap( [mArguments] ) Fire event doubletap to attached listeners.
fireTap( [mArguments] ) Fire event tap to attached listeners.
getCategorySortOrder() Getter for property <code>categorySortOrder</code>. Sort order for category.
getDataSource() Getter for property <code>dataSource</code>. dataSource name of the chart. Default value is empty/<code>undefined</code>
getHeight() Getter for property <code>height</code>. The height of the Chart. Default value is <code>100%</code>
getLegendPosition() Getter for property <code>legendPosition</code>. Legend position all chart types except Bar chart.
getLineThickness() Getter for property <code>lineThickness</code>. Specify the line thickness of the line graph.
getMaxSliceCount() Getter for property <code>maxSliceCount</code>. Set the maximum number of slices in a Pie/Donut chart.
getMetadataFile() Getter for property <code>metadataFile</code>. Metadata file URI that is assigned to this chart.
getNumberOfCategories() Get the number of distinct category values.
getSelectedCategory() Get the value of the currently highlighted category.
getSelectedSeries() Get the value of the currently highlighted series.
getShowRangeSelector() Getter for property <code>showRangeSelector</code>. Specify whether the range selector should be visible. Default value is <code>true</code>
getShowTableValue() Getter for property <code>showTableValue</code>. Toggle to display the table value on a Bar chart.
getShowTableView() Getter for property <code>showTableView</code>. Toggle to display table view. Default value is <code>false</code>
getShowToolbar() Getter for property <code>showToolbar</code>. Show or hide the chart's toolbar. Default value is <code>true</code>
getType() Getter for property <code>type</code>. Chart type. Default value is <code>Column</code>
getWidth() Getter for property <code>width</code>. The width of the Chart. Default value is <code>100%</code>
refreshData() Re-retrieve data from the datasource and re-render chart.
setCategorySortOrder( oCategorySortOrder ) Setter for property <code>categorySortOrder</code>. Default value is <code>None</code>
setDataSource( sDataSource ) Setter for property <code>dataSource</code>. Default value is empty/<code>undefined</code>
setHeight( sHeight ) Setter for property <code>height</code>. Default value is <code>100%</code>
setLegendPosition( oLegendPosition ) Setter for property <code>legendPosition</code>. Default value is <code>None</code>
setLineThickness( fLineThickness ) Setter for property <code>lineThickness</code>. Default value is <code>1</code>
setMaxSliceCount( iMaxSliceCount ) Setter for property <code>maxSliceCount</code>. Default value is <code>12</code>
setMetadataFile( sMetadataFile ) Setter for property <code>metadataFile</code>. Default value is empty/<code>undefined</code>
setShowRangeSelector( bShowRangeSelector ) Setter for property <code>showRangeSelector</code>. Default value is <code>true</code>
setShowTableValue( bShowTableValue ) Setter for property <code>showTableValue</code>. Default value is <code>true</code>
setShowTableView( bShowTableView ) Setter for property <code>showTableView</code>. Default value is <code>false</code>
setShowToolbar( bShowToolbar ) Setter for property <code>showToolbar</code>. Default value is <code>true</code>
setType( oType ) Setter for property <code>type</code>. Default value is <code>Column</code>
setWidth( sWidth ) Setter for property <code>width</code>. Default value is <code>100%</code>

Events

Name Description
doubletap( oControlEvent, oControlEvent.getSource, oControlEvent.getParameters ) Double tap event on chart.
tap( oControlEvent, oControlEvent.getSource, oControlEvent.getParameters ) Single tap event on the chart.

Source

makit/Chart.API.js, line 11.

Parent topic: AppBuilder API Reference