ScheduleJS
Options
All
  • Public
  • Public/Protected
  • All
Menu

Activity events are being fired whenever the user makes a change to an activity in the graphics view. Event handlers for the event types listed in this class can be registered on the GraphicsBase control.

Hierarchy

  • ActivityEvent

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    Returns ActivityEvent

Properties

Static ACTIVITY_CHANGE

ACTIVITY_CHANGE: EventType = new EventType(undefined, "ACTIVITY_CHANGE")

The parent event type of all other activity event types. Gets fired whenever anything changes.

since

1.0

Static ACTIVITY_CHANGE_FINISHED

ACTIVITY_CHANGE_FINISHED: EventType = new EventType(ActivityEvent.ACTIVITY_CHANGE, "ACTIVITY_CHANGE_FINISHED")

The parent event type of all FINISHED activity event types. Gets fired whenever a change type is finishing, e.g. DRAG_FINISHED.

since

1.0

Static ACTIVITY_CHANGE_ONGOING

ACTIVITY_CHANGE_ONGOING: EventType = new EventType(ActivityEvent.ACTIVITY_CHANGE, "ACTIVITY_CHANGE_ONGOING")

The parent event type of all ONGOING activity event types. Gets fired whenever a change type is ongoing, e.g. DRAG_ONGOING.

since

1.0

Static ACTIVITY_CHANGE_STARTED

ACTIVITY_CHANGE_STARTED: EventType = new EventType(ActivityEvent.ACTIVITY_CHANGE, "ACTIVITY_CHANGE")

The parent event type of all STARTED activity event types. Gets fired whenever a change type is starting, e.g. DRAG_STARTED.

since

1.0

Static ACTIVITY_DELETED

ACTIVITY_DELETED: EventType = new EventType(ActivityEvent.ACTIVITY_CHANGE, "ACTIVITY_DELETED")

An event type used when the user pressed the delete shortcut to delete an activity.

since

1.0

Static CHART_HIGH_VALUE_CHANGE_FINISHED

CHART_HIGH_VALUE_CHANGE_FINISHED: EventType = new EventType(ActivityEvent.CHART_VALUE_CHANGE_FINISHED, "CHART_HIGH_VALUE_CHANGE_FINISHED")

An event type being used when the user has finished changing the chart high value of a MutableHighLowChartActivity.

since

1.0

Static CHART_HIGH_VALUE_CHANGE_ONGOING

CHART_HIGH_VALUE_CHANGE_ONGOING: EventType = new EventType(ActivityEvent.CHART_VALUE_CHANGE_ONGOING, "CHART_HIGH_VALUE_CHANGE_ONGOING")

An event type being used when the user is in the process of changing the chart high value of a MutableHighLowChartActivity.

since

1.0

Static CHART_HIGH_VALUE_CHANGE_STARTED

CHART_HIGH_VALUE_CHANGE_STARTED: EventType = new EventType(ActivityEvent.CHART_VALUE_CHANGE_STARTED, "CHART_HIGH_VALUE_CHANGE_STARTED")

An event type being used when the user has started changing the chart high value of a MutableHighLowChartActivity.

since

1.0

Static CHART_LOW_VALUE_CHANGE_FINISHED

CHART_LOW_VALUE_CHANGE_FINISHED: EventType = new EventType(ActivityEvent.CHART_VALUE_CHANGE_FINISHED, "CHART_LOW_VALUE_CHANGE_FINISHED")

An event type being used when the user has finished changing the chart low value of a MutableHighLowChartActivity.

since

1.0

Static CHART_LOW_VALUE_CHANGE_ONGOING

CHART_LOW_VALUE_CHANGE_ONGOING: EventType = new EventType(ActivityEvent.CHART_VALUE_CHANGE_ONGOING, "CHART_LOW_VALUE_CHANGE_ONGOING")

An event type being used when the user is in the process of changing the chart low value of a MutableHighLowChartActivity.

since

1.0

Static CHART_LOW_VALUE_CHANGE_STARTED

CHART_LOW_VALUE_CHANGE_STARTED: EventType = new EventType(ActivityEvent.CHART_VALUE_CHANGE_STARTED, "CHART_LOW_VALUE_CHANGE_STARTED")

An event type being used when the user has started changing the chart low value of a MutableHighLowChartActivity.

since

1.0

Static CHART_VALUE_CHANGE_FINISHED

CHART_VALUE_CHANGE_FINISHED: EventType = new EventType(ActivityEvent.ACTIVITY_CHANGE_FINISHED, "CHART_VALUE_CHANGE_FINISHED")

An event type being used when the user has finished changing the chart value of a MutableChartActivity.

since

1.0

Static CHART_VALUE_CHANGE_ONGOING

CHART_VALUE_CHANGE_ONGOING: EventType = new EventType(ActivityEvent.ACTIVITY_CHANGE_ONGOING, "CHART_VALUE_CHANGE_ONGOING")

