Options
All
  • Public
  • Public/Protected
  • All
Menu

A calendar is an extension of an activity repository with the additions of a name and a visibility property. Calendars can be added to the whole Gantt chart or to individual rows within the Gantt chart.

since

1.0

see

Row.getCalendars()

Type parameters

Hierarchy

Implemented by

Index

Methods

getActivities

  • getActivities(layer: Layer, startTime: number, endTine: number, temporalUnit: TemporalUnit, zoneId: ZoneId): A[]
  • Returns an array for iterating over all activities found for the given layer and time interval. This method has to return very fast as it gets called many times during rendering of the chart. A slow implementation will have a direct impact on scrolling / rendering performance.

    since

    1.0

    Parameters

    • layer: Layer

      the layer for which to return the activities

    • startTime: number

      the start time of the time interval for which to return the activities

    • endTine: number

      the end time of the time interval for which to return the activities

    • temporalUnit: TemporalUnit

      the temporal unit currently displayed in the dateline

    • zoneId: ZoneId

      the timezone currently displayed in the dateline

    Returns A[]

    the activities on the given layer and in the given time interval

getEarliestTimeUsed

  • getEarliestTimeUsed(): number
  • Returns the earliest time used by the activities stored in this repository / on this row. This method gets used for navigation (e.g. "scroll to earliest time used in the Gantt chart", "zoom out to show all activities").

    since

    1.0

    Returns number

    the earliest time used by the activities in this repository / row (null if no activities found)

getLatestTimeUsed

  • getLatestTimeUsed(): number
  • Returns the latest time used by the activities stored in this repository / on this row. This method gets used for navigation (e.g. "scroll to latest time used in the Gantt chart", "zoom out to show all activities").

    since

    1.0

    Returns number

    the latest time used by the activities in this repository / row (null if no activities found)

getName

  • getName(): string
  • Returns the name of the calendar. The name might be displayed by the UI (e.g. in a context menu).

    since

    1.0

    Returns string

isVisible

  • isVisible(): boolean
  • Returns the visibility flag of the calendar. Calendars can be shown / hidden by the user.

    since

    1.0

    Returns boolean

setName

  • setName(name: string): void
  • Sets the name of the calendar.

    since

    1.0

    Parameters

    • name: string

      name of the calendar

    Returns void

setVisible

  • setVisible(visible: boolean): void
  • Sets the visibility flag of the calendar. Calendars can be shown / hidden by the user.

    since

    1.0

    Parameters

    • visible: boolean

      visibility flag of the calendar

    Returns void