TimelineDateMapper
Mixin

Mixin that contains functionality to convert between coordinates and dates etc. Enables mapping pixel positions to dates and dates to pixel positions based on the current time axis configuration.

const scheduler = new Scheduler({
    snap : true // Snap to time resolution increments during interactions
});

Configs

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

timeResolution : Object/Number
Gets/sets the current time resolution object, which contains a unit identifier and an increment count { unit, increment }. This value means minimal task duration you can create using UI.

For example when you drag create a task or drag & drop a task, if increment is 5 and unit is 'minute' that means that you can create tasks in 5 minute increments, or move it in 5 minute steps.

This value is taken from viewPreset timeResolution config by default. When supplying a Number to the setter only the increment is changed and the unit value remains untouched.
```
timeResolution : {
  unit      : 'minute',  //Valid values are "millisecond", "second", "minute", "hour", "day", "week", "month", "quarter", "year".
  increment : 5
}
```
When the fillTicks option is enabled, the resolution will be in full ticks regardless of configured value.
- increment : Number1
  
  The increment in the specified unit
- unit : DurationUnit
  
  The time resolution unit
Has a corresponding runtime timeResolution property.
snap : Booleanfalse

Set to true to snap to the current time resolution increment while interacting with scheduled events.

The time resolution increment is either determined by the currently applied view preset, or it can be overridden using timeResolution.

If you also want to snap to resources while dragging events, set the snapToResource config of the EventDrag feature to true.

When the fillTicks option is enabled, snapping will align to full ticks, regardless of the time resolution.

Has a corresponding runtime snap property.

Properties

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

isTimelineDateMapper : Booleantrue

READONLY

static

ADVANCED

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

isTimelineDateMapper : Booleantrue

READONLY

ADVANCED

Identifies an object as an instance of TimelineDateMapper class, or subclass thereof.
timeResolution : Object/Number
Gets/sets the current time resolution object, which contains a unit identifier and an increment count { unit, increment }. This value means minimal task duration you can create using UI.

For example when you drag create a task or drag & drop a task, if increment is 5 and unit is 'minute' that means that you can create tasks in 5 minute increments, or move it in 5 minute steps.

This value is taken from viewPreset timeResolution config by default. When supplying a Number to the setter only the increment is changed and the unit value remains untouched.
```
timeResolution : {
  unit      : 'minute',  //Valid values are "millisecond", "second", "minute", "hour", "day", "week", "month", "quarter", "year".
  increment : 5
}
```
When the fillTicks option is enabled, the resolution will be in full ticks regardless of configured value.
- increment : Number1
  
  The increment in the specified unit
- unit : DurationUnit
  
  The time resolution unit
Has a corresponding timeResolution config.
viewportCenterDate : Date

READONLY

Returns the center date of the currently visible timespan of scheduler.
snap : Booleanfalse

Set to true to snap to the current time resolution increment while interacting with scheduled events.

The time resolution increment is either determined by the currently applied view preset, or it can be overridden using timeResolution.

If you also want to snap to resources while dragging events, set the snapToResource config of the EventDrag feature to true.

When the fillTicks option is enabled, snapping will align to full ticks, regardless of the time resolution.

Has a corresponding snap config.

Functions

Functions are methods available for calling on the class

getDisplayEndDate( endDate, startDate )
: Date

private

Method to get a displayed end date value, see getFormattedEndDate for more info.
getFormattedEndDate( endDate, startDate )
: String

private

Method to get a formatted end date for a scheduled event, the grid uses the "displayDateFormat" property defined in the current view preset. End dates are formatted as 'inclusive', meaning when an end date falls on midnight and the date format doesn't involve any hour/minute information, 1ms will be subtracted (e.g. 2010-01-08T00:00:00 will first be modified to 2010-01-07 before being formatted).
getStartEndDatesFromRectangle( rect, roundingMethod, duration )
: Object

Gets the start and end dates for an element Region
getCoordinateFromDate( date, optionstrue )
: Number

Gets the x or y coordinate relative to the scheduler element, or page coordinate (based on the 'local' flag) If the coordinate is not in the currently rendered view, -1 will be returned.
getDateFromCoordinate( coordinate, roundingMethod, localtrue, allowOutOfRangefalse )
: Date

Gets the date for an X or Y coordinate, either local to the view element or the page based on the 3rd argument. If the coordinate is not in the currently rendered view, null will be returned unless the allowOutOfRange parameter is passed a true.
getDateFromDomEvent( e, roundingMethod, allowOutOfRangefalse )
: Date

Gets the time for a DOM event such as 'mousemove' or 'click' regardless of the orientation of the time axis.
getDateFromXY( xy, roundingMethod, localtrue, allowOutOfRangefalse )
: Date

Gets the date for an XY coordinate regardless of the orientation of the time axis.
getTimeSpanDistance( startDate, endDate )
: Number

Returns the distance in pixels for the time span in the view.

Source path

Scheduler/view/mixin/TimelineDateMapper.js

Inheritance tree1

TimelineDateMapper

TimelineDateMapper
Mixin

See also

Configs

Properties

Functions

Source path

Inheritance tree1

Contents

TimelineDateMapper Mixin

See also

Configs

Properties

Functions

Source path

Inheritance tree1

Contents

TimelineDateMapper
Mixin