Class sap.ca.ui.charts.HorizontalBarChartModule: sap/ca/ui/charts/HorizontalBarChart

extends Chart

Allows you to create a chart using horizontal 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.HorizontalBarChart(sId?, mSettings?)Constructor for a new charts/HorizontalBarChart.
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.HorizontalBarChart.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ca.ui.charts.HorizontalBarChart with name sClassName and enriches it with the information contained in oClassInfo.
sap.ca.ui.charts.HorizontalBarChart.getMetadata()Returns a metadata object for class sap.ca.ui.charts.HorizontalBarChart.
destroyHorizontalBarChart()Destroys the horizontalBarChart in the aggregation named horizontalBarChart.
getBarHeight()Getter for property barHeight.
getContainer()Getter for property container.
getData()Getter for property data.
getHorizontalBarChart()Getter for aggregation horizontalBarChart.
setBarHeight(iBarHeight)Setter for property barHeight.
setContainer(sContainer)Setter for property container.
setData(oData)Setter for property data.
setHorizontalBarChart(oHorizontalBarChart)Setter for the aggregated horizontalBarChart.
destroyScroll()Destroys the scroll in the aggregation named scroll.
destroyVerticalArea()Destroys the verticalArea in the aggregation named verticalArea.
getScroll()Getter for aggregation scroll.
getVerticalArea()Getter for aggregation verticalArea.
setScroll(oScroll)Setter for the aggregated scroll.
setVerticalArea(oVerticalArea)Setter for the aggregated verticalArea.
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
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.ca.ui.charts.HorizontalBarChart(sId?, mSettings?)
Constructor for a new charts/HorizontalBarChart.

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:

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.HorizontalBarChart.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ca.ui.charts.HorizontalBarChart 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.HorizontalBarChart.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ca.ui.charts.HorizontalBarChart.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
destroyHorizontalBarChart(): sap.ca.ui.charts.HorizontalBarChart
Destroys the horizontalBarChart in the aggregation named horizontalBarChart.
Returns:
{sap.ca.ui.charts.HorizontalBarChart}this to allow method chaining
getBarHeight(): int
Getter for property barHeight. Minimum shape size for touch enabled actions, default and minimum to 48px !

Default value is 48

Returns:
{int} the value of property barHeight
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
getHorizontalBarChart(): sap.viz.ui5.Bar
Getter for aggregation horizontalBarChart.
The internal chart
Returns:
{sap.viz.ui5.Bar}
setBarHeight(iBarHeight): sap.ca.ui.charts.HorizontalBarChart
Setter for property barHeight.

Default value is 48

Parameters:
{int}iBarHeight new value for property barHeight
Returns:
{sap.ca.ui.charts.HorizontalBarChart}this to allow method chaining
setContainer(sContainer): sap.ca.ui.charts.HorizontalBarChart
Setter for property container.

Default value is chart

Parameters:
{string}sContainer new value for property container
Returns:
{sap.ca.ui.charts.HorizontalBarChart}this to allow method chaining
setData(oData): sap.ca.ui.charts.HorizontalBarChart
Setter for property data.

Default value is empty/undefined

Parameters:
{object}oData new value for property data
Returns:
{sap.ca.ui.charts.HorizontalBarChart}this to allow method chaining
setHorizontalBarChart(oHorizontalBarChart): sap.ca.ui.charts.HorizontalBarChart
Setter for the aggregated horizontalBarChart.
Parameters:
{sap.viz.ui5.Bar}oHorizontalBarChart
Returns:
{sap.ca.ui.charts.HorizontalBarChart}this to allow method chaining
destroyScroll(): sap.ca.ui.charts.HorizontalBarChart
Destroys the scroll in the aggregation named scroll.
Deprecated:
Since version 7.20.0. This method is deprecated now.
Returns:
{sap.ca.ui.charts.HorizontalBarChart}this to allow method chaining
destroyVerticalArea(): sap.ca.ui.charts.HorizontalBarChart
Destroys the verticalArea in the aggregation named verticalArea.
Deprecated:
Since version 7.20.0. This method is deprecated now.
Returns:
{sap.ca.ui.charts.HorizontalBarChart}this to allow method chaining
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 area within the scroll container
Deprecated:
Since version 7.20.0. This method is deprecated now.
Returns:
{sap.m.VBox}
setScroll(oScroll): sap.ca.ui.charts.HorizontalBarChart
Setter for the aggregated scroll.
Parameters:
{sap.m.ScrollContainer}oScroll
Deprecated:
Since version 7.20.0. This method is deprecated now.
Returns:
{sap.ca.ui.charts.HorizontalBarChart}this to allow method chaining
setVerticalArea(oVerticalArea): sap.ca.ui.charts.HorizontalBarChart
Setter for the aggregated verticalArea.
Parameters:
{sap.m.VBox}oVerticalArea
Deprecated:
Since version 7.20.0. This method is deprecated now.
Returns:
{sap.ca.ui.charts.HorizontalBarChart}this to allow method chaining