Namespace sap.gantt.configModule: sap/gantt/library

Namespace sap.gantt.config provides all configuration related objects and default configuration value for optional ones.

Namespaces & Classes
ChartSchemeThe ChartScheme control is one of the settings of sap.gantt.GanttChart.
ColumnAttributeDefines the column attribute which is used in the hierarchy column
ContainerLayoutDefines the container layout.
ExpandChartDefines the expand chart which is used by sap.gantt.config.ExpandChartGroup.
ExpandChartGroupDefines a toolbar group for the expand chart-related toolbar items.
GanttChartLayoutDefines the Gantt chart layout.
HierarchyDefines the hierarchy in the Gantt chart.
HierarchyColumnDefines the column attribute which is used in the hierarchy column
LayoutGroupYou can specify the Gantt chart layout-related toolbar items in the Gantt chart toolbar
LocaleThe locale control is used for converting the UTC date time to your local date time
ModeThe Mode control specifies the mode which is used in GanttChart and Shape.
ModeGroupThe ModeGroup control specifies the mode-related buttons in the Gantt chart toolbar
ObjectTypeDefine the ObjectType which is used in GanttChart
SettingGroupThe SettingGroup control allows you to specify the number of setting items to display in the Setting window.
SettingItemThe SettingItem control allows you to create a setting item in the toolbar, which is presented as a checkbox with a label.
ShapeConfiguration object for Shape.
TimeAxisDefines the time axis of a Gantt chart
TimeHorizonDefines the Time horizon
TimeUnitDifferent time units used as part of the zoom level.
TimeZoomGroupYou can specify the Gantt chart Time zooming related toolbar items in the Gantt chart toolbar
ToolbarGroupDefines the toolbar group.
ToolbarSchemeDefines the Toolbar scheme
Field Summary
sap.gantt.config.DEFAULT_CHART_SCHEMEDefines the default configuration chart scheme.
sap.gantt.config.DEFAULT_CHART_SCHEME_KEYDefines the default chart scheme key.
sap.gantt.config.DEFAULT_CHART_SCHEMESDefines the default list of chart schemes.
sap.gantt.config.DEFAULT_CONTAINER_DUAL_LAYOUTDefines the default configuration object for Dual Container layout.
sap.gantt.config.DEFAULT_CONTAINER_DUAL_LAYOUT_KEYDefines the default Gantt dual-view layout key.
sap.gantt.config.DEFAULT_CONTAINER_LAYOUTSDefines the default list of Container layouts.
sap.gantt.config.DEFAULT_CONTAINER_SINGLE_LAYOUTDefines the default configuration object for the Single Container layout.
sap.gantt.config.DEFAULT_CONTAINER_SINGLE_LAYOUT_KEYDefines the default Gantt single layout key.
sap.gantt.config.DEFAULT_CONTAINER_TOOLBAR_SCHEMEDefines the default configuration object for toolbar scheme on sap.gantt.GanttChartContainer.
sap.gantt.config.DEFAULT_CONTAINER_TOOLBAR_SCHEME_KEYDefines the default toolbar scheme key for GanttContainer.
sap.gantt.config.DEFAULT_CONTAINER_TOOLBAR_SCHEMESDefine default list of toolbar schemes for sap.gantt.GanttChartContainer.
sap.gantt.config.DEFAULT_EMPTY_OBJECTDefines the default empty JSON object.
sap.gantt.config.DEFAULT_GANTTCHART_TOOLBAR_SCHEMEDefines the default configuration object for the toolbar scheme on sap.gantt.GanttChartWithTable.
sap.gantt.config.DEFAULT_GANTTCHART_TOOLBAR_SCHEME_KEYDefines the default toolbar scheme key for GanttWithTable.
sap.gantt.config.DEFAULT_GANTTCHART_TOOLBAR_SCHEMESDefines the default list of toolbar schemes for sap.gantt.GanttChartBase.
sap.gantt.config.DEFAULT_HIERARCHYDefines the default configuration object for Hierarchy.
sap.gantt.config.DEFAULT_HIERARCHY_KEYDefines the default hierarchy key.
sap.gantt.config.DEFAULT_HIERARCHYSDefines the default list of hierarchies.
sap.gantt.config.DEFAULT_INIT_HORIZONDefines the default configuration initHorizon.
sap.gantt.config.DEFAULT_LOCALE_CETDefines the default configuration object Locale.
sap.gantt.config.DEFAULT_MODEDefines the default configuration mode.
sap.gantt.config.DEFAULT_MODE_KEYDefines the default mode key.
sap.gantt.config.DEFAULT_MODESDefines the default list of configuration modes.
sap.gantt.config.DEFAULT_OBJECT_TYPEDefines the default configuration object type.
sap.gantt.config.DEFAULT_OBJECT_TYPE_KEYDefines the default object type key.
sap.gantt.config.DEFAULT_OBJECT_TYPESDefines the default list of object types.
sap.gantt.config.DEFAULT_PLAN_HORIZONDefines the default configuration planHorizon.
sap.gantt.config.DEFAULT_TIME_AXISDefines the default configuration for the time axis.
sap.gantt.config.DEFAULT_TIME_ZOOM_STRATEGYDefines the default configuration of the time zoom level.
sap.gantt.config.DEFAULT_TOOLBAR_SETTING_ITEMSDefines the default configuration object for setting groups in the toolbar.
sap.gantt.config.EMPTY_TOOLBAR_SCHEMEDefines the default empty toolbar scheme.
sap.gantt.config.EMPTY_TOOLBAR_SCHEME_KEYDefines the default empty toolbar scheme key.
sap.gantt.config.SETTING_ITEM_ENABLE_CURSOR_LINEDefines the default configuration object for enabling the cursor line setting items.
sap.gantt.config.SETTING_ITEM_ENABLE_CURSOR_LINE_KEYDefines the default setting item key for the cursor line.
sap.gantt.config.SETTING_ITEM_ENABLE_NOW_LINEDefines the default configuration object for enabling the present time indicator setting item.
sap.gantt.config.SETTING_ITEM_ENABLE_NOW_LINE_KEYDefines the default setting item key for the present time indicator.
sap.gantt.config.SETTING_ITEM_ENABLE_TIME_SCROLL_SYNCDefines the default configuration object for enabling the synchronized time scroll setting item.
sap.gantt.config.SETTING_ITEM_ENABLE_TIME_SCROLL_SYNC_KEYDefines the default setting item key for synchronized time scroll.
sap.gantt.config.SETTING_ITEM_ENABLE_VERTICAL_LINEDefines the default configuration object for enabling vertical line setting item.
sap.gantt.config.SETTING_ITEM_ENABLE_VERTICAL_LINE_KEYDefines the default setting item key for the vertical lines.
Field Detail
sap.gantt.config.DEFAULT_CHART_SCHEME: object
Defines the default configuration chart scheme.