An event type being used when the user is in the process of changing the chart value of a MutableChartActivity.

since

1.0

Static CHART_VALUE_CHANGE_STARTED

CHART_VALUE_CHANGE_STARTED: EventType = new EventType(ActivityEvent.ACTIVITY_CHANGE_STARTED, "CHART_VALUE_CHANGE_STARTED")

An event type being used when the user has started changing the chart value of a MutableChartActivity.

since

1.0

Static DRAG_DONE

DRAG_DONE: EventType = new EventType(ActivityEvent.ACTIVITY_CHANGE_FINISHED, "DRAG_DONE")

An event type being used when the user has finished dragging an activity. This event does not necessarily mean that the activity was dropped onto another row.

since

1.0

Static DRAG_FINISHED

DRAG_FINISHED: EventType = new EventType(ActivityEvent.ACTIVITY_CHANGE_FINISHED, "DRAG_FINISHED")

An event type being used when the user has finished dragging an activity from one row to another and changing its start time at the same time (diagonal drag).

since

1.0

Static DRAG_ONGOING

DRAG_ONGOING: EventType = new EventType(ActivityEvent.ACTIVITY_CHANGE_ONGOING, "DRAG_ONGOING")

An event type being used when the user is in the process of dragging an activity from one row to another and changing its start time at the same time (diagonal drag).

since

1.0

Static DRAG_STARTED

DRAG_STARTED: EventType = new EventType(ActivityEvent.ACTIVITY_CHANGE_STARTED, "DRAG_STARTED")

An event type being used when the user has started dragging an activity from one row to another and changing its start time at the same time (diagonal drag).

since

1.0

Static END_TIME_CHANGE_FINISHED

END_TIME_CHANGE_FINISHED: EventType = new EventType(ActivityEvent.ACTIVITY_CHANGE_FINISHED, "END_TIME_CHANGE_FINISHED")

An event type used when the end time of an activity has finished changing.

since

1.0

Static END_TIME_CHANGE_ONGOING

END_TIME_CHANGE_ONGOING: EventType = new EventType(ActivityEvent.ACTIVITY_CHANGE_ONGOING, "END_TIME_CHANGE_ONGOING")

An event type used when the end time of an activity is currently being changed.

since

1.0

Static END_TIME_CHANGE_STARTED

END_TIME_CHANGE_STARTED: EventType = new EventType(ActivityEvent.ACTIVITY_CHANGE_STARTED, "END_TIME_CHANGE_STARTED")

An event type used when the user starts changing the end time of an activity.

since

1.0

Static HORIZONTAL_DRAG_FINISHED

HORIZONTAL_DRAG_FINISHED: EventType = new EventType(ActivityEvent.ACTIVITY_CHANGE_FINISHED, "HORIZONTAL_DRAG_FINISHED")

An event type being used when the user has finished dragging an activity within its row, which means that the start and end time have both changed at the same time.

since

1.0

Static HORIZONTAL_DRAG_ONGOING

HORIZONTAL_DRAG_ONGOING: EventType = new EventType(ActivityEvent.ACTIVITY_CHANGE_ONGOING, "HORIZONTAL_DRAG_ONGOING")

An event type that gets used when the user is in the process of dragging the activity within its row, changing the start and end time at the same time.

since

1.0

Static HORIZONTAL_DRAG_STARTED

HORIZONTAL_DRAG_STARTED: EventType = new EventType(ActivityEvent.ACTIVITY_CHANGE_STARTED, "HORIZONTAL_DRAG_STARTED")

An event type being used when the user has started dragging an activity within its row, which means that the start and end time will both change at the same time.

since

1.0

Static PERCENTAGE_CHANGE_FINISHED

PERCENTAGE_CHANGE_FINISHED: EventType = new EventType(ActivityEvent.ACTIVITY_CHANGE_FINISHED, "PERCENTAGE_CHANGE_FINISHED")

An event type being used when the user has finished changing the percentage complete value of a MutableCompletableActivity.

since

1.0

Static PERCENTAGE_CHANGE_ONGOING

PERCENTAGE_CHANGE_ONGOING: EventType = new EventType(ActivityEvent.ACTIVITY_CHANGE_ONGOING, "PERCENTAGE_CHANGE_ONGOING")

An event type being used when the user is in the process of changing the percentage complete value of a MutableCompletableActivity.

since

1.0

Static PERCENTAGE_CHANGE_STARTED

PERCENTAGE_CHANGE_STARTED: EventType = new EventType(ActivityEvent.ACTIVITY_CHANGE_STARTED, "PERCENTAGE_CHANGE_STARTED")

An event type being used when the user has started changing the percentage complete value of a MutableCompletableActivity.

since

1.0

