TimeSpan

This class represent a simple date range. It is being used in various subclasses and plugins which operate on date ranges.

It's a subclass of Model. Please refer to documentation of those classes to become familiar with the base interface of this class.

A TimeSpan has the following fields:

startDate - start date of the task in the ISO 8601 format
endDate - end date of the task in the ISO 8601 format (not inclusive)
duration - duration, time between start date and end date
durationUnit - unit used to express the duration
name - an optional name of the range
cls - an optional CSS class to be associated with the range.

The data source of any field can be customized in the subclass. Please refer to Model for details. To specify another date format:

class MyTimeSpan extends TimeSpan {
  static get fields() {
     { name: 'startDate', type: 'date', dateFormat: 'DD/MM/YY' }
  }
}

Useful configs and functions

Member	Description
startDate	Start date of the time span
endDate	End date of the time span
duration	Duration magnitude
durationUnit	Duration unit (`day`, `hour`, etc.)
name	Display name
cls	CSS class to add to the rendered element
style	Inline CSS style string for the element

Fields

Fields belong to a Model class and define the Model data structure

name : String

The name of the time span (or Event / Task)
duration : Number

The numeric part of the timespan's duration (the number of units).
durationUnit : DurationUnit
The unit part of the TimeSpan duration, defaults to "d" (days). Valid values are:
- "millisecond" - Milliseconds
- "second" - Seconds
- "minute" - Minutes
- "hour" - Hours
- "day" - Days
- "week" - Weeks
- "month" - Months
- "quarter" - Quarters
- "year"- Years
This field is readonly after creation, to change durationUnit use #setDuration().
endDate : String/Date

The end date of a time span (or Event / Task).

Uses DateHelper.defaultFormat to convert a supplied string to a Date. To specify another format, either change that setting or subclass TimeSpan and change the dateFormat for this field.

Note that the field always returns a Date.
fullDuration : DurationConfig/Duration

Calculated field which encapsulates the duration's magnitude and unit. This field will not be persisted, setting it will update the duration and durationUnit fields.
startDate : String/Date

The start date of a time span (or Event / Task).

Uses DateHelper.defaultFormat to convert a supplied string to a Date. To specify another format, either change that setting or subclass TimeSpan and change the dateFormat for this field.

Note that the field always returns a Date.
cls : DomClassList/String/String[]/Object

An encapsulation of the CSS classes to add to the rendered time span element.

Always returns a DomClassList, but may still be treated as a string. For granular control of adding and removing individual classes, it is recommended to use the DomClassList API.
iconCls : String

CSS class specifying an icon to apply to the rendered time span element. Note: In case event is a milestone, using iconCls with dependency feature might slightly decrease performance because feature will refer to the DOM to get exact size of the element.
style : String
A CSS style string (applied to style.cssText) or object (applied to style)
```
record.style = 'color: red;font-weight: 800';
```

Properties

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

isTimeSpan : Booleantrue

READONLY

static

ADVANCED

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

isTimeSpan : Booleantrue

READONLY

ADVANCED

Identifies an object as an instance of TimeSpan class, or subclass thereof.
eventStore : EventStore

READONLY

Returns the event store this event is part of, if any.
wbsCode : String

Returns the WBS code of this model (e.g '2.1.3'). Only relevant when part of a tree store, as in the Gantt chart.
dates : Date[]

READONLY

Returns an array of dates in this range. If the range starts/ends not at the beginning of day, the whole day will be included.
durationMS : Number

READONLY

Returns the duration of this Event in milliseconds.
isMilestone : Boolean

READONLY

Returns true if record is a milestone.
isScheduled : Boolean

READONLY

Checks if the range record has both start and end dates set and start <= end
rawDurationMS : Number

READONLY

Returns the event raw duration in milliseconds. Calculated as a simple distance between the event start and end dates in milliseconds. And thus this value (in Scheduler Pro and Gantt) doesn't take into account non-working time nor the project conversion rates.

Functions

Functions are methods available for calling on the class

getDurationInUnit( unit, doNotRound )
: Number

private

Returns duration of the event in given unit. This is a wrapper for getDurationInUnit
shift( amount, unit )

Shift the dates for the date range by the passed amount and unit
exportToICS( icsEventConfig )
Triggers a download of this time span in ICS format (for import in Outlook etc.)
```
timeSpan.downloadAsICS({
     LOCATION : timeSpan.location
 });
```
forEachDate( func, thisObj )

Iterates over the dates
setDuration( duration, durationUnit )

Sets duration and durationUnit in one go. Only allowed way to change durationUnit, the durationUnit field is readonly after creation
setEndDate( date, keepDurationfalse )

Sets the range end date
setStartDate( date, keepDurationtrue )

Sets the range start date
setStartEndDate( start, end, silent )

Sets the event start and end dates
split( splitPoint0.5 )
: TimeSpan

Splits this event into two pieces at the desired position.

Source path

Scheduler/model/TimeSpan.js

TimeSpan

Useful configs and functions

See also

Fields

Properties

Functions

Source path

Inheritance tree3

Mixins4

Contents