AbstractTimeRanges
Abstract

Abstract base class for features that render highlighted ranges on the time axis, such as TimeRanges and NonWorkingTime. You should not use this class directly.

Configs

Configs are options you supply in a configuration object when creating an instance of this class

bodyRenderer : Function
Function used to generate the HTML content for a time range body element.
```
const scheduler = new Scheduler({
  features : {
    timeRanges : {
      bodyRenderer({ timeRange }) {
        return `${timeRange.name}`
      }
    }
  }
});
```
Parameters
- context : Object
  
  Renderer context data
- timeRange : TimeSpan
  
  Time range to render
Returns

String
:

String representing the HTML markup
enableResizing : Booleanfalse

Set to true to enable dragging and resizing of range elements in the header. Note that enabling dragging/resizing also enables showHeaderElements automatically.
headerRenderer : Function
Function used to generate the HTML content for a time range header element.
```
const scheduler = new Scheduler({
  features : {
    timeRanges : {
      headerRenderer({ timeRange }) {
        return `${timeRange.name}`
      }
    }
  }
});
```
Parameters
- context : Object
  
  Renderer context data
- timeRange : TimeSpan
  Time range
Returns

String
:

String representing the HTML markup
hoverTooltip : TooltipConfig

A Tooltip config object which is applied to the tooltip shown when hovering a TimeRange header element

Has a corresponding runtime hoverTooltip property.
showHeaderElements : Booleantrue

Set to false to not render range elements into the time axis header. Note that header elements are required for interaction such as dragging/resizing, so enabling enableResizing will automatically enable this setting.

Has a corresponding runtime showHeaderElements property.
showTooltip : Boolean/TooltipConfigtrue

A Boolean specifying whether to show tooltip while resizing range elements, or a Tooltip config object which is applied to the tooltip
tooltipTemplate : Function
Template used to generate the tooltip contents when hovering a time range header element.
```
const scheduler = new Scheduler({
  features : {
    timeRanges : {
      tooltipTemplate({ timeRange }) {
        return `${timeRange.name}`
      }
    }
  }
});
```
Parameters
- data : Object
  
  Tooltip data
- timeRange : TimeSpan
  Time range
- startClockHtml : String
  
  Predefined HTML to show the start time
- endClockHtml : String
  
  Predefined HTML to show the end time
Returns

String
:

String representing the HTML markup

Properties

Properties are getters/setters or publicly accessible variables on this class

isAbstractTimeRanges : Booleantrue

READONLY

static

ADVANCED

Identifies an object as an instance of AbstractTimeRanges class, or subclass thereof.

showHeaderElements : Booleantrue

Set to false to not render range elements into the time axis header. Note that header elements are required for interaction such as dragging/resizing, so enabling enableResizing will automatically enable this setting.

Has a corresponding showHeaderElements config.
hoverTooltip : Tooltip

READONLY

The Tooltip instance shown when hovering a TimeRange header element

Has a corresponding hoverTooltip config.
isAbstractTimeRanges : Booleantrue

READONLY

ADVANCED

Identifies an object as an instance of AbstractTimeRanges class, or subclass thereof.

Functions

Functions are methods available for calling on the class

getTipHtml( )

Generates the html to display in the tooltip during drag drop. If you want to customize the contents of the tooltip, supply a dragTipTemplate instead of overriding this function.
populateTimeAxisHeaderMenu( options )

internal

Adds menu items for the context menu, and may mutate the menu configuration.
shouldRenderRange( range, viewStartDate, viewEndDate )
: Boolean

Based on this method result the feature decides whether the provided range should be rendered or not. The method checks that the range intersects the current viewport.

Override the method to implement your custom range rendering vetoing logic.

Events

Events are triggered for certain actions in this class and can be listened for to react to those actions in your code

timeRangeHeaderClick

ON-OWNER

Fired on the owning Scheduler or Gantt widget when a click happens on a time range header element

Note that this event is triggered on the owning widget:
timeRangeHeaderContextMenu

ON-OWNER

Fired on the owning Scheduler or Gantt widget when a right click happens on a time range header element

Note that this event is triggered on the owning widget:
timeRangeHeaderDblClick

ON-OWNER

Fired on the owning Scheduler or Gantt widget when a double click happens on a time range header element

Note that this event is triggered on the owning widget:

Event handlers

Event handlers are callbacks called as a result of certain actions in this class

onTimeRangeHeaderClick

ON-OWNER

Called on the owning Scheduler or Gantt widget when a click happens on a time range header element

Note that this handler is called on the owning widget:
onTimeRangeHeaderContextMenu

ON-OWNER

Called on the owning Scheduler or Gantt widget when a right click happens on a time range header element

Note that this handler is called on the owning widget:
onTimeRangeHeaderDblClick

ON-OWNER

Called on the owning Scheduler or Gantt widget when a double click happens on a time range header element

Note that this handler is called on the owning widget:

Source path

Scheduler/feature/AbstractTimeRanges.js

AbstractTimeRanges
Abstract

See also

Configs

Parameters

Returns

Parameters

Returns

Parameters

Returns

Properties

Functions

Events

Event handlers

Source path

Inheritance tree3

Mixins3

Contents

AbstractTimeRanges Abstract

See also

Configs

Parameters

Returns

Parameters

Returns

Parameters

Returns

Properties

Functions

Events

Event handlers

Source path

Inheritance tree3

Mixins3

Contents

AbstractTimeRanges
Abstract