ChartScheme

The ChartScheme control is one of the settings of sap.gantt.GanttChart.

A Gantt chart uses this setting to decide the mode of Gantt chart and the shapes to display in the Gantt chart. A Gantt chart contains one or more Chart schemes. By switching between these schemes, the Gantt chart can display different shapes.

Constructor Summary

new sap.gantt.config.ChartScheme(sId?, mSettings?)Creates and initializes a new ChartScheme class

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers.

Events borrowed from class sap.ui.base.ManagedObject

formatError, modelContextChange, parseError, validationError, validationSuccess

Method Summary

sap.gantt.config.ChartScheme.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.gantt.config.ChartScheme with name sClassName and enriches it with the information contained in oClassInfo.

sap.gantt.config.ChartScheme.getMetadata()Returns a metadata object for class sap.gantt.config.ChartScheme.

getBackgroundClass()Gets current value of property backgroundClass.

getHaveBackground()Gets current value of property haveBackground.

getIcon()Gets current value of property icon.

getKey()Gets current value of property key.

getModeKey()Gets current value of property modeKey.

getName()Gets current value of property name.

getRowSpan()Gets current value of property rowSpan.

getShapeKeys()Gets current value of property shapeKeys.

setBackgroundClass(sBackgroundClass)Sets a new value for property backgroundClass.

setHaveBackground(bHaveBackground)Sets a new value for property haveBackground.

setIcon(sIcon)Sets a new value for property icon.

setKey(sKey)Sets a new value for property key.

setModeKey(sModeKey)Sets a new value for property modeKey.

setName(sName)Sets a new value for property name.

setRowSpan(iRowSpan)Sets a new value for property rowSpan.

setShapeKeys(sShapeKeys)Sets a new value for property shapeKeys.

Methods borrowed from class sap.ui.core.Element

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.gantt.config.ChartScheme(sId?, mSettings?)

Creates and initializes a new ChartScheme class

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

The supported settings are:

Properties
- key : string
- name : string
- rowSpan : int (default: 1)
- icon : sap.ui.core.URI
- modeKey : string (default: sap.gantt.config.DEFAULT_MODE_KEY)
- haveBackground : boolean (default: false)
- backgroundClass : string
- shapeKeys : array (default: [])

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

Method Detail

sap.gantt.config.ChartScheme.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.gantt.config.ChartScheme 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.core.Element.extend.

Parameters:

{string}	sClassName	Name of the class being created
{object}	oClassInfo?	Object literal with information about the class
{function}	FNMetaImpl?	Constructor function for the metadata object; if not given, it defaults to `sap.ui.core.ElementMetadata`

Returns:

{function}

Created class / constructor function

sap.gantt.config.ChartScheme.getMetadata(): sap.ui.base.Metadata

Returns a metadata object for class sap.gantt.config.ChartScheme.

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

getBackgroundClass(): string

Gets current value of property backgroundClass.

Decides the background color of the row in the chart scheme

Returns:

{string} Value of property backgroundClass

getHaveBackground(): boolean

Gets current value of property haveBackground.

Decides whether the shape has a background

Default value is false.

Returns:

{boolean} Value of property haveBackground

getIcon(): sap.ui.core.URI

Gets current value of property icon.

URL of the icon of the Chart scheme

Returns:

{sap.ui.core.URI} Value of property icon

getKey(): string

Gets current value of property key.

Unique key of the Chart scheme

Returns:

{string} Value of property key

getModeKey(): string

Gets current value of property modeKey.

Key of sap.gantt.config.Mode

Default value is sap.gantt.config.DEFAULT_MODE_KEY.

Returns:

{string} Value of property modeKey

getName(): string

Gets current value of property name.

Description of the Chart scheme

Returns:

{string} Value of property name

getRowSpan(): int

Gets current value of property rowSpan.

Decides the row height of sap.gantt.GanttChartBase For example, if rowSpan is 2, the row height of the Gantt chart equals twice of the row height of the tree table

Default value is 1.

Returns:

{int} Value of property rowSpan

getShapeKeys(): array

Gets current value of property shapeKeys.

Array of the key of sap.gantt.config.Shape

Default value is [].

Returns:

{array} Value of property shapeKeys

setBackgroundClass(sBackgroundClass): sap.gantt.config.ChartScheme

Sets a new value for property backgroundClass.

Decides the background color of the row in the chart scheme

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

Parameters:

{string} sBackgroundClass New value for property backgroundClass

Returns:

{sap.gantt.config.ChartScheme} Reference to this in order to allow method chaining

setHaveBackground(bHaveBackground): sap.gantt.config.ChartScheme

Sets a new value for property haveBackground.

Decides whether the shape has a background

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

Default value is false.

Parameters:

{boolean} bHaveBackground New value for property haveBackground

Returns:

{sap.gantt.config.ChartScheme} Reference to this in order to allow method chaining

setIcon(sIcon): sap.gantt.config.ChartScheme

Sets a new value for property icon.

URL of the icon of the Chart scheme

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

Parameters:

{sap.ui.core.URI} sIcon New value for property icon

Returns:

{sap.gantt.config.ChartScheme} Reference to this in order to allow method chaining

setKey(sKey): sap.gantt.config.ChartScheme

Sets a new value for property key.

Unique key of the Chart scheme

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

Parameters:

{string} sKey New value for property key

Returns:

{sap.gantt.config.ChartScheme} Reference to this in order to allow method chaining

setModeKey(sModeKey): sap.gantt.config.ChartScheme

Sets a new value for property modeKey.

Key of sap.gantt.config.Mode

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

Default value is sap.gantt.config.DEFAULT_MODE_KEY.

Parameters:

{string} sModeKey New value for property modeKey

Returns:

{sap.gantt.config.ChartScheme} Reference to this in order to allow method chaining

setName(sName): sap.gantt.config.ChartScheme

Sets a new value for property name.

Description of the Chart scheme

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

Parameters:

{string} sName New value for property name

Returns:

{sap.gantt.config.ChartScheme} Reference to this in order to allow method chaining

setRowSpan(iRowSpan): sap.gantt.config.ChartScheme

Sets a new value for property rowSpan.

Decides the row height of sap.gantt.GanttChartBase For example, if rowSpan is 2, the row height of the Gantt chart equals twice of the row height of the tree table

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

Default value is 1.

Parameters:

{int} iRowSpan New value for property rowSpan

Returns:

{sap.gantt.config.ChartScheme} Reference to this in order to allow method chaining

setShapeKeys(sShapeKeys): sap.gantt.config.ChartScheme

Sets a new value for property shapeKeys.

Array of the key of sap.gantt.config.Shape

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

Default value is [].

Parameters:

{array} sShapeKeys New value for property shapeKeys

Returns:

{sap.gantt.config.ChartScheme} Reference to this in order to allow method chaining