TimeAxis

Defines the time axis of a Gantt chart

Constructor Summary

new sap.gantt.config.TimeAxis(sId?, mSettings?)Creates and initializes a new time axis

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.TimeAxis.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.gantt.config.TimeAxis with name sClassName and enriches it with the information contained in oClassInfo.

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

getCoarsestGranularity()Gets current value of property coarsestGranularity.

getFinestGranularity()Gets current value of property finestGranularity.

getGranularity()Gets current value of property granularity.

getInitHorizon()Gets current value of property initHorizon.

getPlanHorizon()Gets current value of property planHorizon.

getRate()Gets current value of property rate.

getZoomStrategy()Gets current value of property zoomStrategy.

setCoarsestGranularity(sCoarsestGranularity)Sets a new value for property coarsestGranularity.

setFinestGranularity(sFinestGranularity)Sets a new value for property finestGranularity.

setGranularity(sGranularity)Sets a new value for property granularity.

setInitHorizon(sInitHorizon)Sets a new value for property initHorizon.

setPlanHorizon(sPlanHorizon)Sets a new value for property planHorizon.

setRate(fRate)Sets a new value for property rate.

setZoomStrategy(oZoomStrategy)Sets a new value for property zoomStrategy.

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.TimeAxis(sId?, mSettings?)

Creates and initializes a new time axis

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
- planHorizon : sap.gantt.config.TimeHorizon (default: sap.gantt.config.DEFAULT_PLAN_HORIZON)
- initHorizon : sap.gantt.config.TimeHorizon (default: sap.gantt.config.DEFAULT_INIT_HORIZON)
- zoomStrategy : object (default: sap.gantt.config.DEFAULT_TIME_ZOOM_STRATEGY)
- granularity : string (default: 4day)
- finestGranularity : string (default: 5min)
- coarsestGranularity : string (default: 1month)
- rate : float (default: 1)

In addition, all settings applicable to the base type sap.ui.core.Element can be used as well.

Parameters:

{string}	sId?	ID of the new control, generated automatically if no ID is given
{object}	mSettings?	Initial settings for the new control

Method Detail

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

Creates a new subclass of class sap.gantt.config.TimeAxis 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.TimeAxis.getMetadata(): sap.ui.base.Metadata

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

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

getCoarsestGranularity(): string

Gets current value of property coarsestGranularity.

Granularity when the GanttChart is zoomed out to the minimum

Default value is 1month.

Returns:

{string} Value of property coarsestGranularity

getFinestGranularity(): string

Gets current value of property finestGranularity.

Granularity when the Gantt chart is zoomed in to the maximum

Default value is 5min.

Returns:

{string} Value of property finestGranularity

getGranularity(): string

Gets current value of property granularity.

Initial granularity of the time axis

Default value is 4day.

Returns:

{string} Value of property granularity

getInitHorizon(): sap.gantt.config.TimeHorizon

Gets current value of property initHorizon.

Time horizon which is displayed after the Gantt chart is initialized

Default value is sap.gantt.config.DEFAULT_INIT_HORIZON.

Returns:

{sap.gantt.config.TimeHorizon} Value of property initHorizon

getPlanHorizon(): sap.gantt.config.TimeHorizon

Gets current value of property planHorizon.

Whole time horizon of the Gantt chart

Default value is sap.gantt.config.DEFAULT_PLAN_HORIZON.

Returns:

{sap.gantt.config.TimeHorizon} Value of property planHorizon

getRate(): float

Gets current value of property rate.

Zoom rate of the Gantt chart

Default value is 1.

Returns:

{float} Value of property rate

getZoomStrategy(): object

Gets current value of property zoomStrategy.

Zoom strategy of the Gantt chart See sap.gantt.config.DEFAULT_TIME_ZOOM_STRATEGY as example

Default value is sap.gantt.config.DEFAULT_TIME_ZOOM_STRATEGY.

Returns:

{object} Value of property zoomStrategy

setCoarsestGranularity(sCoarsestGranularity): sap.gantt.config.TimeAxis

Sets a new value for property coarsestGranularity.

Granularity when the GanttChart is zoomed out to the minimum

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

Default value is 1month.

Parameters:

{string} sCoarsestGranularity New value for property coarsestGranularity

Returns:

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

setFinestGranularity(sFinestGranularity): sap.gantt.config.TimeAxis

Sets a new value for property finestGranularity.

Granularity when the Gantt chart is zoomed in to the maximum

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

Default value is 5min.

Parameters:

{string} sFinestGranularity New value for property finestGranularity

Returns:

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

setGranularity(sGranularity): sap.gantt.config.TimeAxis

Sets a new value for property granularity.

Initial granularity of the time axis

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

Default value is 4day.

Parameters:

{string} sGranularity New value for property granularity

Returns:

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

setInitHorizon(sInitHorizon): sap.gantt.config.TimeAxis

Sets a new value for property initHorizon.

Time horizon which is displayed after the Gantt chart is initialized

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_INIT_HORIZON.

Parameters:

{sap.gantt.config.TimeHorizon} sInitHorizon New value for property initHorizon

Returns:

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

setPlanHorizon(sPlanHorizon): sap.gantt.config.TimeAxis

Sets a new value for property planHorizon.

Whole time horizon of the Gantt chart

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_PLAN_HORIZON.

Parameters:

{sap.gantt.config.TimeHorizon} sPlanHorizon New value for property planHorizon

Returns:

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

setRate(fRate): sap.gantt.config.TimeAxis

Sets a new value for property rate.

Zoom rate of the Gantt chart

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

Default value is 1.

Parameters:

{float} fRate New value for property rate

Returns:

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

setZoomStrategy(oZoomStrategy): sap.gantt.config.TimeAxis

Sets a new value for property zoomStrategy.

Zoom strategy of the Gantt chart See sap.gantt.config.DEFAULT_TIME_ZOOM_STRATEGY as example

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_TIME_ZOOM_STRATEGY.

Parameters:

{object} oZoomStrategy New value for property zoomStrategy

Returns:

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