DependencyBaseModel

Base class used for both Scheduler and Gantt that defines the common dependency fields such as from, to, and type. Not intended to be used directly — use DependencyModel instead.

Fields

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

bidirectional : Boolean

Bidirectional, drawn with arrows in both directions
from : String/Number

From event, id of source event
fromEvent : String/Number/EventModel

Gets/sets the source event of the dependency.

Accepts multiple formats but always returns an EventModel.

NOTE: This is not a proper field but rather an alias, it will be serialized but cannot be remapped. If you need to remap, consider using from instead.
fromSide : 'top'/'left'/'bottom'/'right'

Start side on source (top, left, bottom, right)
lag : Number

The magnitude of this dependency's lag (the number of units).
lagUnit : DurationUnit/DurationUnitShort

READONLY
The units of this dependency's lag, defaults to "d" (days). Valid values are:
- "ms" (milliseconds)
- "s" (seconds)
- "m" (minutes)
- "h" (hours)
- "d" (days)
- "w" (weeks)
- "M" (months)
- "y" (years)
This field is readonly after creation, to change lagUnit use setLag().
to : String/Number

To event, id of target event
toEvent : String/Number/EventModel

Gets/sets the target event of the dependency.

Accepts multiple formats but always returns an EventModel.

NOTE: This is not a proper field but rather an alias, it will be serialized but cannot be remapped. If you need to remap, consider using to instead.
toSide : 'top'/'left'/'bottom'/'right'

End side on target (top, left, bottom, right)
type : Number

Dependency type, see static property Type
cls : String

CSS class to apply to lines drawn for the dependency

Properties

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

isDependencyBaseModel : Booleantrue

READONLY

static

ADVANCED

Identifies an object as an instance of DependencyBaseModel class, or subclass thereof.
Type : DependencyType

READONLY

static
An enumerable object, containing names for the dependency types integer constants.
- 0 StartToStart
- 1 StartToEnd
- 2 EndToStart
- 3 EndToEnd

isDependencyBaseModel : Booleantrue

READONLY

ADVANCED

Identifies an object as an instance of DependencyBaseModel class, or subclass thereof.
fullLag : Duration
Property which encapsulates the lag's magnitude and units. An object which contains two properties:
- magnitude : Number
  
  The magnitude of the duration
- unit : DurationUnitShort
  
  The unit in which the duration is measured, e.g., 'd' for days
hardType : Number

Alias to dependency type, but when set resets fromSide & toSide to null as well.
isPersistable : Boolean

READONLY

Returns true if the linked events have been persisted (e.g. neither of them are 'phantoms')
isValid : Boolean

READONLY

Returns true if the dependency is valid. It is considered valid if it has a valid type and both from and to events are set and pointing to different events.

Functions

Functions are methods available for calling on the class

getDefaultType( )
: Number

static

Returns the default dependency type value from the model's field definition.

getHardType( )
: Number

Returns dependency hard type, see hardType.
highlight( cls )

Applies given CSS class to dependency, the value doesn't persist
isHighlightedWith( cls )
: Boolean

Checks if the given CSS class is applied to dependency.
setHardType( type )

Sets dependency type and resets fromSide and toSide to null.
setLag( lag, lagUnit )

Sets lag and lagUnit in one go. Only allowed way to change lagUnit, the lagUnit field is readonly after creation
unhighlight( cls )

Removes given CSS class from dependency if applied, the value doesn't persist
setAsync( field, value, silentfalse )
: Promise

ASYNC
Set value for the specified field(s), triggering engine calculations immediately. See Model#set() for arguments. *
```
dependency.set('from', 2);
// dependency.fromEvent is not yet up to date

await dependency.setAsync('from', 2);
// dependency.fromEvent is up to date
```

Type definitions

DependencyType
Properties
- StartToStart : Number
  
  Start-to-Start (0): The successor event cannot start before the predecessor starts
- StartToEnd : Number
  
  Start-to-Finish (1): The successor event cannot finish before the predecessor starts
- EndToStart : Number
  
  Finish-to-Start (2): The successor event cannot start before the predecessor finishes
- EndToEnd : Number
  
  Finish-to-Finish (3): The successor event cannot finish before the predecessor finishes

Source path

Scheduler/model/DependencyBaseModel.js

DependencyBaseModel

See also

Fields

Properties

Functions

Type definitions

Properties

Source path

Inheritance tree3

Mixins3

Contents