Class sap.makit.LayerModule: sap/makit/Layer

extends Element

Layer represent a chart in the CombinationChart

Deprecated API:Since version 1.38. MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control will not be supported anymore from 1.38.


Since: 1.12.
Constructor Summary
new sap.makit.Layer(sId?, mSettings?)Constructor for a new Layer.
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.makit.Layer.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.makit.Layer with name sClassName and enriches it with the information contained in oClassInfo.
sap.makit.Layer.getMetadata()Returns a metadata object for class sap.makit.Layer.
addColumn(oColumn)Adds some column oColumn to the aggregation named columns.
bindColumns(sPath, oTemplate, oSorter, aFilters)Binder for aggregation columns.
bindRows(sPath, oTemplate, oSorter, aFilters)Binder for aggregation rows.
destroyColumns()Destroys all the columns in the aggregation named columns.
destroySeries()Destroys the series in the aggregation named series.
destroyValues()Destroys all the values in the aggregation named values.
getColumns()Getter for aggregation columns.
getDrawOnSecondaryAxis()Getter for property drawOnSecondaryAxis.
getLineThickness()Getter for property lineThickness.
getPrimaryColorPalette()Getter for property primaryColorPalette.
getRows()Getter for aggregation rows.
getSelectedSeries()Get the value of the currently highlighted series
getSeries()Getter for aggregation series.
getType()Getter for property type.
getValues()Getter for aggregation values.
indexOfColumn(oColumn)Checks for the provided sap.makit.Column in the aggregation named columns and returns its index if found or -1 otherwise.
indexOfRow(oRow)Checks for the provided sap.makit.Row in the aggregation named rows and returns its index if found or -1 otherwise.
indexOfValue(oValue)Checks for the provided sap.makit.Value in the aggregation named values and returns its index if found or -1 otherwise.
insertColumn(oColumn, iIndex)Inserts a column into the aggregation named columns.
insertValue(oValue, iIndex)Inserts a value into the aggregation named values.
removeAllColumns()Removes all the controls in the aggregation named columns.
removeAllValues()Removes all the controls in the aggregation named values.
removeColumn(vColumn)Removes an column from the aggregation named columns.
removeValue(vValue)Removes an value from the aggregation named values.
setDrawOnSecondaryAxis(bDrawOnSecondaryAxis)Setter for property drawOnSecondaryAxis.
setLineThickness(fLineThickness)Setter for property lineThickness.
setPrimaryColorPalette(oPrimaryColorPalette)Setter for property primaryColorPalette.
setType(oType)Setter for property type.
unbindColumns()Unbinder for aggregation columns.
unbindRows()Unbinder for aggregation rows.
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, clone, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, init, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, rerender, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, applySettings, 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, invalidate, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.makit.Layer(sId?, mSettings?)
Constructor for a new Layer.

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.ui.core.Element 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.38. MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control will not be supported anymore from 1.38.
Method Detail
sap.makit.Layer.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.makit.Layer 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.makit.Layer.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.makit.Layer.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addColumn(oColumn): sap.makit.Layer
Adds some column oColumn to the aggregation named columns.
Parameters:
{sap.makit.Column}oColumn the column to add; if empty, nothing is inserted
Returns:
{sap.makit.Layer}this to allow method chaining
bindColumns(sPath, oTemplate, oSorter, aFilters): sap.makit.Layer
Binder for aggregation columns.
Parameters:
{string}sPath path to a list in the model
{sap.ui.core.Element}oTemplate the control template for this aggregation
{sap.ui.model.Sorter}oSorter the initial sort order (optional)
{array}aFilters the predefined filters for this aggregation (optional)
Returns:
{sap.makit.Layer}this to allow method chaining
bindRows(sPath, oTemplate, oSorter, aFilters): sap.makit.Layer
Binder for aggregation rows.
Parameters:
{string}sPath path to a list in the model
{sap.ui.core.Element}oTemplate the control template for this aggregation
{sap.ui.model.Sorter}oSorter the initial sort order (optional)
{array}aFilters the predefined filters for this aggregation (optional)
Returns:
{sap.makit.Layer}this to allow method chaining
destroyColumns(): sap.makit.Layer
Destroys all the columns in the aggregation named columns.
Returns:
{sap.makit.Layer}this to allow method chaining
destroySeries(): sap.makit.Layer
Destroys the series in the aggregation named series.
Returns:
{sap.makit.Layer}this to allow method chaining
destroyValues(): sap.makit.Layer
Destroys all the values in the aggregation named values.
Returns:
{sap.makit.Layer}this to allow method chaining
getColumns(): sap.makit.Column[]
Getter for aggregation columns.
The data column map of the chart.
Returns:
{sap.makit.Column[]}
getDrawOnSecondaryAxis(): boolean
Getter for property drawOnSecondaryAxis. Specifiy whether this layer should be drawn on the secondary axis.

Default value is false

Returns:
{boolean} the value of property drawOnSecondaryAxis
getLineThickness(): float
Getter for property lineThickness. Specify the line thickness of the line graph. Only applies to Line chart type.