Default values:

  • key - sap.gantt.config.DEFAULT_CHART_SCHEME_KEY
  • name - "Default"
  • rowSpan - 1
  • icon - null
  • modeKey - sap.gantt.config.DEFAULT_MODE_KEY
  • shapeKeys - []
sap.gantt.config.DEFAULT_CHART_SCHEME_KEY: string
Defines the default chart scheme key.

The Default Chart Scheme Key is used in the default chart scheme configuration.

sap.gantt.config.DEFAULT_CHART_SCHEMES: array
Defines the default list of chart schemes.

Default values is sap.gantt.config.DEFAULT_CHART_SCHEME

sap.gantt.config.DEFAULT_CONTAINER_DUAL_LAYOUT: object
Defines the default configuration object for Dual Container layout.

Default values:

  • key - sap.gantt.config.DEFAULT_CONTAINER_DUAL_LAYOUT_KEY
  • text - "Dual Gantt Chart Layout"
  • toolbarSchemeKey - sap.gantt.config.DEFAULT_CONTAINER_TOOLBAR_SCHEME_KEY
  • ganttChartLayouts - [new sap.gantt.config.GanttChartLayout({ activeModeKey: sap.gantt.config.DEFAULT_MODE_KEY, hierarchyKey: sap.gantt.config.DEFAULT_HIERARCHY_KEY }), new sap.gantt.config.GanttChartLayout({ activeModeKey: sap.gantt.config.DEFAULT_MODE_KEY, hierarchyKey: sap.gantt.config.DEFAULT_HIERARCHY_KEY })]
