TimeAxis

Automatically adjust the timespan when generating ticks with generateTicks according to the viewPreset configuration. Setting this to false may lead to shifting time/date of ticks.

Set to false if the timeline is not continuous, e.g. the next timespan does not start where the previous ended (for example skipping weekends etc).

Method generating the ticks for this time axis. Should return a non-empty array of ticks. Each tick is an object of the following structure:

{
   startDate : ..., // start date
   endDate   : ...  // end date
}

To see it in action please check out our TimeAxis example and navigate to "Compressed non-working time" tab.

Include only certain hours or days in the time axis (makes it continuous : false). Accepts and object with day and hour properties:

const scheduler = new Scheduler({
    timeAxis : {
        include : {
             // Do not display hours after 17 or before 9 (only display 9 - 17). The `to´ value is not
             // included in the time axis
             hour : {
                 from : 9,
                 to   : 17
             },
             // Do not display sunday or saturday
             day : [0, 6]
        }
    }
}

In most cases we recommend that you use Scheduler's workingTime config instead. It is easier to use and makes sure all parts of the Scheduler gets updated.

The current end date of the time axis. {@note}This is after filtering for workingTime and so may not be the same as the configured start date.{/note}

Method generating the ticks for this time axis. Should return an array of ticks . Each tick is an object of the following structure:

{
   startDate : ..., // start date
   endDate   : ...  // end date
}

Take notice, that this function either has to be called with start/end parameters, or create those variables.

To see it in action please check out our TimeAxis example and navigate to "Compressed non-working time" tab.

Returns true if the time axis is continuous (will return false when filtered)

The current start date of the time axis. {@note}This is after filtering for workingTime and so may not be the same as the configured start date.{/note}

Returns the ticks of the timeaxis in an array of objects with a "startDate" and "endDate".

The configured end date of the time axis before workingTime filtering

The configured start date of the time axis before workingTime filtering

Get the currently used time unit for the ticks

Get/set currently used preset

Returns true if the passed date is inside the span of the current time axis.

Filter the time axis by a function (and clears any existing filters first). The passed function will be called with each tick in time axis. If the function returns true, the 'tick' is included otherwise it is filtered. If all ticks are filtered out the time axis is considered invalid, triggering invalidFilter and then removing the filter.

Gets the time represented by a tick "coordinate".

Gets a tick "coordinate" representing the date position on the timescale. Returns -1 if the date is not part of the time axis.

Changes the time axis timespan to the supplied start and end dates.

Note This does not preserve the temporal scroll position. You may use setTimeSpan to set the time axis and maintain temporal scroll position (if possible).

Moves the time axis by the passed amount and unit.

NOTE: When using a filtered TimeAxis the result of shift() cannot be guaranteed, it might shift into a filtered out span. It tries to be smart about it by shifting from unfiltered start and end dates. If that solution does not work for your filtering setup, please call setTimeSpan directly instead.

Moves the time axis forward in time in units specified by the view preset shiftUnit, and by the amount specified by the shiftIncrement config of the current view preset.

NOTE: When using a filtered TimeAxis the result of shiftNext() cannot be guaranteed, it might shift into a filtered out span. It tries to be smart about it by shifting from unfiltered start and end dates. If that solution does not work for your filtering setup, please call setTimeSpan directly instead.

Moves the time axis backward in time in units specified by the view preset shiftUnit, and by the amount specified by the shiftIncrement config of the current view preset.

NOTE: When using a filtered TimeAxis the result of shiftPrev() cannot be guaranteed, it might shift into a filtered out span. It tries to be smart about it by shifting from unfiltered start and end dates. If that solution does not work for your filtering setup, please call setTimeSpan directly instead.

Returns true if the passed timespan is part of the current time axis (in whole or partially).