Default value is 1

Returns:
{float} the value of property lineThickness
getPrimaryColorPalette(): any
Getter for property primaryColorPalette. Allow a layer’s primary axis color palette to be modified without affecting other charts in the same screen. If not set, the chart will use the default color palette defined in the theme. This property will take precedence over other CombinationChart's color palette properties. Accept an array of color in string format or hex format. e.g. 0xff0000 "red" "rgb(255,0,0)"

Default value is empty/undefined

Returns:
{any} the value of property primaryColorPalette
getRows(): sap.makit.Row[]
Getter for aggregation rows.
The data rows of the chart. User should bind these to their data source
Returns:
{sap.makit.Row[]}
getSelectedSeries(): string
Get the value of the currently highlighted series
Returns:
{string}
getSeries(): sap.makit.Series
Getter for aggregation series.
Data region property of the chart's Series
Returns:
{sap.makit.Series}
getType(): sap.makit.ChartType
Getter for property type. Chart type

Default value is Column

Returns:
{sap.makit.ChartType} the value of property type
getValues(): sap.makit.Value[]
Getter for aggregation values.
Data region property of the chart's Values
Returns:
{sap.makit.Value[]}
indexOfColumn(oColumn): int
Checks for the provided sap.makit.Column in the aggregation named columns and returns its index if found or -1 otherwise.
Parameters:
{sap.makit.Column}oColumn the column whose index is looked for.
Returns:
{int} the index of the provided control in the aggregation if found, or -1 otherwise
indexOfRow(oRow): int
Checks for the provided sap.makit.Row in the aggregation named rows and returns its index if found or -1 otherwise.
Parameters:
{sap.makit.Row}oRow the row whose index is looked for.
Returns:
{int} the index of the provided control in the aggregation if found, or -1 otherwise
indexOfValue(oValue): int
Checks for the provided sap.makit.Value in the aggregation named values and returns its index if found or -1 otherwise.
Parameters:
{sap.makit.Value}oValue the value whose index is looked for.
Returns:
{int} the index of the provided control in the aggregation if found, or -1 otherwise
insertColumn(oColumn, iIndex): sap.makit.Layer
Inserts a column into the aggregation named columns.
Parameters:
{sap.makit.Column}oColumn the column to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the column should be inserted at; for a negative value of iIndex, the column is inserted at position 0; for a value greater than the current size of the aggregation, the column is inserted at the last position
Returns:
{sap.makit.Layer}this to allow method chaining
insertValue(oValue, iIndex): sap.makit.Layer
Inserts a value into the aggregation named values.
Parameters:
{sap.makit.Value}oValue the value to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the value should be inserted at; for a negative value of iIndex, the value is inserted at position 0; for a value greater than the current size of the aggregation, the value is inserted at the last position
Returns:
{sap.makit.Layer}this to allow method chaining
removeAllColumns(): sap.makit.Column[]
Removes all the controls in the aggregation named columns.
Additionally unregisters them from the hosting UIArea.
Returns:
{sap.makit.Column[]} an array of the removed elements (might be empty)
removeAllValues(): sap.makit.Value[]
Removes all the controls in the aggregation named values.
Additionally unregisters them from the hosting UIArea.
Returns:
{sap.makit.Value[]} an array of the removed elements (might be empty)
removeColumn(vColumn): sap.makit.Column
Removes an column from the aggregation named columns.
Parameters:
{int|string|sap.makit.Column}vColumn the column to remove or its index or id
Returns:
{sap.makit.Column} the removed column or null
removeValue(vValue): sap.makit.Value
Removes an value from the aggregation named values.
Parameters:
{int|string|sap.makit.Value}vValue the value to remove or its index or id
Returns:
{sap.makit.Value} the removed value or null
setDrawOnSecondaryAxis(bDrawOnSecondaryAxis): sap.makit.Layer
Setter for property drawOnSecondaryAxis.

Default value is false

Parameters:
{boolean}bDrawOnSecondaryAxis new value for property drawOnSecondaryAxis
Returns:
{sap.makit.Layer}this to allow method chaining
setLineThickness(fLineThickness): sap.makit.Layer
Setter for property lineThickness.

Default value is 1

Parameters:
{float}fLineThickness new value for property lineThickness
Returns:
{sap.makit.Layer}this to allow method chaining
setPrimaryColorPalette(oPrimaryColorPalette): sap.makit.Layer
Setter for property primaryColorPalette.

Default value is empty/undefined

Parameters:
{any}oPrimaryColorPalette new value for property primaryColorPalette
Returns:
{sap.makit.Layer}this to allow method chaining
setType(oType): sap.makit.Layer
Setter for property type.

Default value is Column

Parameters:
{sap.makit.ChartType}oType new value for property type
Returns:
{sap.makit.Layer}this to allow method chaining
unbindColumns(): sap.makit.Layer
Unbinder for aggregation columns.
Returns:
{sap.makit.Layer}this to allow method chaining
unbindRows(): sap.makit.Layer
Unbinder for aggregation rows.
Returns:
{sap.makit.Layer}this to allow method chaining