sap.gantt.config.DEFAULT_CONTAINER_DUAL_LAYOUT_KEY: string
Defines the default Gantt dual-view layout key.

The default Gantt dual-view layout key is used in the default Gantt dual layout configuration.

sap.gantt.config.DEFAULT_CONTAINER_LAYOUTS: array
Defines the default list of Container layouts.

Default values are a single-view layout and a dual-view layout.

sap.gantt.config.DEFAULT_CONTAINER_SINGLE_LAYOUT: object
Defines the default configuration object for the Single Container layout.

Default values:

  • key - sap.gantt.config.DEFAULT_CONTAINER_SINGLE_LAYOUT_KEY
  • text - "Single Gantt Chart Layout"
  • toolbarSchemeKey - sap.gantt.config.DEFAULT_CONTAINER_TOOLBAR_SCHEME_KEY
  • ganttChartLayouts - [new sap.gantt.config.GanttChartLayout({ activeModeKey: sap.gantt.config.DEFAULT_MODE_KEY, hierarchyKey: sap.gantt.config.DEFAULT_HIERARCHY_KEY })]
sap.gantt.config.DEFAULT_CONTAINER_SINGLE_LAYOUT_KEY: string
Defines the default Gantt single layout key.

The default Gantt single layout key is used in the default Gantt single layout configuration.

sap.gantt.config.DEFAULT_CONTAINER_TOOLBAR_SCHEME: object
Defines the default configuration object for toolbar scheme on sap.gantt.GanttChartContainer.

Default values:

  • key - sap.gantt.config.DEFAULT_CONTAINER_TOOLBAR_SCHEME_KEY
  • customToolbarItems - sap.gantt.config.ToolbarGroup({ position: "L1", overflowPriority: sap.m.OverflowToolbarPriority.High })
  • timeZoom - sap.gantt.config.ToolbarGroup({ position: "R2", overflowPriority: sap.m.OverflowToolbarPriority.NeverOverflow })
  • settings - sap.gantt.config.ToolbarGroup({ position: "R1", overflowPriority: sap.m.OverflowToolbarPriority.low, items: sap.gantt.config.DEFAULT_TOOLBAR_SETTING_ITEMS })
sap.gantt.config.DEFAULT_CONTAINER_TOOLBAR_SCHEME_KEY: string
Defines the default toolbar scheme key for GanttContainer.

The default GanttContainer toolbar scheme key is used in the default GanttContainer toolbar scheme configuration.

sap.gantt.config.DEFAULT_CONTAINER_TOOLBAR_SCHEMES: array
Define default list of toolbar schemes for sap.gantt.GanttChartContainer.

The default values include an empty toolbar and a default Gantt Chart Container toolbar.

sap.gantt.config.DEFAULT_EMPTY_OBJECT: object
Defines the default empty JSON object.
sap.gantt.config.DEFAULT_GANTTCHART_TOOLBAR_SCHEME: object
Defines the default configuration object for the toolbar scheme on sap.gantt.GanttChartWithTable.

Default values:

  • key - sap.gantt.config.DEFAULT_GANTTCHART_TOOLBAR_SCHEME_KEY
  • customToolbarItems - sap.gantt.config.ToolbarGroup({ position: "L2", overflowPriority: sap.m.OverflowToolbarPriority.High })
  • expandTree - sap.gantt.config.ToolbarGroup({ position: "L3", overflowPriority: sap.m.OverflowToolbarPriority.Low })
sap.gantt.config.DEFAULT_GANTTCHART_TOOLBAR_SCHEME_KEY: string
Defines the default toolbar scheme key for GanttWithTable.

The default GanttWithTable toolbar scheme key is used in the default GanttWithTable toolbar scheme configuration.

sap.gantt.config.DEFAULT_GANTTCHART_TOOLBAR_SCHEMES: array
Defines the default list of toolbar schemes for sap.gantt.GanttChartBase.

The default values include an empty toolbar and a default Gantt Chart toolbar.

sap.gantt.config.DEFAULT_HIERARCHY: object
Defines the default configuration object for Hierarchy.

