Class Graph2d

Hierarchy

Graph2d

Constructors

constructor

new Graph2d(container: HTMLElement, items: DataItemCollectionType, groups: DataGroupCollectionType, options?: Graph2dOptions): Graph2d
new Graph2d(container: HTMLElement, items: DataItemCollectionType, options?: Graph2dOptions): Graph2d

Parameters
- container: HTMLElement
- items: DataItemCollectionType
- groups: DataGroupCollectionType
- Optional options: Graph2dOptions
Returns Graph2d
Parameters
- container: HTMLElement
- items: DataItemCollectionType
- Optional options: Graph2dOptions
Returns Graph2d

Methods

addCustomTime

addCustomTime(time: DateType, id?: IdType): IdType

Parameters
- time: DateType
- Optional id: IdType
Returns IdType

destroy

destroy(): void

Returns void

fit

fit(options?: TimelineAnimationOptions): void

Parameters
- Optional options: TimelineAnimationOptions
Returns void

focus

focus(ids: IdType | IdType[], options?: TimelineAnimationOptions): void
focus(selection: any): void

Parameters
- ids: IdType | IdType[]
- Optional options: TimelineAnimationOptions
Returns void
Parameters
- selection: any
Returns void

getCurrentTime

getCurrentTime(): Date

Returns Date

getCustomTime

getCustomTime(id?: IdType): Date

Parameters
- Optional id: IdType
Returns Date

getEventProperties

getEventProperties(event: Event): TimelineEventPropertiesResult

Parameters
- event: Event
Returns TimelineEventPropertiesResult

getItemRange

getItemRange(): any

Returns any

getLegend

getLegend(): TimelineWindow

Returns TimelineWindow

getSelection

getSelection(): IdType[]

Returns IdType[]

getVisibleItems

getVisibleItems(): IdType[]

Returns IdType[]

getWindow

getWindow(): { end: Date; start: Date }
getWindow(): TimelineWindow

Returns { end: Date; start: Date }
- end: Date
- start: Date
Returns TimelineWindow

moveTo

moveTo(time: DateType, options?: TimelineAnimationOptions): void

Parameters
- time: DateType
- Optional options: TimelineAnimationOptions
Returns void

off

off(event: TimelineEvents, callback: () => void): void

Parameters
- event: TimelineEvents
- callback: () => void
  - - (): void
    - Returns void
Returns void

on

on(event: TimelineEvents, callback: () => void): void
on(event?: string, callback?: (properties: any) => void): void

Parameters
- event: TimelineEvents
- callback: () => void
  - - (): void
    - Returns void
Returns void
Parameters
- Optional event: string
- Optional callback: (properties: any) => void
  - - (properties: any): void
    - Parameters
      - properties: any
      Returns void
Returns void

redraw

redraw(): void

Returns void

removeCustomTime

removeCustomTime(id: IdType): void

Parameters
- id: IdType
Returns void

setCurrentTime

setCurrentTime(time: DateType): void

Parameters
- time: DateType
Returns void

setCustomTime

setCustomTime(time: DateType, id?: IdType): void

Parameters
- time: DateType
- Optional id: IdType
Returns void

setCustomTimeTitle

setCustomTimeTitle(title: string, id?: IdType): void

Parameters
- title: string
- Optional id: IdType
Returns void

setData

setData(data: { groups?: DataGroupCollectionType; items?: DataItemCollectionType }): void

Parameters
- data: { groups?: DataGroupCollectionType; items?: DataItemCollectionType }
  - Optional groups?: DataGroupCollectionType
  - Optional items?: DataItemCollectionType
Returns void

setGroups

setGroups(groups?: DataGroupCollectionType): void
setGroups(groups?: TimelineGroup[]): void

Parameters
- Optional groups: DataGroupCollectionType
Returns void
Parameters
- Optional groups: TimelineGroup[]
Returns void

setItems

setItems(items: DataItemCollectionType): void
setItems(items?: TimelineItem[]): void

Parameters
- items: DataItemCollectionType
Returns void
Parameters
- Optional items: TimelineItem[]
Returns void

setOptions

setOptions(options: TimelineOptions): void

Parameters
- options: TimelineOptions
Returns void

setSelection

setSelection(ids: IdType | IdType[]): void

Parameters
- ids: IdType | IdType[]
Returns void

setWindow

setWindow(start: DateType, end: DateType, options?: TimelineAnimationOptions): void
setWindow(start: any, date: any): void

Parameters
- start: DateType
- end: DateType
- Optional options: TimelineAnimationOptions
Returns void
Parameters
- start: any
- date: any
Returns void

Generated using TypeDoc