TimeAxisViewModel

This class is an internal view model class, describing the visual representation of a TimeAxis. The config for the header rows is described in the headers. To calculate the size of each cell in the time axis, this class requires:

availableSpace - The total width or height available for the rendering
tickSize - The fixed width or height of each cell in the lowest header row. This value is normally read from the viewPreset but this can also be updated programmatically using the tickSize setter

Normally you should not interact with this class directly.

No results

Configs

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

availableSpace : Number

internal

The available width/height, this is normally not known by the consuming UI component using this model class until it has been fully rendered. The consumer of this model should set availableSpace when its width has changed.

Has a corresponding runtime availableSpace property.
forceFit : Booleanfalse

internal

true if cells in the bottom-most row should be fitted to the available space.

Has a corresponding runtime forceFit property.
snap : Booleanfalse

internal

true if there is a requirement to be able to snap events to a certain view resolution. This has implications of the tickSize that can be used, since all widths must be in even pixels.

Has a corresponding runtime snap property.
tickSize : Number100

internal

The "tick width" for horizontal mode or "tick height" for vertical mode, to use for the cells in the bottom most header row. This value is normally read from the viewPreset

Has a corresponding runtime tickSize property.
timeAxis : TimeAxis

internal

The time axis providing the underlying data to be visualized

Properties

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

isTimeAxisViewModel : Booleantrue

READONLY

static

ADVANCED

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

availableSpace : Number

internal

Get/set the available space for the time axis representation. If size changes it will cause it to update its contents and fire the update event.

Has a corresponding availableSpace config.
columnConfig : Object[]

internal

Returns an array representing the headers of the current timeAxis. Each element is an array representing the cells for that level in the header.
forceFit : Boolean

internal

Gets/sets the forceFit value for the model. Setting it will cause it to update its contents and fire the update event.

Has a corresponding forceFit config.
isHorizontal : Boolean

internal

READONLY

Using horizontal mode?
isStretchingTicks : Boolean

internal

READONLY

Returns true if the ticks are currently being stretched to fit the available space.
isVertical : Boolean

internal

READONLY

Using vertical mode?
majorHeaderLevel : String

private

READONLY

This method is meant to return the level of the header which 2nd lowest. It is used for isMajorTick method
snap : Boolean

internal

Gets/sets the snap value for the model. Setting it will cause it to update its contents and fire the update event.

Has a corresponding snap config.
snapPixelAmount : Number

internal

READONLY

Returns the pixel increment for the current view resolution.
tickSize : Number

internal

Get/set the current time column size (the width or height of a cell in the bottom-most time axis header row, depending on mode)

Has a corresponding tickSize config.
totalSize : Number

internal

READONLY

Returns the total width/height of the time axis representation, depending on mode.
isTimeAxisViewModel : Booleantrue

READONLY

ADVANCED

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

Functions

Functions are methods available for calling on the class

fitToAvailableSpace( suppressEvent )

internal

This function fits the time columns into the available space in the time axis column.
forEachInterval( position, iteratorFn, thisObj )

internal

Calls the supplied iterator function once per interval. The function will be called with three parameters, start date and end date and an index. Return false to break the iteration.
forEachMainInterval( iteratorFn, thisObj )

internal

Calls the supplied iterator function once per interval. The function will be called with three parameters, start date and end date and an index. Return false to break the iteration.
getDates( level, useLowestHeaderfalse, getEndfalse )
: Array

internal

Returns start dates for ticks at the specified level in format { date, isMajor }.
getSingleUnitInPixels( )
: Number

internal

Returns the amount of pixels for a single unit
isMajorTick( date )
: Boolean

private

For vertical view (and column lines plugin) we sometimes want to know if current tick starts along with the upper header level.
update( availableSpace, silentfalse, forceUpdatefalse )

internal

Updates the view model current timeAxis configuration and available space.
getDateFromPosition( position, roundingMethod, allowOutOfRangefalse )
: Date

Gets the date for a position on the time axis
getDistanceBetweenDates( start, end )
: Number

Returns the distance in pixels for a timespan with the given start and end date.
getDistanceForDuration( durationMS )
: Number

Returns the distance in pixels for a time span
getPositionFromDate( date )
: Number

Gets the position of a date on the projected time axis or -1 if the date is not in the timeAxis.

Events

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

reconfigure

Fires after the model has been reconfigured.
update

Fires after the model has been updated.

Event handlers

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

onReconfigure

Called after the model has been reconfigured.
onUpdate

Called after the model has been updated.

Source path

Scheduler/view/model/TimeAxisViewModel.js