TimeAxisColumn

A column containing the timeline "viewport", in which events, dependencies etc. are drawn. Normally you do not need to interact with or create this column, it is handled by Scheduler.

If you wish to output custom contents inside the time axis row cells, you can provide your custom column configuration using the renderer like so:

const scheduler = new Scheduler({
   appendTo         : document.body
   columns          : [
      { text : 'Name', field : 'name', width : 130 },
      {
          type : 'timeAxis',
          renderer({ record, cellElement }) {
              return '<div class="cool-chart"></div>';
          }
      }
   ]
});

Configs

81

Common

autoWidthColumn
fieldColumn
fitModeColumn
flexColumn
listenersEvents
maxWidthColumn
textColumn
widgetsWidgetColumn
widthColumn

Interaction

draggable: Boolean= falseAlso a property

Set to false to prevent this column header from being dragged.

Allow filtering data in the column (if Filter feature is enabled)

groupable: Boolean= falseAlso a property

Set to false to prevent grouping by this column.

hideable: Boolean= falseAlso a property

Allow column visibility to be toggled through UI.

resizable: Boolean= falseAlso a property

Set to false to prevent the column from being drag-resized when the ColumnResize plugin is enabled.

Allow searching in the column (respected by QuickFind and Search features)

sortable: Boolean= falseAlso a property

Allow sorting of data in the column

collapsedColumn
editorColumn
sealedColumn

Menu

Set to true to show a context menu on the cell elements in this column

Show column picker for the column.

Rendering

cls: String= 'b-sch-time-axis-column'Also a property

CSS class added to the header of this column

afterRenderCellWidgetColumn
cellClsColumn
iconColumn
rendererWidgetColumn
tooltipColumn

Accessibility

ariaLabelColumn

Export

Integration

vueColumn

Layout

alignColumn
hiddenColumn
lockedColumn
minWidthColumn
regionColumn

Merge cells

mergeableColumn

Misc

localeClassLocalizable
localizableLocalizable
tagsColumn
treeColumn

Other

formulaColumn
pinnedColumn
readOnlyColumn

Summary

sumColumn
summariesColumn

Properties

152

Common

autoWidthColumn
fieldColumn
fitModeColumn
flexColumn
maxWidthColumn
textColumn
widgetsWidgetColumn
widthColumn

Class hierarchy

isTimeAxisColumn: Boolean= truereadonly
Identifies an object as an instance of TimeAxisColumn class, or subclass thereof.
isTimeAxisColumn: Boolean= truereadonlystatic
Identifies an object as an instance of TimeAxisColumn class, or subclass thereof.
isColumnColumn
isEventsEvents
isLocalizableLocalizable
isModelModel
isModelLinkModelLink
isModelStmModelStm
isTreeNodeTreeNode
isWidgetColumnWidgetColumn

Interaction

draggable: Boolean= falseAlso a config

Set to false to prevent this column header from being dragged.

filterable: Boolean= falseAlso a config

Allow filtering data in the column (if Filter feature is enabled)

groupable: Boolean= falseAlso a config

Set to false to prevent grouping by this column.

hideable: Boolean= falseAlso a config

Allow column visibility to be toggled through UI.

resizable: Boolean= falseAlso a config

Set to false to prevent the column from being drag-resized when the ColumnResize plugin is enabled.

searchable: Boolean= falseAlso a config

Allow searching in the column (respected by QuickFind and Search features)

sortable: Boolean= falseAlso a config

Allow sorting of data in the column

collapsedColumn
editorColumn
sealedColumn

Menu

Set to true to show a context menu on the cell elements in this column

Show column picker for the column.

Rendering

cls: String= 'b-sch-time-axis-column'Also a config

CSS class added to the header of this column

afterRenderCellWidgetColumn
cellClsColumn
iconColumn
rendererWidgetColumn
tooltipColumn

Accessibility

ariaLabelColumn

Editing

copyOfModel
isValidModel

Export

Fields

allFieldsstaticModel
autoExposeFieldsstaticModel
childrenFieldstaticModel
fieldMapstaticModel
fieldsstaticModel
idFieldstaticModel

Grouping

Identification

keyModel

Integration

vueColumn

JSON

jsonModel

Layout

alignColumn
hiddenColumn
lockedColumn
minWidthColumn
regionColumn

Lifecycle

configBase

Linked records

hasLinksModelLink
isLinkedModelLink
recordLinksModelLink

Merge cells

mergeableColumn

Misc

localeHelperLocalizable
localeManagerLocalizable
stmModelStm
tagsColumn
treeColumn

Other

$namestaticModel
defaultsColumn
elementColumn
formulaColumn
gridColumn
pinnedColumn
readOnlyColumn
relationsstaticModel
subGridColumn
typestaticColumn
visibleColumn

Parent & children

allChildrenTreeNode
childLevelTreeNode
firstChildTreeNode
isLeafTreeNode
isLoadedTreeNode
isParentTreeNode
isRootTreeNode
lastChildTreeNode
nextSiblingTreeNode
parentTreeNode
parentIdTreeNode

Summary

sumColumn
summariesColumn

Functions

78

Other

Refreshes the columns header contents (which is either a HorizontalTimeAxis or a ResourceHeader). Useful if you have rendered some extra meta data that depends on external data such as the EventStore or ResourceStore.

hideColumn
LstaticLocalizable
onEvents
relayAllEvents
showColumn
toggleColumn
triggerEvents
unEvents

Configuration

applyDefaultsstaticBase

Editing

copyModel
getDataModel
removeModel
setModel

Events

Fields

addFieldstaticModel
getModel
processFieldstaticModel
removeFieldstaticModel

Identification

asIdstaticModel

JSON

toJSONModel

Lifecycle

destroystaticBase

Misc

equalsModel
initClassstaticBase
isOfTypeNamestaticBase
linkModelLink
mixinstaticBase
optionalLstaticLocalizable

Parent & children

appendChildTreeNode
bubbleTreeNode
bubbleWhileTreeNode
containsTreeNode
isExpandedTreeNode
removeChildTreeNode
traverseTreeNode

Events

5

Event handlers

5

Typedefs

2