Default values:

  • key - sap.gantt.config.DEFAULT_HIERARCHY_KEY
  • text - "Default Hierarchy"
  • activeModeKey - sap.gantt.config.DEFAULT_MODE_KEY
  • toolbarSchemeKey - sap.gantt.config.DEFAULT_GANTTCHART_TOOLBAR_SCHEME_KEY
  • columns - null
  • expandedLevels - null
sap.gantt.config.DEFAULT_HIERARCHY_KEY: string
Defines the default hierarchy key.

The default hierarchy key is used in the default hierarchy configuration.

sap.gantt.config.DEFAULT_HIERARCHYS: array
Defines the default list of hierarchies.

The default value is sap.gantt.config.DEFAULT_HIERARCHY

sap.gantt.config.DEFAULT_INIT_HORIZON
Defines the default configuration initHorizon.

From one month ago, to one month from now.

sap.gantt.config.DEFAULT_LOCALE_CET: object
Defines the default configuration object Locale.

Default values

  • timeZoine - "CET"
  • utcdiff - "000000"
  • utcsign - "+"
sap.gantt.config.DEFAULT_MODE: object
Defines the default configuration mode.

Default values are:

  • key - sap.gantt.config.DEFAULT_MODE_KEY
  • text - "Default"
  • icon - "sap-icon://status-positive"
sap.gantt.config.DEFAULT_MODE_KEY: string
Defines the default mode key.

The default mode key is used in Gantt and the default mode configuration is used when no mode configuration is provided.

sap.gantt.config.DEFAULT_MODES: array
Defines the default list of configuration modes.

Default value: sap.gantt.config.DEFAULT_MODE.

sap.gantt.config.DEFAULT_OBJECT_TYPE: object
Defines the default configuration object type.

Default values:

  • key - sap.gantt.config.DEFAULT_OBJECT_TYPE_KEY
  • description - "Default"
  • mainChartSchemeKey - sap.gantt.config.DEFAULT_CHART_SCHEME_KEY
  • expandedChartSchemeKeys - []
sap.gantt.config.DEFAULT_OBJECT_TYPE_KEY: string
Defines the default object type key.

Default object type key is used in the default object type configuration.

sap.gantt.config.DEFAULT_OBJECT_TYPES: array
Defines the default list of object types.

The default value is sap.gantt.config.DEFAULT_OBJECT_TYPE.

sap.gantt.config.DEFAULT_PLAN_HORIZON
Defines the default configuration planHorizon.

From one year ago, to one year from now.

sap.gantt.config.DEFAULT_TIME_AXIS
Defines the default configuration for the time axis.

Default values are:

  • planHorizon - sap.gantt.config.DEFAULT_PLAN_HORIZON
  • initHorizon - sap.gantt.config.DEFAULT_INIT_HORIZON
  • zoomStrategy - sap.gantt.config.DEFAULT_TIME_ZOOM_STRATEGY
  • finestGranularity - "15min"
  • coarsestGranularity - "6month"
  • rate> - 1
sap.gantt.config.DEFAULT_TIME_ZOOM_STRATEGY
Defines the default configuration of the time zoom level.

The default time zoom level includes a granularity factor that determines the length of the interval between neighboring vertical lines.

The time zoom level now is a JSON object with the granularity as the key and some internal information such as formatting. Each level has 3 interval objects describing the time unit, the time span, and the jump condition to the next level. The zoom level decides how the time axis behaves and how ticks are displayed.

Take "12hour" level for example

  • "12hour": - Granularity level ID.
    • "innerInterval" - Time interval between neighboring vertical lines is 12 hours. The jump condition to the next level is "1day" when the interval exceeds 90 pixels.
      • "unit": sap.gantt.config.TimeUnit.hour - Time unit is hour.
      • "span": 12 - Span is 12.
      • "range": 90 - Jumping condition is 90 pixels between neighboring vertical lines.
    • largeInterval - Time interval of top row along the time axis is 1 day. Formatted in the locale language with the format string. This zoom level implements an interval larger than the interval in the default zoom level.
      • "unit": sap.gantt.config.TimeUnit.day -
      • "span": 1 - Time span is 1.
      • "format": "cccc dd.M.yyyy" - Formats the string in CLDR date/time symbols.
    • smallInterval - Time interval of the bottom row along the time axis is 12 hours. Formatted in the locale language with the format string. This zoom level implements an interval the same as the interval in the default zoom level.
      • "unit": sap.gantt.config.TimeUnit.hour - Time unit is hour.
      • "span": 12 - Time span is 12.
      • "format": "HH:mm" - Formats the string in CLDR date/time symbols.

