Class sap.ca.ui.charts.StackedHorizontalBarChartModule: sap/ca/ui/charts/StackedHorizontalBarChart

extends Chart

Stacked Horizontal Bar Chart wrapper around the viz StackedBarChart / MultipleStackedBarChart. To be used in conjunction with the chart toolbar.

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.StackedHorizontalBarChart(sId?, mSettings?)Constructor for a new charts/StackedHorizontalBarChart.
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.StackedHorizontalBarChart.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ca.ui.charts.StackedHorizontalBarChart with name sClassName and enriches it with the information contained in oClassInfo.
sap.ca.ui.charts.StackedHorizontalBarChart.getMetadata()Returns a metadata object for class sap.ca.ui.charts.StackedHorizontalBarChart.
getDataLabelFormat()Getter for property dataLabelFormat.
setDataLabelFormat(oDataLabelFormat)Setter for property dataLabelFormat.
addContent(oContent)Adds some content oContent to the aggregation named content.
destroyContent()Destroys all the content in the aggregation named content.
getContent()Getter for aggregation content.
getMinTouchSize()Getter for property minTouchSize.
getType()Getter for property type.
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.
setMinTouchSize(sMinTouchSize)Setter for property minTouchSize.
setType(sType)Setter for property type.
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.StackedHorizontalBarChart(sId?, mSettings?)
Constructor for a new charts/StackedHorizontalBarChart.

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
  • Aggregations
  • 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.StackedHorizontalBarChart.extend(sClassName, oClassInfo?, FNMetaImpl?): function
      Creates a new subclass of class sap.ca.ui.charts.StackedHorizontalBarChart 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.StackedHorizontalBarChart.getMetadata(): sap.ui.base.Metadata
      Returns a metadata object for class sap.ca.ui.charts.StackedHorizontalBarChart.
      Returns:
      {sap.ui.base.Metadata} Metadata object describing this class
      getDataLabelFormat(): any
      Getter for property dataLabelFormat. Defines the formater string for the dataLabel value to be diaplyed on the bubble e.g [ [##]]

      Default value is [["##"]]

      Returns:
      {any} the value of property dataLabelFormat
      setDataLabelFormat(oDataLabelFormat): sap.ca.ui.charts.StackedHorizontalBarChart
      Setter for property dataLabelFormat.

      Default value is [["##"]]

      Parameters:
      {any}oDataLabelFormat new value for property dataLabelFormat
      Returns:
      {sap.ca.ui.charts.StackedHorizontalBarChart}this to allow method chaining
      addContent(oContent): sap.ca.ui.charts.StackedHorizontalBarChart
      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 1.16.3.

      content has been deprecated since 1.16.3. The only visible content in the chart now is the internalVizChart.

      Returns:
      {sap.ca.ui.charts.StackedHorizontalBarChart}this to allow method chaining
      destroyContent(): sap.ca.ui.charts.StackedHorizontalBarChart
      Destroys all the content in the aggregation named content.
      Deprecated:
      Since version 1.16.3.

      content has been deprecated since 1.16.3. The only visible content in the chart now is the internalVizChart.

      Returns:
      {sap.ca.ui.charts.StackedHorizontalBarChart}this to allow method chaining
      getContent(): sap.ui.core.Control[]
      Getter for aggregation content.
      Deprecated aggregation. Left for compatibility purposes.
      Deprecated:
      Since version 1.16.3.

      content has been deprecated since 1.16.3. The only visible content in the chart now is the internalVizChart.

      Returns:
      {sap.ui.core.Control[]}
      getMinTouchSize(): sap.ui.core.CSSSize
      Getter for property minTouchSize. Mapped to minShapeSize property.

      Default value is 48px

      Deprecated:
      Since version 1.16.3.

      minTouchSize has been deprecated since 1.16.3. Please use the minShapeSize instead.

      Returns:
      {sap.ui.core.CSSSize} the value of property minTouchSize
      getType(): string
      Getter for property type. Mapped to charType property.

      Default value is StackedBar

      Deprecated:
      Since version 1.16.3.

      type has been deprecated since 1.16.3. Please use the chartType instead.

      Returns:
      {string} the value of property type
      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 1.16.3.

      content has been deprecated since 1.16.3. The only visible content in the chart now is the internalVizChart.

      Returns:
      {int} the index of the provided control in the aggregation if found, or -1 otherwise
      insertContent(oContent, iIndex): sap.ca.ui.charts.StackedHorizontalBarChart
      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
      Deprecated:
      Since version 1.16.3.

      content has been deprecated since 1.16.3. The only visible content in the chart now is the internalVizChart.

      Returns:
      {sap.ca.ui.charts.StackedHorizontalBarChart}this to allow method chaining
      removeAllContent(): sap.ui.core.Control[]
      Removes all the controls in the aggregation named content.
      Additionally unregisters them from the hosting UIArea.
      Deprecated:
      Since version 1.16.3.

      content has been deprecated since 1.16.3. The only visible content in the chart now is the internalVizChart.

      Returns:
      {sap.ui.core.Control[]} an array of the removed elements (might be empty)
      removeContent(vContent): sap.ui.core.Control
      Removes an content from the aggregation named content.
      Parameters:
      {int|string|sap.ui.core.Control}vContent the content to remove or its index or id
      Deprecated:
      Since version 1.16.3.

      content has been deprecated since 1.16.3. The only visible content in the chart now is the internalVizChart.

      Returns:
      {sap.ui.core.Control} the removed content or null
      setMinTouchSize(sMinTouchSize): sap.ca.ui.charts.StackedHorizontalBarChart
      Setter for property minTouchSize.

      Default value is 48px

      Parameters:
      {sap.ui.core.CSSSize}sMinTouchSize new value for property minTouchSize
      Deprecated:
      Since version 1.16.3.

      minTouchSize has been deprecated since 1.16.3. Please use the minShapeSize instead.

      Returns:
      {sap.ca.ui.charts.StackedHorizontalBarChart}this to allow method chaining
      setType(sType): sap.ca.ui.charts.StackedHorizontalBarChart
      Setter for property type.

      Default value is StackedBar

      Parameters:
      {string}sType new value for property type
      Deprecated:
      Since version 1.16.3.

      type has been deprecated since 1.16.3. Please use the chartType instead.

      Returns:
      {sap.ca.ui.charts.StackedHorizontalBarChart}this to allow method chaining