AbstractTimeRanges
Abstract base class, you should not use this class directly.
Configs
16
Configs
16Common
Function used to generate the HTML content for a time range body element.
const scheduler = new Scheduler({
features : {
timeRanges : {
bodyRenderer({ timeRange }) {
return `${timeRange.name}`
}
}
}
});
| Parameter | Type | Description |
|---|---|---|
data | Object | Render data |
data.timeRange | TimeSpan |
String representing the HTML markup
Set to true to enable dragging and resizing of range elements in the header. Note that enabling
dragging/resizing also enables showHeaderElements automatically.
Function used to generate the HTML content for a time range header element.
const scheduler = new Scheduler({
features : {
timeRanges : {
headerRenderer({ timeRange }) {
return `${timeRange.name}`
}
}
}
});
| Parameter | Type | Description |
|---|---|---|
data | Object | Render data |
data.timeRange | TimeSpan |
String representing the HTML markup
A Tooltip config object which is applied to the tooltip shown when hovering a TimeRange header element
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.
A Boolean specifying whether to show tooltip while resizing range elements, or a Tooltip config object which is applied to the tooltip
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}`
}
}
}
});
| Parameter | Type | Description |
|---|---|---|
data | Object | Tooltip data |
data.timeRange | TimeSpan | |
data.startClockHtml | String | Predefined HTML to show the start time |
data.endClockHtml | String | Predefined HTML to show the end time |
String representing the HTML markup
Misc
Other
Properties
18
Properties
18Common
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.
Class hierarchy
Other
The Tooltip instance shown when hovering a TimeRange header element
Functions
31
Functions
31Other
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.
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.
| Parameter | Type | Description |
|---|---|---|
range | TimeSpan | Range to render. |
viewStartDate | Date | Specifies view start date. Defaults to view visible range start |
viewEndDate | Date | Specifies view end date. Defaults to view visible range end |
true if the range should be rendered and false otherwise.
Configuration
Events
Misc
Events
8
Events
8Fired on the owning Scheduler or Gantt widget when a click happens on a time range header element
// Adding a listener using the "on" method
abstractTimeRanges.on('timeRangeHeaderClick', ({ source, timeRangeRecord, domEvent }) => {
});| Parameter | Type | Description |
|---|---|---|
source | Scheduler | Scheduler instance |
timeRangeRecord | TimeSpan | The record |
domEvent | MouseEvent | Browser event |
Fired on the owning Scheduler or Gantt widget when a right click happens on a time range header element
// Adding a listener using the "on" method
abstractTimeRanges.on('timeRangeHeaderContextMenu', ({ source, timeRangeRecord, domEvent }) => {
});| Parameter | Type | Description |
|---|---|---|
source | Scheduler | Scheduler instance |
timeRangeRecord | TimeSpan | The record |
domEvent | MouseEvent | Browser event |
Fired on the owning Scheduler or Gantt widget when a double click happens on a time range header element
// Adding a listener using the "on" method
abstractTimeRanges.on('timeRangeHeaderDblClick', ({ source, timeRangeRecord, domEvent }) => {
});| Parameter | Type | Description |
|---|---|---|
source | Scheduler | Scheduler instance |
timeRangeRecord | TimeSpan | The record |
domEvent | MouseEvent | Browser event |
Event handlers
8
Event handlers
8Called on the owning Scheduler or Gantt widget when a click happens on a time range header element
new AbstractTimeRanges({
onTimeRangeHeaderClick({ source, timeRangeRecord, domEvent }) {
}
});| Parameter | Type | Description |
|---|---|---|
source | Scheduler | Scheduler instance |
timeRangeRecord | TimeSpan | The record |
domEvent | MouseEvent | Browser event |
Called on the owning Scheduler or Gantt widget when a right click happens on a time range header element
new AbstractTimeRanges({
onTimeRangeHeaderContextMenu({ source, timeRangeRecord, domEvent }) {
}
});| Parameter | Type | Description |
|---|---|---|
source | Scheduler | Scheduler instance |
timeRangeRecord | TimeSpan | The record |
domEvent | MouseEvent | Browser event |
Called on the owning Scheduler or Gantt widget when a double click happens on a time range header element
new AbstractTimeRanges({
onTimeRangeHeaderDblClick({ source, timeRangeRecord, domEvent }) {
}
});| Parameter | Type | Description |
|---|---|---|
source | Scheduler | Scheduler instance |
timeRangeRecord | TimeSpan | The record |
domEvent | MouseEvent | Browser event |