Options
All
  • Public
  • Public/Protected
  • All
Menu

A control used to visualize any kind of scheduling data along a timeline. The model data needed by the control consists of rows with activities, links between activities, and layers to group activities together.

  • setRoot(Row) - sets the root row.
  • GanttChartBase.getLayers() - returns the list of layers.
  • GanttChartBase.getLinks() - returns the list of links between activities.

The control consists of several children controls:

  • TreeTableView: shown on the left-hand side to display a hierarchical structure of rows.
  • GraphicsBase: shown on the right-hand side to display a graphical representation of the model data.
  • Timeline: shown above the graphics view. The timeline itself consists of two child controls.
  • Dateline: displays days, weeks, months, years, etc...
  • Eventline: displays various time markers.

Type parameters

  • R: Row

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

Hierarchy

Index

Constructors

constructor

  • Constructs a new Gantt Chart control.

    since

    1.0

    Parameters

    • root: R

      the root row of the Gantt chart

    Returns GanttChart

Methods

addRows

  • addRows(...rowsToAdd: R[]): void
  • Parameters

    • Rest ...rowsToAdd: R[]

    Returns void

belowAboveCanvasHeightChanged

  • belowAboveCanvasHeightChanged(): void
  • Returns void

belowAboveCanvasWidthChanged

  • belowAboveCanvasWidthChanged(): void
  • Returns void

collapseRows

  • collapseRows(): void
  • Collapses all rows inside the Gantt chart. This method will use recursion to find all rows that are parents and to collapse them.

    since

    1.0

    Returns void

collapseRowsByOneLevel

  • collapseRowsByOneLevel(): void
  • Collapses the highest level of rows inside the Gantt chart that is currently being used. Successive calls to this method will eventually close the entire tree.

    since

    1.0

    Returns void

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

expandRows

  • expandRows(): void
  • Expands all rows inside the Gantt chart. This method will use recursion to find all rows that are parents and to expand them.

    since

    1.0

    Returns void

expandRowsByOneLevel

  • expandRowsByOneLevel(): void
  • Expands the next level of rows inside the Gantt chart. This method will use recursion to find the first rows that are parents and currently not expanded. It will then expand it to make its children visible. Successive calls to this method will eventually show all rows.

    since

    1.0

    Returns void

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

getDisplayMode

  • A property used to specify the mode in which the Gantt chart will layout its primary views, the table and the graphics. Using this property the application can quickly switch between a standard, table-only, or graphics-only display.

    since

    1.0

    Returns DisplayModeEnum

    the display mode (standard, table only, graphics only)

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

getMaxPixelRatioObs

  • getMaxPixelRatioObs(): Observable<number>

getMediumPixelRatio

  • getMediumPixelRatio(): number

getPixelRatio

  • getPixelRatio(): number

getPixelRatioObs

  • getPixelRatioObs(): 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

getRoot

  • getRoot(): R
  • Returns the root row property. The root row will become the root node of the Gantt chart's tree table control on the left-hand side (wrapped inside an instance of type GanttChartTreeItem). Other rows can be added by adding them to the root row or one of its children.

    since

    1.0

    Returns R

    the root row

getRowHeaderType

  • A property used to store the currently used type of row headers (row number, level number, custom graphics).

    since

    1.0

    Returns RowHeaderTypeEnum

    the currently used row header type (line number, level number, custom graphics)

getShowTreeTable

  • getShowTreeTable(): boolean
  • A property used to control whether the tree table view will be shown or not. This node gets shown on the left-hand side of the Gantt chart and dispays a hierarchy (e.g. a resource hierarchy). The tree table view is the detail node of the primary master detail pane (see getTreeTableMasterDetailPane()).

    since

    1.0

    Returns boolean

    true if the tree table should be shown

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

getWidth

  • getWidth(): number

onDateLinePointerDown

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

onDateLinePointerMove

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

onDatelinePointerLeave

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

onDocumentPointerMovedForDateLine

  • onDocumentPointerMovedForDateLine(pointerEvent: PointerEvent): void

onDocumentPointerUpForDateLine

  • onDocumentPointerUpForDateLine(pointerEvent: PointerEvent): void

onRowsContainerPointerLeave

  • onRowsContainerPointerLeave(pointerEvent: PointerEvent): void
  • Parameters

    • pointerEvent: PointerEvent

    Returns void

onRowsContainerPointerMove

  • onRowsContainerPointerMove(pointerEvent: PointerEvent): void
  • Parameters

    • pointerEvent: PointerEvent

    Returns void

onToggleGrid

  • onToggleGrid(gridName: string): void
  • Parameters

    • gridName: string

    Returns void

onToggleGridAuto

  • onToggleGridAuto(): void
  • Returns void

redraw

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

    • Optional row: Row | undefined

    Returns void

refreshData

  • refreshData(): void
  • Returns void

scrollLeft

  • scrollLeft(): void

scrollLeftFast

  • scrollLeftFast(): void

scrollRight

  • scrollRight(): void

scrollRightFast

  • scrollRightFast(): void

setAboveCanvasElement

  • setAboveCanvasElement(aboveCanvasElement: HTMLCanvasElement): void
  • Parameters

    • aboveCanvasElement: HTMLCanvasElement

    Returns void

setBelowCanvasElement

  • setBelowCanvasElement(belowCanvasElement: HTMLCanvasElement): void
  • Parameters

    • belowCanvasElement: HTMLCanvasElement

    Returns void

setDisplayMode

  • Sets the display mode.

    since

    1.0

    Parameters

    Returns void

setDragContentToScrollDirective

  • setDragContentToScrollDirective(dragContentToScrollDirective: DragContentToScrollDirective): void
  • Parameters

    • dragContentToScrollDirective: DragContentToScrollDirective

    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

setPixelRatio

  • setPixelRatio(value: number): void

setPosition

  • Sets the position of the chart.

    Parameters

    • position: ViewPosition

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

    Returns void

setRoot

  • setRoot(root: R): void
  • Sets a new root on the Gantt chart, which will cause the framework to set a new root of type GanttChartTreeItem on the underlying TreeTableView.

    Parameters

    • root: R

      the new root of the model

    Returns void

setRowHeaderType

  • Sets the currently used row header type.

    since

    1.0

    Parameters

    Returns void

setShowTreeTable

  • setShowTreeTable(show: boolean): void
  • Sets if the tree table should be shown.

    since

    1.0

    Parameters

    • show: boolean

      if true the tree table becomes visible

    Returns void

setViewportHeight

  • setViewportHeight(value: number): void

setWidth

  • setWidth(value: number): void
  • Parameters

    • value: number

    Returns void

showAllActivities

  • showAllActivities(): void

showEarliestActivities

  • showEarliestActivities(): void

showLatestActivities

  • showLatestActivities(): void

showNow

  • showNow(center?: boolean): void
  • Parameters

    • Optional center: boolean

    Returns void

toggleShowMarkedTimeInterval

  • toggleShowMarkedTimeInterval(): void
  • Returns void

zoomIn

  • zoomIn(): void

zoomOut

  • zoomOut(): void