TimelineDomEvents
Configs
1
Configs
1Set to true to ignore reacting to DOM events (mouseover/mouseout etc) while scrolling. Useful if you
want to maximize scroll performance.
Properties
3
Properties
3Class hierarchy
Dates
The currently hovered timeline context. This is updated as the mouse or pointer moves over the timeline.
Events
4
Events
4Fires after a click on a time axis cell
// Adding a listener using the "on" method
timelineDomEvents.on('timeAxisHeaderClick', ({ source, startDate, endDate, event }) => {
});| Parameter | Type | Description |
|---|---|---|
source | TimeAxisColumn | VerticalTimeAxisColumn | The column object |
startDate | Date | The start date of the header cell |
endDate | Date | The end date of the header cell |
event | Event | The event object |
Fires after a right click on a time axis cell
// Adding a listener using the "on" method
timelineDomEvents.on('timeAxisHeaderContextMenu', ({ source, startDate, endDate, event }) => {
});| Parameter | Type | Description |
|---|---|---|
source | TimeAxisColumn | VerticalTimeAxisColumn | The column object |
startDate | Date | The start date of the header cell |
endDate | Date | The end date of the header cell |
event | Event | The event object |
Fires after a double click on a time axis cell
// Adding a listener using the "on" method
timelineDomEvents.on('timeAxisHeaderDblClick', ({ source, startDate, endDate, event }) => {
});| Parameter | Type | Description |
|---|---|---|
source | TimeAxisColumn | VerticalTimeAxisColumn | The column object |
startDate | Date | The start date of the header cell |
endDate | Date | The end date of the header cell |
event | Event | The event object |
Fired when the pointer-activated timelineContext has changed.
// Adding a listener using the "on" method
timelineDomEvents.on('timelineContextChange', ({ oldContext, context }) => {
});| Parameter | Type | Description |
|---|---|---|
oldContext | TimelineContext | The tick/resource context being deactivated. |
context | TimelineContext | The tick/resource context being activated. |
Event handlers
4
Event handlers
4Called after a click on a time axis cell
new TimelineDomEvents({
onTimeAxisHeaderClick({ source, startDate, endDate, event }) {
}
});| Parameter | Type | Description |
|---|---|---|
source | TimeAxisColumn | VerticalTimeAxisColumn | The column object |
startDate | Date | The start date of the header cell |
endDate | Date | The end date of the header cell |
event | Event | The event object |
Called after a right click on a time axis cell
new TimelineDomEvents({
onTimeAxisHeaderContextMenu({ source, startDate, endDate, event }) {
}
});| Parameter | Type | Description |
|---|---|---|
source | TimeAxisColumn | VerticalTimeAxisColumn | The column object |
startDate | Date | The start date of the header cell |
endDate | Date | The end date of the header cell |
event | Event | The event object |
Called after a double click on a time axis cell
new TimelineDomEvents({
onTimeAxisHeaderDblClick({ source, startDate, endDate, event }) {
}
});| Parameter | Type | Description |
|---|---|---|
source | TimeAxisColumn | VerticalTimeAxisColumn | The column object |
startDate | Date | The start date of the header cell |
endDate | Date | The end date of the header cell |
event | Event | The event object |
Called when the pointer-activated timelineContext has changed.
new TimelineDomEvents({
onTimelineContextChange({ oldContext, context }) {
}
});| Parameter | Type | Description |
|---|---|---|
oldContext | TimelineContext | The tick/resource context being deactivated. |
context | TimelineContext | The tick/resource context being activated. |