class sap.ui.comp.smartmicrochart.SmartRadialMicroChart

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/comp/smartmicrochart/SmartRadialMicroChart
Application Component: CA-UI5-SC

The SmartRadialMicroChart control creates a sap.suite.ui.microchart.RadialMicroChart based on OData metadata and the configuration specified by mSettings. The entitySet attribute must be specified to use the control. This attribute is used to fetch metadata and annotation information from the given default OData model. Based on this, the RadialMicroChart UI is created.
Note:
Most of the attributes/properties are not dynamic and cannot be changed once the control has been initialized.


Constructor

Constructor for a new sap.ui.comp.smartmicrochart.SmartRadialMicroChart.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.

new sap.ui.comp.smartmicrochart.SmartRadialMicroChart(sId?, mSettings?)
Param Type Default Value Description
sId? string

id for the new control, generated automatically if no id is given

mSettings? object

initial settings for the new control


Properties

Name Type Default Value Description
enableAutoBinding boolean false

If set to true, this enables automatic binding of the chart using the chartBindingPath (if it exists) property.

Visibility: public

Borrowed Properties

Name Type Default Value Description
chartBindingPath string

This property can be used to specify a relative path (without '/') to an entity set (not a single entity) that is used during the binding of the chart.
For example, it can be a navigation property that will be added to the context path.
If not specified, the entitySet property is used instead.

Visibility: public
chartType string

Specifies the type of chart. Note that this property is read-only.

Visibility: public
entitySet string

The OData entity set bound to the smart line micro chart.
This entity set is used to pull data into the micro chart and create its internal representation.
Please note that this property cannot be updated dynamically.

Visibility: public
height sap.ui.core.CSSSize

The height of the chart. Overrides the height specified in the size property.

Visibility: public
isResponsive boolean false

If this set to true, width and height of the control are determined by the width and height of the container in which the control is placed or by the width and height property.

Visibility: public
showLabel boolean true

Determines if any label is shown or not.

Visibility: public
size sap.m.Size Auto

The size of the microchart. If not set, the default size is applied based on the size of the device tile. Responsive size takes width and height of the parent container where the micro chart is included.

Since: 1.62.

Visibility: public
width sap.ui.core.CSSSize

The width of the chart. Overrides the width specified in the size property.

Visibility: public

Associations

Name Cardinality Type Description
freeText 0..1 sap.m.Label

If the associated control is provided, its text property is set to the free text provided by annotations. The Value property of the DataPoint annotation should be annotated with this free text. The Label annotation from the OData Common vocabulary can be used.


Methods Overview

Method Description
sap.ui.comp.smartmicrochart.SmartRadialMicroChart.extend

Creates a new subclass of class sap.ui.comp.smartmicrochart.SmartRadialMicroChart with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.comp.smartmicrochart.SmartMicroChartBase.extend.

getEnableAutoBinding

Gets current value of property enableAutoBinding.

If set to true, this enables automatic binding of the chart using the chartBindingPath (if it exists) property.

Default value is false.

getFreeText

ID of the element which is the current target of the association freeText, or null.

sap.ui.comp.smartmicrochart.SmartRadialMicroChart.getMetadata

Returns a metadata object for class sap.ui.comp.smartmicrochart.SmartRadialMicroChart.

setEnableAutoBinding

Sets a new value for property enableAutoBinding.

If set to true, this enables automatic binding of the chart using the chartBindingPath (if it exists) property.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is false.

setFreeText

Sets the associated freeText.

sap.ui.comp.smartmicrochart.SmartRadialMicroChart.extend

Creates a new subclass of class sap.ui.comp.smartmicrochart.SmartRadialMicroChart with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.comp.smartmicrochart.SmartMicroChartBase.extend.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

getEnableAutoBinding

Gets current value of property enableAutoBinding.

If set to true, this enables automatic binding of the chart using the chartBindingPath (if it exists) property.

Default value is false.

getFreeText

ID of the element which is the current target of the association freeText, or null.

sap.ui.comp.smartmicrochart.SmartRadialMicroChart.getMetadata

Returns a metadata object for class sap.ui.comp.smartmicrochart.SmartRadialMicroChart.

setEnableAutoBinding

Sets a new value for property enableAutoBinding.

If set to true, this enables automatic binding of the chart using the chartBindingPath (if it exists) property.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is false.

Param Type DefaultValue Description
bEnableAutoBinding boolean false

New value for property enableAutoBinding

setFreeText

Sets the associated freeText.

Param Type DefaultValue Description
oFreeText sap.ui.core.ID sap.m.Label

ID of an element which becomes the new target of this freeText association; alternatively, an element instance may be given