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

Abstract base class for all Gantt chart controls. For detailed information please refer to the documentation on those classes.

since

1.0

Type parameters

  • R: Row

    the type of the rows shown by the Gantt chart (e.g. "Aircraft")

Hierarchy

Index

Methods

Methods

createGraphics

  • Creates the graphics view used by the Gantt chart. Applications can override this method to return a customized graphics view.

    since

    1.0

    Returns SimpleGraphics<R>

    a graphics view instance

createTimeline

  • Creates the timeline component used by the Gantt chart. Applications can override this method to return a customized timeline.

    since

    1.0

    Returns Timeline

    the timeline instance

getCalendars

  • Convenience method to return the list of calendars registered on the graphics view.

    since

    1.0

    see

    GraphicsBase.getCalendars()

    Returns Calendar<CalendarActivity>[]

    the calendars registered on the graphics area

getFixedCellSize

  • getFixedCellSize(): number

  • A property used to set a fixed cell size for the rows shown in the table on the left-hand side and the graphics area on the right-hand side.

    since

    1.0

    Returns number

    the fixed cell size

getGraphics

  • Returns the graphics view shown on the right-hand side of the Gantt chart. The view is set as the master node on the primary MasterDetailPane instance.

    since

    1.0

    see

    createGraphics()

    Returns SimpleGraphics<R>

    the graphics view

getLayers

  • Convenience method to return the list of layers registered on the graphics view.

    since

    1.0

    see

    GraphicsBase.getLayers()

    Returns Layer[]

    the layers registered on the graphics area

getMasterTimeline

  • A property used to store a reference to the timeline that is being considered the "master" timeline. This property is needed when several charts are used in combination with each other (see DualGanttChartContainer or MultiGanttChartContainerBase). The master timeline is the one provided by the Gantt chart located at the top of the container (the "first" chart).

    since

    1.0

    Returns Timeline

    the master timeline

getMaxPixelRatio

  • getMaxPixelRatio(): number

  • Returns number

getMaxPixelRatioObs

  • getMaxPixelRatioObs(): Observable<number>

  • Returns Observable<number>

getMediumPixelRatio

  • getMediumPixelRatio(): number

  • Returns number

getPixelRatio

  • getPixelRatio(): number

  • Returns number

getPixelRatioObs

  • getPixelRatioObs(): Observable<number>

  • Returns Observable<number>

getPosition

  • A property used to store the position of the Gantt chart in a multi Gantt chart context, for example, inside a DualGanttChartContainer or a MultiGanttChartContainerBase. One of the charts will be the first, some will be in the middle, and one will be the last. The first chart is the owner of the master timeline.

    since

    1.0

    Returns ViewPosition

    the position of the chart

getTimeline

  • Returns the Timeline instance, which consists of the Dateline and the Eventline.

    since

    1.0

    see

    createTimeline()

    Returns Timeline

    the timeline control

getViewportHeight

  • getViewportHeight(): number

  • Returns number

getWidth

  • getWidth(): number

  • Returns number

onDateLinePointerDown

  • onDateLinePointerDown(pointerEvent: PointerEvent, scaleIndex: number): void

  • Parameters

    • pointerEvent: PointerEvent
    • scaleIndex: number

    Returns void

onDateLinePointerMove

  • onDateLinePointerMove(pointerEvent: PointerEvent, scaleIndex: number): void

  • Parameters

    • pointerEvent: PointerEvent
    • scaleIndex: number

    Returns void

onDatelinePointerLeave

  • onDatelinePointerLeave(pointerEvent: PointerEvent, scaleIndex: number): void

  • Parameters

    • pointerEvent: PointerEvent
    • scaleIndex: number

    Returns void

onDocumentPointerMovedForDateLine

  • onDocumentPointerMovedForDateLine(pointerEvent: PointerEvent): void

  • Parameters

    • pointerEvent: PointerEvent

    Returns void

onDocumentPointerUpForDateLine

  • onDocumentPointerUpForDateLine(pointerEvent: PointerEvent): void

  • Parameters

    • pointerEvent: PointerEvent

    Returns void

onToggleGrid

  • onToggleGrid(gridName: string): void

  • Parameters

    • gridName: string

    Returns void

redraw

  • redraw(row?: Row | undefined): void

  • Parameters

    • Optional row: Row | undefined

    Returns void

scrollLeft

  • scrollLeft(): void

  • Returns void

scrollLeftFast

  • scrollLeftFast(): void

  • Returns void

scrollRight

  • scrollRight(): void

  • Returns void

scrollRightFast

  • scrollRightFast(): void

  • Returns void

setFixedCellSize

  • setFixedCellSize(size: number): void

  • Sets the fixed cell size.

    since

    1.0

    Parameters

    • size: number

      the fixed cell size

    Returns void

setMasterTimeline

  • setMasterTimeline(timeline: Timeline): void

  • Sets the master timeline.

    since

    1.0

    Parameters

    • timeline: Timeline

      the new master timeline

    Returns void

setMaxPixelRatio

  • setMaxPixelRatio(value: number): void

  • Parameters

    • value: number

    Returns void

setPixelRatio

  • setPixelRatio(value: number): void

  • Parameters

    • value: number

    Returns void

setPosition

  • Sets the position of the chart.

    Parameters

    • position: ViewPosition

      the chart position (first, last, middle, only)

    Returns void

setViewportHeight

  • setViewportHeight(value: number): void

  • Parameters

    • value: number

    Returns void

setWidth

  • setWidth(value: number): void

  • Parameters

    • value: number

    Returns void

showAllActivities

  • showAllActivities(): void

  • Returns void

showEarliestActivities

  • showEarliestActivities(): void

  • Returns void

showLatestActivities

  • showLatestActivities(): void

  • Returns void

showNow

  • showNow(center?: boolean): void

  • Parameters

    • Optional center: boolean

    Returns void

zoomIn

  • zoomIn(): void

  • Returns void

zoomOut

  • zoomOut(): void

  • Returns void