MutableHighLowChartActivityBase | ScheduleJS

The base implementation of a mutable chart activity.

since: 1.2

Type parameters

T

the type of the optional user object

Hierarchy

HighLowChartActivityBase<T>
- MutableHighLowChartActivityBase

Implements

Index

Constructors

constructor

Properties

DEFAULT_DURATION

Methods

Constructors

constructor

new MutableHighLowChartActivityBase(low: number, high: number, startTime?: number, endTime?: number): MutableHighLowChartActivityBase

Overrides HighLowChartActivityBase.constructor
- Defined in model/activity/mutable-high-low-chart-activity-base.model.ts:12
Constructs a new high-low activity with the given initial high and low values and the given start and end time.

since

1.2

Parameters
- low: number
  
  the low value of the activity
- high: number
  
  the high value of the activity
- Default value startTime: number = undefined
  
  the start time of the activity
- Default value endTime: number = undefined
  
  the end time of the activity
Returns MutableHighLowChartActivityBase

Properties

Static DEFAULT_DURATION

DEFAULT_DURATION: number = TimeUtil.ofDays(5)

Methods

addDuration

addDuration(duration: number, multiplier?: number): void

- Defined in model/activity/mutable-high-low-chart-activity-base.model.ts:88
Convenience method to determine a new end time based on a duration that will be added several times to the current end time of the activity.

since

1.2

Parameters
- duration: number
  
  the duration of the activity
- Default value multiplier: number = 1
  
  the number of times that the duration will be added
Returns void

getDuration

getDuration(): number

- Defined in model/activity/mutable-high-low-chart-activity-base.model.ts:77
Convenience method to determine the duration between the start and the end time of the activity.

Returns number

the duration of the activity

getEndTime

getEndTime(): number

Implementation of MutableHighLowChartActivity.getEndTime

Inherited from ActivityBase.getEndTime
- Defined in model/activity/activity-base.model.ts:76
The end time of the activity.

since

1.0

Returns number

the activity end time

getHigh

getHigh(): number

Implementation of MutableHighLowChartActivity.getHigh

Inherited from HighLowChartActivityBase.getHigh
- Defined in model/activity/high-low-chart-activity-base.model.ts:32
Returns number

getId

getId(): string

Implementation of MutableHighLowChartActivity.getId

Inherited from ActivityBase.getId
- Defined in model/activity/activity-base.model.ts:56
The unique id of the activity.

since

1.0

Returns string

the unique activity ID

getLow

getLow(): number

Implementation of MutableHighLowChartActivity.getLow

Inherited from HighLowChartActivityBase.getLow
- Defined in model/activity/high-low-chart-activity-base.model.ts:28
Returns number

getName

getName(): string

Implementation of MutableHighLowChartActivity.getName

Inherited from ActivityBase.getName
- Defined in model/activity/activity-base.model.ts:46
The name of the activity, for example "Flight 3441".

since

1.0

Returns string

the name of the activity

getStartTime

getStartTime(): number

Implementation of MutableHighLowChartActivity.getStartTime

Inherited from ActivityBase.getStartTime
- Defined in model/activity/activity-base.model.ts:66
The start time of the activity.

since

1.0

Returns number

the activity start time

getUserObject

getUserObject(): T

Inherited from ActivityBase.getUserObject
- Defined in model/activity/activity-base.model.ts:86
Returns the user object associated to the activity.

since

1.0

Returns T

the user object associated to the activity

setDuration

setDuration(duration: number): void

- Defined in model/activity/mutable-high-low-chart-activity-base.model.ts:67
Convenience method to determine a new end time based on a duration that will be added to the current start time of the activity.

since

1.2

Parameters
- duration: number
  
  the duration of the activity
Returns void

setEndTime

setEndTime(time: number): void

Implementation of MutableHighLowChartActivity.setEndTime
- Defined in model/activity/mutable-high-low-chart-activity-base.model.ts:56
Sets a new end time on the activity.

since

1.2

Parameters
- time: number
  
  the new end time
Returns void

setHigh

setHigh(high: number): void

Implementation of MutableHighLowChartActivity.setHigh
- Defined in model/activity/mutable-high-low-chart-activity-base.model.ts:110
Sets the high value of the activity.

since

1.2

Parameters
- high: number
Returns void

setLow

setLow(low: number): void

Implementation of MutableHighLowChartActivity.setLow
- Defined in model/activity/mutable-high-low-chart-activity-base.model.ts:100
Sets the low value of the activity.

since

1.2

Parameters
- low: number
Returns void

setName

setName(name: string): void

Implementation of MutableHighLowChartActivity.setName
- Defined in model/activity/mutable-high-low-chart-activity-base.model.ts:35
Sets the name of the activity.

since

1.2

Parameters
- name: string
  
  the new name of the activity
Returns void

setStartTime

setStartTime(time: number): void

Implementation of MutableHighLowChartActivity.setStartTime
- Defined in model/activity/mutable-high-low-chart-activity-base.model.ts:45
Sets a new start time on the activity.

since

1.2

Parameters
- time: number
  
  the new start time
Returns void

setUserObject

setUserObject(userObject: T): void

Overrides ActivityBase.setUserObject
- Defined in model/activity/mutable-high-low-chart-activity-base.model.ts:114
Parameters
- userObject: T
Returns void

toString

toString(): string

Inherited from ActivityBase.toString
- Defined in model/activity/activity-base.model.ts:100
Returns string