VerticalBarChart

extends Chart

Allows you to create a chart using vertical bars to represent the data

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.

Constructor Summary

new sap.ca.ui.charts.VerticalBarChart(sId?, mSettings?)Constructor for a new charts/VerticalBarChart.

Events borrowed from class sap.ca.ui.charts.Chart

popoverAfterOpen, popoverBeforeOpen, selectDataPoint

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.ca.ui.charts.VerticalBarChart.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ca.ui.charts.VerticalBarChart with name sClassName and enriches it with the information contained in oClassInfo.

sap.ca.ui.charts.VerticalBarChart.getMetadata()Returns a metadata object for class sap.ca.ui.charts.VerticalBarChart.

getBarWidth()Getter for property barWidth.

getContainer()Getter for property container.

getData()Getter for property data.

setBarWidth(iBarWidth)Setter for property barWidth.

setContainer(sContainer)Setter for property container.

setData(oData)Setter for property data.

addContent(oContent)Adds some content oContent to the aggregation named content.

destroyContent()Destroys all the content in the aggregation named content.

destroyScroll()Destroys the scroll in the aggregation named scroll.

destroyVerticalArea()Destroys the verticalArea in the aggregation named verticalArea.

destroyVerticalBarChart()Destroys the verticalBarChart in the aggregation named verticalBarChart.

getContent()Getter for aggregation content.

getScroll()Getter for aggregation scroll.

getVerticalArea()Getter for aggregation verticalArea.

getVerticalBarChart()Getter for aggregation verticalBarChart.

indexOfContent(oContent)Checks for the provided sap.ui.core.Control in the aggregation named content and returns its index if found or -1 otherwise.

insertContent(oContent, iIndex)Inserts a content into the aggregation named content.

removeAllContent()Removes all the controls in the aggregation named content.

removeContent(vContent)Removes an content from the aggregation named content.

setScroll(oScroll)Setter for the aggregated scroll.

setVerticalArea(oVerticalArea)Setter for the aggregated verticalArea.

setVerticalBarChart(oVerticalBarChart)Setter for the aggregated verticalBarChart.

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

Methods borrowed from class sap.ui.core.Element

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

attachEvent, attachEventOnce, detachEvent, hasListeners

Constructor Detail

new sap.ca.ui.charts.VerticalBarChart(sId?, mSettings?)

Constructor for a new charts/VerticalBarChart.

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
- data : object
- container : string (default: 'chart')
- barWidth : int (default: 48)
Aggregations
- content : sap.ui.core.Control[]
- scroll : sap.m.ScrollContainer
- verticalBarChart : sap.viz.ui5.Column
- verticalArea : sap.m.VBox
Associations
Events

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.

Method Detail

sap.ca.ui.charts.VerticalBarChart.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.ca.ui.charts.VerticalBarChart 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.VerticalBarChart.getMetadata(): sap.ui.base.Metadata

Returns a metadata object for class sap.ca.ui.charts.VerticalBarChart.

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

getBarWidth(): int

Getter for property barWidth. Minimum shape size for touch enabled actions, default and minimum to 48px !

Default value is 48

Returns:

{int} the value of property barWidth

getContainer(): string

Getter for property container. The DOM ID where the chart will be added. Deprecated

Default value is chart

Returns:

{string} the value of property container

getData(): object

Getter for property data. The data to be used by the chart

Default value is empty/undefined

Returns:

{object} the value of property data

setBarWidth(iBarWidth): sap.ca.ui.charts.VerticalBarChart

Setter for property barWidth.

Default value is 48

Parameters:

{int} iBarWidth new value for property barWidth

Returns:

{sap.ca.ui.charts.VerticalBarChart} this to allow method chaining

setContainer(sContainer): sap.ca.ui.charts.VerticalBarChart

Setter for property container.

Default value is chart

Parameters:

{string} sContainer new value for property container

Returns:

{sap.ca.ui.charts.VerticalBarChart} this to allow method chaining

setData(oData): sap.ca.ui.charts.VerticalBarChart

Setter for property data.

Default value is empty/undefined

Parameters:

{object} oData new value for property data

Returns:

{sap.ca.ui.charts.VerticalBarChart} this to allow method chaining

addContent(oContent): sap.ca.ui.charts.VerticalBarChart

Adds some content oContent to the aggregation named content.

Parameters:

{sap.ui.core.Control}

oContent

the content to add; if empty, nothing is inserted

Deprecated:
Since version 7.20.0. This method is deprecated now.

Returns:

{sap.ca.ui.charts.VerticalBarChart} this to allow method chaining

destroyContent(): sap.ca.ui.charts.VerticalBarChart

Destroys all the content in the aggregation named content.

Deprecated:
Since version 7.20.0. This method is deprecated now.

Returns:

{sap.ca.ui.charts.VerticalBarChart} this to allow method chaining

destroyScroll(): sap.ca.ui.charts.VerticalBarChart

Destroys the scroll in the aggregation named scroll.

Deprecated:
Since version 7.20.0. This method is deprecated now.

Returns:

{sap.ca.ui.charts.VerticalBarChart} this to allow method chaining

destroyVerticalArea(): sap.ca.ui.charts.VerticalBarChart

Destroys the verticalArea in the aggregation named verticalArea.

Deprecated:
Since version 7.20.0. This method is deprecated now.

Returns:

{sap.ca.ui.charts.VerticalBarChart} this to allow method chaining

destroyVerticalBarChart(): sap.ca.ui.charts.VerticalBarChart

Destroys the verticalBarChart in the aggregation named verticalBarChart.

Deprecated:
Since version 7.20.0. This method is deprecated now.

Returns:

{sap.ca.ui.charts.VerticalBarChart} this to allow method chaining

getContent(): sap.ui.core.Control[]

Getter for aggregation content.
Deprecated aggregation. Left for compatibility purposes.

Deprecated:
Since version 7.20.0. This method is deprecated now.

Returns:

{sap.ui.core.Control[]}

getScroll(): sap.m.ScrollContainer

Getter for aggregation scroll.
The scroll container

Deprecated:
Since version 7.20.0. This method is deprecated now.

Returns:

{sap.m.ScrollContainer}

getVerticalArea(): sap.m.VBox

Getter for aggregation verticalArea.
The vertical layout

Deprecated:
Since version 7.20.0. This method is deprecated now.

Returns:

{sap.m.VBox}

getVerticalBarChart(): sap.viz.ui5.Column

Getter for aggregation verticalBarChart.
The chart

Deprecated:
Since version 7.20.0. This method is deprecated now.

Returns:

{sap.viz.ui5.Column}

indexOfContent(oContent): int

Checks for the provided sap.ui.core.Control in the aggregation named content and returns its index if found or -1 otherwise.

Parameters:

{sap.ui.core.Control}

oContent

the content whose index is looked for.

Deprecated:
Since version 7.20.0. This method is deprecated now.

Returns:

{int}

the index of the provided control in the aggregation if found, or -1 otherwise

insertContent(oContent, iIndex): sap.ca.ui.charts.VerticalBarChart

Inserts a content into the aggregation named content.

Parameters:

{sap.ui.core.Control}	oContent	the content to insert; if empty, nothing is inserted
{int}	iIndex	the `0`-based index the content should be inserted at; for a negative value of `iIndex`, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position