Class sap.ca.ui.charts.LineChartModule: sap/ca/ui/charts/LineChart
extends Chart
Line Chart for the Fiori Project
Deprecated API:Since version 1.24.
Sap.ca charts have been replaced with sap.viz and vizFrame in 1.24. The UI5 control "sap.viz.ui5.controls.VizFrame" serves as a single point of entry for all the new charts. Now that 1.24 is available you are asked to use sap.viz charts and the VizFrame instead! This control will not be supported anymore from 1.24.
Since: 1.0.0.
Constructor Summary
Event Summary
onDetailsSelected(oControlEvent)Event fired when the details button is pressed on the selected Datapoint Popover
Events borrowed from class sap.ca.ui.charts.Chart
Events borrowed from class sap.ui.core.Control
Events borrowed from class sap.ui.base.ManagedObject
Method Summary
sap.ca.ui.charts.LineChart.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ca.ui.charts.LineChart with name
sClassName and enriches it with the information contained in oClassInfo.sap.ca.ui.charts.LineChart.getMetadata()Returns a metadata object for class sap.ca.ui.charts.LineChart.
attachOnDetailsSelected(oData?, fnFunction, oListener?)Attach event handler
fnFunction to the 'onDetailsSelected' event of this sap.ca.ui.charts.LineChart.detachOnDetailsSelected(fnFunction, oListener)Detach event handler
fnFunction from the 'onDetailsSelected' event of this sap.ca.ui.charts.LineChart.Methods borrowed from class sap.ca.ui.charts.Chart
_createId, advancedChartSettings, attachPopoverAfterOpen, attachPopoverBeforeOpen, attachSelectDataPoint, bindLabel, dataLabelFormatter, detachPopoverAfterOpen, detachPopoverBeforeOpen, detachSelectDataPoint, firePopoverAfterOpen, firePopoverBeforeOpen, fireSelectDataPoint, getAdvancedChartSettings, getChartPopOver, getChartSemanticColorFormatter, getChartType, getDataLabelFormatter, getDataset, getHeight, getIcon, getInternalVizChart, getLabel, getMinShapeSize, getNoData, getPlotAreaAxisTooltipFormatter, getPopoverFooter, getPopoverFormatter, getPopoverGroupFormatter, getPopoverSubHeader, getSecondAxisVisible, getSelectionMode, getShowDataLabel, getShowHoverBackground, getShowLegend, getShowPopover, getShowTooltip, getStackedChartWidthEnhancer, getTitle, getTooltipFormatter, getWidth, getXAxis2LabelFormatter, getXAxisLabelFormatter, getYAxis2LabelFormatter, getYAxisLabelFormatter, minShapeSize, popoverFormatter, popoverGroupFormatter, setAdvancedChartSettings, setChartPopOver, setChartSemanticColorFormatter, setChartType, setDataLabelFormatter, setDataset, setHeight, setIcon, setInternalVizChart, setLabel, setMinShapeSize, setModel, setNoData, setPlotAreaAxisTooltipFormatter, setPopoverFooter, setPopoverFormatter, setPopoverGroupFormatter, setPopoverSubHeader, setSecondAxisVisible, setSelectionMode, setShowDataLabel, setShowHoverBackground, setShowLegend, setShowPopover, setShowTooltip, setStackedChartWidthEnhancer, setTitle, setTooltipFormatter, setWidth, setXAxis2LabelFormatter, setXAxisLabelFormatter, setYAxis2LabelFormatter, setYAxisLabelFormatter, tooltipFormatter, unbindLabel, xAxis2LabelFormatter, xAxisLabelFormatter, yAxis2LabelFormatter, yAxisLabelFormatter
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, onAfterRendering, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, 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, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
Constructor Detail
new sap.ca.ui.charts.LineChart(sId?, mSettings?)
Constructor for a new charts/LineChart.
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
- chartTitle : string (default: 'Line Chart')
- dataLabelFormat : any (default: '#0')
- minTouchSize : string (default: '48px')
- minTouchWidth : string (default: '48px')
- showLabel : boolean (default: true)
- showScrollContext : boolean (default: false)
- chartDataset : any
- datasetSettings : any
- chartDatasetSettings : any
- dataPath : string
- data : any
- chartBusinessData : any
- useDelayedResize : boolean (default: false)
- Aggregations
- vertical : sap.m.VBox
- Associations
- Events
- onDetailsSelected : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
In addition, all settings applicable to the base type sap.ca.ui.charts.Chart can be used as well.
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.24.
Sap.ca charts have been replaced with sap.viz and vizFrame in 1.24. The UI5 control "sap.viz.ui5.controls.VizFrame" serves as a single point of entry for all the new charts. Now that 1.24 is available you are asked to use sap.viz charts and the VizFrame instead! This control will not be supported anymore from 1.24.
Event Detail
onDetailsSelected(oControlEvent)
Event fired when the details button is pressed on the selected Datapoint Popover
Parameters:
| {sap.ui.base.Event} | oControlEvent | |
| {sap.ui.base.EventProvider} | oControlEvent.getSource | |
| {object} | oControlEvent.getParameters |
- Deprecated:
- Since version 1.0.0. Do not use as it will be removed in a future release.
Method Detail
sap.ca.ui.charts.LineChart.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ca.ui.charts.LineChart 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.ca.ui.charts.LineChart.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ca.ui.charts.LineChart.
Returns:
| {sap.ui.base.Metadata} | Metadata object describing this class |
getDataLabelFormat(): any
Getter for property
dataLabelFormat. The data format string to use to display the data labels on the graph, this is an array of arrays of Format String following the 'sap.viz.ui5.Line' documentation Default value is '#0'
Returns:
| {any} | the value of property dataLabelFormat |
setDataLabelFormat(oDataLabelFormat): sap.ca.ui.charts.LineChart
Setter for property
dataLabelFormat. Default value is '#0'
Parameters:
| {any} | oDataLabelFormat | new value for property dataLabelFormat |
Returns:
| {sap.ca.ui.charts.LineChart} | this to allow method chaining |
attachOnDetailsSelected(oData?, fnFunction, oListener?): sap.ca.ui.charts.LineChart
Attach event handler
. When called, the context of the event handler (its
fnFunction to the 'onDetailsSelected' event of this sap.ca.ui.charts.LineChart.. When called, the context of the event handler (its
this) will be bound to oListener if specified otherwise to this sap.ca.ui.charts.LineChart.
itself. Event fired when the details button is pressed on the selected Datapoint Popover
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.LineChart.itself. |
- Deprecated:
- Since version 1.0.0. Do not use as it will be removed in a future release.
Returns:
| {sap.ca.ui.charts.LineChart} | this to allow method chaining |
destroyVertical(): sap.ca.ui.charts.LineChart
Destroys the vertical in the aggregation named
vertical. - Deprecated:
- Since version 1.0.0. Do not use as it will be removed in a future release.
Returns:
| {sap.ca.ui.charts.LineChart} | this to allow method chaining |
detachOnDetailsSelected(fnFunction, oListener): sap.ca.ui.charts.LineChart
Detach event handler
fnFunction from the 'onDetailsSelected' event of this sap.ca.ui.charts.LineChart.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. |
- Deprecated:
- Since version 1.0.0. Do not use as it will be removed in a future release.
Returns:
| {sap.ca.ui.charts.LineChart} | this to allow method chaining |
fireOnDetailsSelected(mArguments?): sap.ca.ui.charts.LineChart
Fire event onDetailsSelected to attached listeners.
Parameters:
| {Map} | mArguments? | the arguments to pass along with the event. |
- Deprecated:
- Since version 1.0.0. Do not use as it will be removed in a future release.
Returns:
| {sap.ca.ui.charts.LineChart} | this to allow method chaining |
getChartBusinessData(): any
Getter for property
chartBusinessData. Allow the chart data to be set, that is the measure and dimension values Default value is empty/undefined
- Deprecated:
- Since version 1.0.0. This is a copy of the 'data' property, do not use as it will be removed in a future release.
Returns:
| {any} | the value of property chartBusinessData |
getChartDataset(): any
Getter for property
chartDataset. Allow the Dataset for the chart to be set, includes the dimensions, and measures, any data binding is removed, this will disable the chart scroll context view, use the dataset settings if you want the scroll context to work Default value is empty/undefined
- Deprecated:
- Since version 1.0.0. This is a copy of the 'dataset' property, do not use as it will be removed in a future release.
Returns:
| {any} | the value of property chartDataset |
getChartDatasetSettings(): any
Getter for property
chartDatasetSettings. Allow the Dataset for the chart to be set by providing the settings for the dataset creation, (internally two datasets are created, one for the main chart and one for the scroll context) Default value is empty/undefined
- Deprecated:
- Since version 1.0.0. This is a copy of the 'datasetSettings' property, do not use as it will be removed in a future release.
Returns:
| {any} | the value of property chartDatasetSettings |
getChartTitle(): string
Getter for property
chartTitle. The title to display on the chart Default value is Line Chart
- Deprecated:
- Since version 1.0.0. This is a copy of the 'title' property, do not use as it will be removed in a future release.
Returns:
| {string} | the value of property chartTitle |
getData(): any
Getter for property
data. Allow the chart data to be set, that is the measure and dimension values Default value is empty/undefined
- Deprecated:
- Since version 1.0.0. Please use the binding on 'dataset', do not use as it will be removed in a future release.
Returns:
| {any} | the value of property data |
getDataPath(): string
Getter for property
dataPath. Allow the data path for binding the model to the dimensions and measures to be set Default value is empty/undefined
- Deprecated:
- Since version 1.0.0. Please use the binding on 'dataset', do not use as it will be removed in a future release.
Returns:
| {string} | the value of property dataPath |
getDatasetSettings(): any
Getter for property
datasetSettings. Allow the Dataset for the chart to be set by providing the settings for the dataset creation, (internally two datasets are created, one for the main chart and one for the scroll context) Default value is empty/undefined
- Deprecated:
- Since version 1.0.0. This is property is not needed any more, do not use as it will be removed in a future release.
Returns:
| {any} | the value of property datasetSettings |
getMinTouchSize(): string
Getter for property
minTouchSize. The minimum size (width for a line chart) that a point has to be, so as to be able to touch on a mobile device, only applies if the chart width is not set Default value is 48px
- Deprecated:
- Since version 1.0.0. Please use the 'dataLabelFormatter' property, do not use as it will be removed in a future release.
Returns:
| {string} | the value of property minTouchSize |
getMinTouchWidth(): string
Getter for property
minTouchWidth. The minimum size (width for a line chart) that a point has to be, so as to be able to touch on a mobile device, only applies if the chart width is not set Default value is 48px
- Deprecated:
- Since version 1.0.0. Please use the 'minShapeSize' property, do not use as it will be removed in a future release.
Returns:
| {string} | the value of property minTouchWidth |
getShowLabel(): boolean
Getter for property
showLabel. Show the data label value on the chart Default value is true
- Deprecated:
- Since version 1.0.0. This is a copy of the 'showDataLabel' property, do not use as it will be removed in a future release.
Returns:
| {boolean} | the value of property showLabel |
getShowScrollContext(): boolean
Getter for property
showScrollContext. Show the chart scroll context, (the preview of the whole chart as a small image when scrolling) Default value is false
- Deprecated:
- Since version 1.0.0. Feature does not work correctly yet.
Returns:
| {boolean} | the value of property showScrollContext |
getUseDelayedResize(): boolean
Getter for property
useDelayedResize. Use a delayed resize event to cause the chart to render when navigated to after resize when in the background Default value is false
- Deprecated:
- Since version 1.0.0. Do not use as it will be removed in a future release.
Returns:
| {boolean} | the value of property useDelayedResize |
getVertical(): sap.m.VBox
Getter for aggregation
The vertical layout
vertical.The vertical layout
- Deprecated:
- Since version 1.0.0. Do not use as it will be removed in a future release.
Returns:
| {sap.m.VBox} |
setChartBusinessData(oChartBusinessData): sap.ca.ui.charts.LineChart
Setter for property
chartBusinessData. Default value is empty/undefined
Parameters:
| {any} | oChartBusinessData | new value for property chartBusinessData |
- Deprecated:
- Since version 1.0.0. This is a copy of the 'data' property, do not use as it will be removed in a future release.
Returns:
| {sap.ca.ui.charts.LineChart} | this to allow method chaining |
setChartDataset(oChartDataset): sap.ca.ui.charts.LineChart
Setter for property
chartDataset. Default value is empty/undefined
Parameters:
| {any} | oChartDataset | new value for property chartDataset |
- Deprecated:
- Since version 1.0.0. This is a copy of the 'dataset' property, do not use as it will be removed in a future release.
Returns:
| {sap.ca.ui.charts.LineChart} | this to allow method chaining |
setChartDatasetSettings(oChartDatasetSettings): sap.ca.ui.charts.LineChart
Setter for property
chartDatasetSettings. Default value is empty/undefined
Parameters:
| {any} | oChartDatasetSettings | new value for property chartDatasetSettings |
- Deprecated:
- Since version 1.0.0. This is a copy of the 'datasetSettings' property, do not use as it will be removed in a future release.
Returns:
| {sap.ca.ui.charts.LineChart} | this to allow method chaining |
setChartTitle(sChartTitle): sap.ca.ui.charts.LineChart
Setter for property
chartTitle. Default value is Line Chart
Parameters:
| {string} | sChartTitle | new value for property chartTitle |
- Deprecated:
- Since version 1.0.0. This is a copy of the 'title' property, do not use as it will be removed in a future release.
Returns:
| {sap.ca.ui.charts.LineChart} | this to allow method chaining |
setData(oData): sap.ca.ui.charts.LineChart
Setter for property
data. Default value is empty/undefined
Parameters:
| {any} | oData | new value for property data |
- Deprecated:
- Since version 1.0.0. Please use the binding on 'dataset', do not use as it will be removed in a future release.
Returns:
| {sap.ca.ui.charts.LineChart} | this to allow method chaining |
setDataPath(sDataPath): sap.ca.ui.charts.LineChart
Setter for property
dataPath. Default value is empty/undefined
Parameters:
| {string} | sDataPath | new value for property dataPath |
- Deprecated:
- Since version 1.0.0. Please use the binding on 'dataset', do not use as it will be removed in a future release.
Returns:
| {sap.ca.ui.charts.LineChart} | this to allow method chaining |
setDatasetSettings(oDatasetSettings): sap.ca.ui.charts.LineChart
Setter for property
datasetSettings. Default value is empty/undefined
Parameters:
| {any} | oDatasetSettings | new value for property datasetSettings |
- Deprecated:
- Since version 1.0.0. This is property is not needed any more, do not use as it will be removed in a future release.
Returns:
| {sap.ca.ui.charts.LineChart} | this to allow method chaining |
setMinTouchSize(sMinTouchSize): sap.ca.ui.charts.LineChart
Setter for property
minTouchSize. Default value is 48px
Parameters:
| {string} | sMinTouchSize | new value for property minTouchSize |
- Deprecated:
- Since version 1.0.0. Please use the 'dataLabelFormatter' property, do not use as it will be removed in a future release.
Returns:
| {sap.ca.ui.charts.LineChart} | this to allow method chaining |
setMinTouchWidth(sMinTouchWidth): sap.ca.ui.charts.LineChart
Setter for property
minTouchWidth. Default value is 48px
Parameters:
| {string} | sMinTouchWidth | new value for property minTouchWidth |
- Deprecated:
- Since version 1.0.0. Please use the 'minShapeSize' property, do not use as it will be removed in a future release.
Returns:
| {sap.ca.ui.charts.LineChart} | this to allow method chaining |
setShowLabel(bShowLabel): sap.ca.ui.charts.LineChart
Setter for property
showLabel. Default value is true
Parameters:
| {boolean} | bShowLabel | new value for property showLabel |
- Deprecated:
- Since version 1.0.0. This is a copy of the 'showDataLabel' property, do not use as it will be removed in a future release.
Returns:
| {sap.ca.ui.charts.LineChart} | this to allow method chaining |
setShowScrollContext(bShowScrollContext): sap.ca.ui.charts.LineChart
Setter for property
showScrollContext. Default value is false
Parameters:
| {boolean} | bShowScrollContext | new value for property showScrollContext |
- Deprecated:
- Since version 1.0.0. Feature does not work correctly yet.
Returns:
| {sap.ca.ui.charts.LineChart} | this to allow method chaining |
setUseDelayedResize(bUseDelayedResize): sap.ca.ui.charts.LineChart
Setter for property
useDelayedResize. Default value is false
Parameters:
| {boolean} | bUseDelayedResize | new value for property useDelayedResize |
- Deprecated:
- Since version 1.0.0. Do not use as it will be removed in a future release.
Returns:
| {sap.ca.ui.charts.LineChart} | this to allow method chaining |
setVertical(oVertical): sap.ca.ui.charts.LineChart
Setter for the aggregated
vertical. Parameters:
| {sap.m.VBox} | oVertical |
- Deprecated:
- Since version 1.0.0. Do not use as it will be removed in a future release.
Returns:
| {sap.ca.ui.charts.LineChart} | this to allow method chaining |