API index

useSchedule

Declares a schedule: hands back Schedule and the parts declared inside it - Lane, LaneGroup, Subtasks, Dependencies, BlockedTimes, Milestones -, its view and the setters setView, setDomain, toggleGroup, foldAll and unfoldAll. A ref on Schedule still gives the ScheduleHandle.

function useSchedule(options?: ScheduleOptions): ScheduleParts;

Used on Scenarios, Installation, First schedule, Lanes, Lane groups, Subtasks, Bar labels, Appearances, Overlap, Dependencies, Routes, Time axis and calendar, Blocked time, Milestones, Now line, Pan and zoom, Selection, Interactions, Tooltip, View, Linked schedules, The handle, Findings as data, Move and lane, Stretch, lead-in, lead-out, Snapping, Placing from outside, Where a subtask may go, Ripple and Benchmark.

applyIntent

The subtask as the intent asks for it. An intent for another subtask leaves it as it is.

function applyIntent<S extends Subtask>(subtask: S, intent: Intent): S;

Used on Scenarios, Lane groups, Time axis and calendar, Blocked time, Interactions, Move and lane, Stretch, lead-in, lead-out, Snapping, Placing from outside, Where a subtask may go and Ripple.

arrival

When a dependency has to have arrived at its subtask, by its anchor.

function arrival(dependency: Dependency, to: Subtask): number;

Used on Scenarios, Now line and Findings as data.

departure

When a dependency leaves its subtask, by its anchor.

function departure(dependency: Dependency, from: Subtask): number;

Used on Findings as data.

findings

Every finding at once. Without blocked time there is none in it.

function findings(subtasks: readonly Subtask[], dependencies: readonly Dependency[], blocked?: readonly BlockedTime[]): Findings;

Used on Scenarios, First schedule, Lane groups, Blocked time, Tooltip and Findings as data.

inBlockedTime

Every subtask that covers blocked time on its lane, lead-in and lead-out included - once per blocked interval it covers, in the order of the subtasks. Touching at a shared edge is not covering.

function inBlockedTime(subtasks: readonly Subtask[], blocked: readonly BlockedTime[]): InBlockedTime[];

Used on Scenarios, Blocked time and Findings as data.

occupied

The interval a subtask occupies on its lane: lead-in and lead-out included.

function occupied(subtask: Subtask): {
    from: number;
    to: number;
};

overlaps

Every pair of subtasks that cover each other on a lane. Touching at a shared edge is not covering, and a subtask that covers no time covers nothing.

function overlaps(subtasks: readonly Subtask[]): Overlap[];

Used on Scenarios, Lane groups, Findings as data and Move and lane.

resolveAppearance

Settles a subtask's appearances into what is drawn. provisional and fixed contradict each other; the later one in the list wins.

• appearance – The subtask's appearance, in the order it was given.
• Returns Which of the four channels are on.

function resolveAppearance(appearance: readonly SubtaskAppearance[] | undefined): ResolvedAppearance;

Used on Appearances.

ripple

The moves that push every successor whose dependency no longer fits after intent - transitively, in the order they were first pushed. The subtask the intent is about is never moved, and a cycle among the successors ends after a bounded number of pushes instead of running on.

function ripple(subtasks: readonly Subtask[], dependencies: readonly Dependency[], intent: Intent): MoveIntent[];

Used on Scenarios, Dependencies and Ripple.

shiftTask

The moves that carry a whole task in time - every subtask of it by the same amount, so that its lengths and the distances between its stops stay as they were. The schedule never runs it: apply the moves like any other intent, or run ripple over them first.

• subtasks – All subtasks; only those of task are moved.
• task – The id of the task, as its subtasks name it in task.
• by – How far, in milliseconds; negative is earlier.
• Returns One move intent per subtask of the task - none where by is zero or not finite.

function shiftTask(subtasks: readonly Subtask[], task: string, by: number): MoveIntent[];

Used on Scenarios and Ripple.

snapTime

time onto the nearest line of the raster in local time - a step alone starts at local midnight. A step of zero or less is no raster: the time stays as it is.

function snapTime(time: number, raster: number | SnapRaster): number;

Used on Snapping.

subtaskFromPlace

The subtask a place intent asks for, under an id the caller chooses.

function subtaskFromPlace(intent: PlaceIntent, id: string): Subtask;

Used on Placing from outside and Where a subtask may go.

violatedDependencies

Every dependency whose successor is to be reached before the predecessor's departure plus the dependency's lag. A dependency naming a subtask that is not in the data is passed over: there is nothing to judge.

function violatedDependencies(subtasks: readonly Subtask[], dependencies: readonly Dependency[]): ViolatedDependency[];

Used on Scenarios, Lane groups, Tooltip and Findings as data.

BlockedTime

Its table stands on Blocked time.

Used on Scenarios, Blocked time, Tooltip, Findings as data and Where a subtask may go.

BlockedTimesProps

Its table stands on Blocked time.

DependenciesProps

Its table stands on Dependencies.

Dependency

Its table stands on Dependencies.

Used on Scenarios, Installation, First schedule, Lane groups, Dependencies, Routes, Time axis and calendar, Selection, Interactions, Tooltip, Findings as data, Move and lane, Placing from outside, Ripple and Benchmark.

type DependencyAttachment = "centre" | "nearest";

Used on Dependencies.

type DependencyEnds = "dot" | "none";

Used on Dependencies.

InBlockedTime

Its table stands on Findings as data.

type Intent = MoveIntent | StretchIntent | LeadInIntent | LeadOutIntent | LaneIntent | PlaceIntent;

Used on Scenarios, Blocked time, Move and lane, Placing from outside, Where a subtask may go and Ripple.

LaneGroupProps

Its table stands on Lane groups.

LaneProps

Its table stands on Lanes.

Milestone

Its table stands on Milestones.

Used on Milestones.

MilestonesProps

Its table stands on Milestones.

Used on Ripple.

Overlap

Its table stands on Findings as data.

Used on Placing from outside and Where a subtask may go.

Used on The handle.

ScheduleInteraction

Its table stands on Interactions.

Used on Scenarios, Interactions, Tooltip and Benchmark.

ScheduleOptions

Its table stands on View.

Used on Linked schedules.

ScheduleProps

Its table stands on First schedule.

ScheduleTooltipTarget

Its table stands on Tooltip.

Used on Milestones and Tooltip.

ScheduleView

Its table stands on View.

Used on View.

Used on Snapping.

Subtask

Its table stands on Subtasks.

Used on Scenarios, Installation, First schedule, Lanes, Lane groups, Subtasks, Bar labels, Appearances, Overlap, Dependencies, Routes, Time axis and calendar, Blocked time, Milestones, Now line, Pan and zoom, Selection, Interactions, Tooltip, View, Linked schedules, The handle, Findings as data, Move and lane, Stretch, lead-in, lead-out, Snapping, Placing from outside, Where a subtask may go, Ripple and Benchmark.

SubtasksProps

Its table stands on Subtasks.

Task

Its table stands on Subtasks.

Used on Scenarios, Installation, First schedule, Lanes, Lane groups, Subtasks, Bar labels, Appearances, Overlap, Dependencies, Routes, Time axis and calendar, Blocked time, Milestones, Now line, Pan and zoom, Selection, Interactions, Tooltip, View, Linked schedules, The handle, Findings as data, Move and lane, Stretch, lead-in, lead-out, Snapping, Placing from outside, Where a subtask may go, Ripple and Benchmark.

ViolatedDependency

Its table stands on Findings as data.

Used on Dependencies.