Class BaseTimelineEngine`Abstract`

Base class for timeline engine implementations (GanttChart, ResourceScheduler).

Hierarchy (View Summary)

BaseTimelineEngine

Index

Constructors

constructor

new BaseTimelineEngine(hostElement: HTMLElement): BaseTimelineEngine
Parameters
- hostElement: HTMLElement
Returns BaseTimelineEngine
- Defined in common/base-engine.ts:36

Accessors

autoZoomToFit

get autoZoomToFit(): boolean
Automatically zoom to fit all data when project timeline is set. Default: true.

Returns boolean
- Defined in common/base-engine.ts:196
set autoZoomToFit(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in common/base-engine.ts:199

calendar$

get calendar$(): BehaviorSubject<WorkingCalendar>
Working calendar observable.

Returns BehaviorSubject<WorkingCalendar>
- Defined in common/base-engine.ts:324
set calendar$(value: WorkingCalendar): void
Parameters
- value: WorkingCalendar
  New working calendar to apply.
Returns void
- Defined in common/base-engine.ts:328

canEdit

get canEdit(): boolean
Whether editing is enabled. When false, all mutations are disabled.

Returns boolean
- Defined in common/base-engine.ts:186
set canEdit(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in common/base-engine.ts:189

canRedo$

get canRedo$(): BehaviorSubject<boolean>
Whether redo is available (observable).

Returns BehaviorSubject<boolean>
- Defined in common/base-engine.ts:231

canUndo$

get canUndo$(): BehaviorSubject<boolean>
Whether undo is available (observable).

Returns BehaviorSubject<boolean>
- Defined in common/base-engine.ts:226

markers

get markers(): Marker[]
Timeline markers (vertical indicator lines).

Returns Marker[]
- Defined in common/base-engine.ts:159
set markers(value: Marker[]): void
Parameters
- value: Marker[]
Returns void
- Defined in common/base-engine.ts:162

projectTimeline

get projectTimeline(): DateRange
Project start/end date bounds.

Returns DateRange
- Defined in common/base-engine.ts:300
set projectTimeline(value: DateRange): void
Parameters
- value: DateRange
Returns void
- Defined in common/base-engine.ts:303

showGridLines

get showGridLines(): boolean
Show or hide grid lines on the chart.

Returns boolean
- Defined in common/base-engine.ts:206
set showGridLines(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in common/base-engine.ts:209

showTodayLine

get showTodayLine(): boolean
Show or hide the today indicator line.

Returns boolean
- Defined in common/base-engine.ts:216
set showTodayLine(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in common/base-engine.ts:219

Methods

addMarker

addMarker(marker: Marker): void
Add a timeline marker.
Parameters
- marker: Marker
Returns void
- Defined in common/base-engine.ts:167

clearMarkers

clearMarkers(): void
Remove all timeline markers.

Returns void
- Defined in common/base-engine.ts:179

`Abstract`copy

copy(): Promise<void>
Returns Promise<void>
- Defined in common/base-engine.ts:56

`Abstract`cut

cut(): Promise<void>
Returns Promise<void>
- Defined in common/base-engine.ts:57

destroy

destroy(): void
Destroy the component and release all DOM resources.

Returns void
- Defined in common/base-engine.ts:376

goToProjectStart

goToProjectStart(): void
Scroll the timeline to the project start date.

Returns void
- Defined in common/base-engine.ts:279

load

load(text: string): void
Load state from a JSON string. Automatically zooms to fit if data is present and autoZoomToFit is enabled.
Parameters
- text: string
Returns void
- Defined in common/base-engine.ts:347

loadColumns

loadColumns(states: ColumnState[]): void
Restore previously saved column widths and order.
Parameters
- states: ColumnState[]
Returns void
- Defined in common/base-engine.ts:340

`Abstract`paste

paste(): Promise<any>
Returns Promise<any>
- Defined in common/base-engine.ts:58

redo

redo(): void
Redo the last undone action.

Returns void
- Defined in common/base-engine.ts:243

removeMarker

removeMarker(marker: Marker): void
Remove a timeline marker.
Parameters
- marker: Marker
Returns void
- Defined in common/base-engine.ts:173

`Abstract`save

save(): string
Returns string
- Defined in common/base-engine.ts:55

saveColumns

saveColumns(): ColumnState[]
Save current column widths and order for later restoration.

Returns ColumnState[]
- Defined in common/base-engine.ts:335

scrollToDate

scrollToDate(date: Date): void
Scroll the timeline to a specific date.
Parameters
- date: Date
Returns void
- Defined in common/base-engine.ts:290

undo

undo(): void
Undo the last action.

Returns void
- Defined in common/base-engine.ts:236

zoomIn

zoomIn(): boolean
Zoom in one level. Returns false if already at maximum zoom.

Returns boolean
- Defined in common/base-engine.ts:252

zoomOut

zoomOut(): boolean
Zoom out one level. Returns false if already at minimum zoom.

Returns boolean
- Defined in common/base-engine.ts:257

`Abstract`zoomToFit

zoomToFit(...args: any[]): void
Parameters
- ...args: any[]
Returns void
- Defined in common/base-engine.ts:59