The current granularity setting provides the following values in the default time zoom level:
5min, 10min, 15min, 30min,
1hour, 2hour, 4hour, 6hour, 12hour,
1day, 2day, 4day,
1week, 2week,
1month, 2month, 4month, 6month,
1year, 2year, 5year.

sap.gantt.config.DEFAULT_TOOLBAR_SETTING_ITEMS: array
Defines the default configuration object for setting groups in the toolbar.

Default values:

  • sap.gantt.config.SETTING_ITEM_ENABLE_NOW_LINE
  • sap.gantt.config.SETTING_ITEM_ENABLE_CURSOR_LINE
  • sap.gantt.config.SETTING_ITEM_ENABLE_VERTICAL_LINE
  • sap.gantt.config.SETTING_ITEM_ENABLE_TIME_SCROLL_SYNC
sap.gantt.config.EMPTY_TOOLBAR_SCHEME: object
Defines the default empty toolbar scheme.

This toolbar scheme has no built-in toolbar items. Only one toolbar group customToolbarItems is configured to allow applications to place custom toolbar items. Default values:

  • key - sap.gantt.config.EMPTY_TOOLBAR_SCHEME_KEY
  • customToolbarItems - sap.gantt.config.ToolbarGroup({ position: "L1", overflowPriority: sap.m.OverflowToolbarPriority.High })
sap.gantt.config.EMPTY_TOOLBAR_SCHEME_KEY: string
Defines the default empty toolbar scheme key.

The default empty toolbar scheme key is used in the default empty toolbar scheme.

sap.gantt.config.SETTING_ITEM_ENABLE_CURSOR_LINE: object
Defines the default configuration object for enabling the cursor line setting items. Default values:
  • key - sap.gantt.config.SETTING_ITEM_ENABLE_CURSOR_LINE_KEY
  • checked - true
  • displayText - "Show Cursor Line"
  • tooltip - "Show a Vertical Line that Follows the Mouse Pointer"
sap.gantt.config.SETTING_ITEM_ENABLE_CURSOR_LINE_KEY: string
Defines the default setting item key for the cursor line.

Default setting item key for the cursor line is used in the default settings group configuration.

sap.gantt.config.SETTING_ITEM_ENABLE_NOW_LINE: object
Defines the default configuration object for enabling the present time indicator setting item. Default values:
  • key - sap.gantt.config.SETTING_ITEM_ENABLE_NOW_LINE_KEY
  • checked - true
  • displayText - "Indicate Current Time"
  • tooltip - "Draw a Vertical Line to Indicate the Current Time"
sap.gantt.config.SETTING_ITEM_ENABLE_NOW_LINE_KEY: string
Defines the default setting item key for the present time indicator.

Default setting item key for the present time indicator is used in the default settings group configuration.

sap.gantt.config.SETTING_ITEM_ENABLE_TIME_SCROLL_SYNC: object
Defines the default configuration object for enabling the synchronized time scroll setting item. Default values are:
  • key - sap.gantt.config.SETTING_ITEM_ENABLE_TIME_SCROLL_SYNC_KEY
  • checked - true
  • displayText - "Synchronize Time Scroll"
  • tooltip - "Synchronize Horizontal Scroll Bars in Chart"
sap.gantt.config.SETTING_ITEM_ENABLE_TIME_SCROLL_SYNC_KEY: string
Defines the default setting item key for synchronized time scroll.

Default setting item key for synchronized time scroll is used in the default settings group configuration.

sap.gantt.config.SETTING_ITEM_ENABLE_VERTICAL_LINE: object
Defines the default configuration object for enabling vertical line setting item. Default values:
  • key - sap.gantt.config.SETTING_ITEM_ENABLE_VERTICAL_LINE_KEY
  • checked - true
  • displayText - "Show Divider Lines"
  • tooltip - "Show Vertical Divider Lines between Time Periods"
sap.gantt.config.SETTING_ITEM_ENABLE_VERTICAL_LINE_KEY: string
Defines the default setting item key for the vertical lines.

Default setting item key for vertical lines is used in the default settings group configuration.