Class SchedulerData

constructor

• new SchedulerData(): SchedulerData

  Returns SchedulerData

complexOperationFinished$

eventAdded$

eventChanged$

eventRemoved$

filterChanged$

frozenChanged$

resourceAdded$

resourceChanged$

resourceRemoved$

eventsLength

• get eventsLength(): number

  Total number of events.

  Returns number

filter

• get filter(): SchedulerResourceFilterFn | null

  Active resource filter function. Set to null to show all resources.

  Returns SchedulerResourceFilterFn | null

• set filter(value: SchedulerResourceFilterFn | null): void

  Parameters

  • value: SchedulerResourceFilterFn | null

  Returns void

frozenResourceIds

• get frozenResourceIds(): ReadonlySet<string>

  Set of IDs of all frozen (pinned) resources.

  Returns ReadonlySet<string>

frozenResourcesCount

• get frozenResourcesCount(): number

  Number of currently frozen resources.

  Returns number

maxEndTime

• get maxEndTime(): Date | null

  Latest end time across all events, or null if no events exist.

  Returns Date | null

minStartTime

• get minStartTime(): Date | null

  Earliest start time across all events, or null if no events exist.

  Returns Date | null

orderedResources

• get orderedResources(): SchedulerResource[]

  Returns visible resources in display order: frozen first (preserving original order), then non-frozen. Filtered resources are excluded.

  Returns SchedulerResource[]

resourcesLength

• get resourcesLength(): number

  Total number of resources.

  Returns number

addEvent

• addEvent(event: SchedulerEvent): void

  Add an event. The event's resource must already exist.

  Parameters

  • event: SchedulerEvent

  Returns void

addResource

• addResource(resource: SchedulerResource): void

  Add a resource. Throws if a resource with the same ID already exists.

  Parameters

  • resource: SchedulerResource

  Returns void

assignEvents

• assignEvents(events: SchedulerEvent[]): void

  Replace all events with a new set.

  Parameters

  • events: SchedulerEvent[]

  Returns void

assignResources

• assignResources(resources: SchedulerResource[]): void

  Replace all resources with a new set. Clears frozen state.

  Parameters

  • resources: SchedulerResource[]

  Returns void

freezeResource

• freezeResource(resource: SchedulerResource): void

  Pin a resource to the top of the view.

  Parameters

  • resource: SchedulerResource

  Returns void

getEvent

• getEvent(index: number): SchedulerEvent

  Get an event by index.

  Parameters

  • index: number

  Returns SchedulerEvent

getEventById

• getEventById(id: string): SchedulerEvent | null

  Find an event by ID, or null if not found.

  Parameters

  • id: string

  Returns SchedulerEvent | null

getEventColor

• getEventColor(event: SchedulerEvent): ColorValue

  Resolves the effective color for an event: event.color → resource.color → resource ordered index.

  Parameters

  • event: SchedulerEvent

  Returns ColorValue

getEventLane

• getEventLane(event: SchedulerEvent): number

  Get the 0-based lane index an event is placed in.

  Parameters

  • event: SchedulerEvent

  Returns number

getEventsForResource

• getEventsForResource(resourceId: string): SchedulerEvent[]

  Get all events assigned to a resource.

  Parameters

  • resourceId: string

  Returns SchedulerEvent[]

getLaneCount

• getLaneCount(resourceId: string): number

  Get the number of parallel lanes needed for a resource's events.

  Parameters

  • resourceId: string

  Returns number

getOverlappingEvents

• getOverlappingEvents(
      resourceId: string,
      startTime: Date,
      endTime: Date,
      excludeEventId?: string,
  ): SchedulerEvent[]

  Get all events that overlap with a given time range on a resource.

  Parameters

  • resourceId: string
  • startTime: Date
  • endTime: Date
  • OptionalexcludeEventId: string

  Returns SchedulerEvent[]

getResource

• getResource(index: number): SchedulerResource

  Get a resource by index.

  Parameters

  • index: number

  Returns SchedulerResource

getResourceById

• getResourceById(id: string): SchedulerResource | null

  Find a resource by ID, or null if not found.

  Parameters

  • id: string

  Returns SchedulerResource | null

hasConflict

• hasConflict(event: SchedulerEvent): boolean

  Check whether an event overlaps with any other event on the same resource.

  Parameters

  • event: SchedulerEvent

  Returns boolean

indexOfResource

• indexOfResource(resource: SchedulerResource): number

  Get the index of a resource in the internal array.

  Parameters

  • resource: SchedulerResource

  Returns number

insertResource

• insertResource(index: number, resource: SchedulerResource): void

  Insert a resource at a specific index.

  Parameters

  • index: number
  • resource: SchedulerResource

  Returns void

isResourceFrozen

• isResourceFrozen(resource: SchedulerResource): boolean

  Check whether a resource is pinned to the top.

  Parameters

  • resource: SchedulerResource

  Returns boolean

moveResource

• moveResource(resource: SchedulerResource, toIndex: number): void

  Move a resource to a new index position.

  Parameters

  • resource: SchedulerResource
  • toIndex: number

  Returns void

orderedIndexOf

• orderedIndexOf(resource: SchedulerResource): number

  Returns the display index of a resource (in ordered view).

  Parameters

  • resource: SchedulerResource

  Returns number

removeEvent

• removeEvent(event: SchedulerEvent): void

  Remove an event.

  Parameters

  • event: SchedulerEvent

  Returns void

removeResource

• removeResource(resource: SchedulerResource): void

  Remove a resource and all its events.

  Parameters

  • resource: SchedulerResource

  Returns void

removeResources

• removeResources(resources: SchedulerResource[]): void

  Remove multiple resources and their events.

  Parameters

  • resources: SchedulerResource[]

  Returns void

sortResources

• sortResources(
      compareFn: (a: SchedulerResource, b: SchedulerResource) => number,
  ): void

  Sort resources using a comparison function.

  Parameters

  • compareFn: (a: SchedulerResource, b: SchedulerResource) => number

  Returns void

unfreezeResource

• unfreezeResource(resource: SchedulerResource): void

  Unpin a resource from the top of the view.

  Parameters

  • resource: SchedulerResource

  Returns void