Static START_TIME_CHANGE_FINISHED

START_TIME_CHANGE_FINISHED: EventType = new EventType(ActivityEvent.ACTIVITY_CHANGE_FINISHED, "START_TIME_CHANGE_FINISHED")

An event type used when the start time of an activity has finished changing.

since

1.0

Static START_TIME_CHANGE_ONGOING

START_TIME_CHANGE_ONGOING: EventType = new EventType(ActivityEvent.ACTIVITY_CHANGE_ONGOING, "START_TIME_CHANGE_ONGOING")

An event type used when the start time of an activity is currently being changed.

since

1.0

Static START_TIME_CHANGE_STARTED

START_TIME_CHANGE_STARTED: EventType = new EventType(ActivityEvent.ACTIVITY_CHANGE_STARTED, "START_TIME_CHANGE_STARTED")

An event type used when the user is about to change the start time of an activity.

since

1.0

Static VERTICAL_DRAG_DONE

VERTICAL_DRAG_DONE: EventType = new EventType(ActivityEvent.ACTIVITY_CHANGE_FINISHED, "VERTICAL_DRAG_DONE")

An event type being used when the user has finished dragging an activity. This event does not necessarily mean that the activity was dropped onto another row.

since

1.02

Static VERTICAL_DRAG_FINISHED

VERTICAL_DRAG_FINISHED: EventType = new EventType(ActivityEvent.ACTIVITY_CHANGE_FINISHED, "VERTICAL_DRAG_FINISHED")

An event type being used when the user has finished dragging an activity from one row to another while preserving the start and end time of the activity.

since

1.0

Static VERTICAL_DRAG_ONGOING

VERTICAL_DRAG_ONGOING: EventType = new EventType(ActivityEvent.ACTIVITY_CHANGE_ONGOING, "VERTICAL_DRAG_ONGOING")

An event type that gets used when the user is in the process of dragging the activity from one row to another while preserving the start and end time of the activity.

since

1.0

Static VERTICAL_DRAG_STARTED

VERTICAL_DRAG_STARTED: EventType = new EventType(ActivityEvent.ACTIVITY_CHANGE_STARTED, "VERTICAL_DRAG_STARTED")

An event type being used when the user has started dragging an activity from one row to another while preserving the start and end time of the activity.

since

1.0

Methods

getActivityRef

  • Returns ActivityRef

getAffectedTimeInterval

  • Returns the entire affected time interval of the change. The method calculates the time interval of the old location of the activity and the time interval of the new location of the activity. The result is the union of these two intervals. This method is useful if the application needs to recompute data for the "affected" region.

    since

    1.0

    Returns TimeInterval

    the time interval affected by the event

getEventType

  • Returns EventType

getNewRow

  • getNewRow(): Row

  • Returns the parent row of an activity after the user performed a change on it (e. g. a vertical drag).

    since

    1.0

    Returns Row

    the new parent row

getOldRow

  • getOldRow(): Row

  • Returns the parent row of an activity before the user performed a change on it (e. g. a vertical drag).

    since

    1.0

    Returns Row

    the original parent row

getOldTime

  • getOldTime(): number

  • Returns the end / start time of an activity before the user performed a change on it.

    since

    1.0

    Returns number

    the original time (e.g. start or end time)

getOldTimeInterval

  • Returns the time interval of an activity before the user performed a change on it.

    since

    1.0

    Returns TimeInterval

    the original time interval

getOldValue

  • getOldValue(): number

  • Returns the value of an activity before the user performed a change on it.

    since

    1.0

    Returns number

    the original value (e.g. a chart value or percentage complete)

isPotentialEndTimeChange

  • isPotentialEndTimeChange(): boolean

  • Determines if the event represents a change of the activity's end time. This is the case for the event types END_TIME_CHANGE_STARTED, END_TIME_CHANGE_ONGOING, and END_TIME_CHANGE_FINISHED.

    since

    1.0

    Returns boolean

    true if the activity's end time might be affected by the event

isPotentialStartTimeChange

  • isPotentialStartTimeChange(): boolean

  • Determines if the event represents a change of the activity's start time. This is the case for the event types START_TIME_CHANGE_STARTED, START_TIME_CHANGE_ONGOING, and START_TIME_CHANGE_FINISHED.

    since

    1.0

    Returns boolean

    true if the activity's start time might be affected by the event

isPotentialTimeIntervalChange

  • isPotentialTimeIntervalChange(): boolean

  • Determines if the event represents a change of the activity's time interval (start and / or end time). This is the case for the event types HORIZONTAL_DRAG_STARTED, HORIZONTAL_DRAG_ONGOING, HORIZONTAL_DRAG_FINISHED, DRAG_STARTED, DRAG_ONGOING, DRAG_FINISHED.

    since

    1.0

    Returns boolean

    true if the activity's time interval might be affected by the event