Class Chart<TItemType, XDimensionType, YDimensionType>

Type Parameters

TItemType = any
XDimensionType extends number | string | Date = number | string | Date
YDimensionType extends number | string | Date | undefined = undefined

Hierarchy

Chart

Implements

Index

Constructors

constructor

Accessors

id location minZoomLevel renderer screenRect size visibleRect visibleRectAsNumeric

Constructors

constructor

new Chart<TItemType, XDimensionType, YDimensionType>(elementSelector: string, dataSet: DataSet<TItemType, XDimensionType, YDimensionType>, options: ChartOptions, visibleRect?: undefined | DataRect<XDimensionType, YDimensionType extends undefined ? number : Exclude<YDimensionType, undefined>>, plotFactory?: PlotFactory, keyboardNavigationsFactory?: KeyboardNavigationsFactory): Chart<TItemType, XDimensionType, YDimensionType>
Creates new instance of chart.
Type Parameters
- TItemType = any
- XDimensionType extends string | number | Date = string | number | Date
- YDimensionType extends undefined | string | number | Date = undefined
Parameters
- elementSelector: string
  
  element selector.
- dataSet: DataSet<TItemType, XDimensionType, YDimensionType>
  
  DataSet with data for this chart.
- options: ChartOptions
  
  Chart options.
- visibleRect: undefined | DataRect<XDimensionType, YDimensionType extends undefined ? number : Exclude<YDimensionType, undefined>> = undefined
  
  Currently visible rectangle on chart.
- plotFactory: PlotFactory = PlotFactory.Instance
  
  injected factory to create plots based on options.
- keyboardNavigationsFactory: KeyboardNavigationsFactory = KeyboardNavigationsFactory.Instance
  
  injected factory to create keyboard navigation.
Returns Chart<TItemType, XDimensionType, YDimensionType>
- Defined in projects/some-charts-lib/src/chart/chart.ts:131

Properties

`Private` `Readonly` _id

_id: number

`Private` `Readonly` _location

_location: NumericPoint

`Private` _renderer

_renderer: Renderer

`Private` _screenRect

_screenRect: undefined | NumericDataRect

`Private` _size

_size: Size

`Private` _visibleRect

_visibleRect: undefined | DataRect<XDimensionType, YDimensionType extends undefined ? number : Exclude<YDimensionType, undefined>>

`Private` _visibleRectAsNumeric

_visibleRectAsNumeric: NumericDataRect

`Private` chartGrid

chartGrid: Grid

`Private` `Readonly` contentItems

contentItems: ChartRenderableItem<Group | Shape<ShapeConfig>>[]

`Private` dataSet

dataSet: DataSet<TItemType, XDimensionType, YDimensionType>

`Private` dataTransformation

dataTransformation: DataTransformation

`Private` element

element: undefined | HTMLElement

`Private` elementSelector

elementSelector: string

`Private` `Readonly` headerLabel

headerLabel: undefined | Label

`Private` `Optional` horizontalAxis

horizontalAxis?: AxisBase<any, any>

`Private` isAsyncFitToViewRequired

isAsyncFitToViewRequired: boolean = false

`Private` isDisposed

isDisposed: boolean = false

`Private` isFitToViewModeEnabled

isFitToViewModeEnabled: boolean

`Private` jqueryElt

jqueryElt: JQuery<HTMLElement>

`Private` `Readonly` keyboardNavigation

keyboardNavigation: undefined | KeyboardNavigation

`Private` keyboardNavigationsFactory

keyboardNavigationsFactory: KeyboardNavigationsFactory = KeyboardNavigationsFactory.Instance

injected factory to create keyboard navigation.

`Private` layersConfigs

layersConfigs: LayerConfig[]

`Private` legend

legend: undefined | Legend

`Private` `Readonly` mouseNavigation

mouseNavigation: undefined | MouseNavigation

`Private` options

options: ChartOptions

`Private` plotFactory

plotFactory: PlotFactory = PlotFactory.Instance

injected factory to create plots based on options.

`Private` `Readonly` plots

plots: Plot<PlotOptions, PlotOptionsClass, TItemType, XDimensionType, YDimensionType>[]

`Private` resizeSensor

resizeSensor: undefined | ResizeSensor

`Private` resizeSensorCallback

resizeSensorCallback: (() => void)

Type declaration

- (): void
- Returns void

`Private` `Optional` verticalAxis

verticalAxis?: AxisBase<any, any>

`Static` `Readonly` MinZoomLevel

MinZoomLevel: number = 1e-8

`Static` `Private` currentChartId

currentChartId: number = 1

Accessors

id

get id(): number
Returns number
- Defined in projects/some-charts-lib/src/chart/chart.ts:89

location

get location(): NumericPoint
Returns NumericPoint
- Defined in projects/some-charts-lib/src/chart/chart.ts:93

minZoomLevel

get minZoomLevel(): number
Returns number
- Defined in projects/some-charts-lib/src/chart/chart.ts:537

visibleRect

get visibleRect(): undefined | DataRect<XDimensionType, YDimensionType extends undefined ? number : Exclude<YDimensionType, undefined>>
Returns undefined | DataRect<XDimensionType, YDimensionType extends undefined ? number : Exclude<YDimensionType, undefined>>
- Defined in projects/some-charts-lib/src/chart/chart.ts:101

visibleRectAsNumeric

get visibleRectAsNumeric(): NumericDataRect
Returns NumericDataRect
- Defined in projects/some-charts-lib/src/chart/chart.ts:109

Methods

addContentItem

addContentItem(contentItem: ChartRenderableItem<Group | Shape<ShapeConfig>>): void
Parameters
- contentItem: ChartRenderableItem<Group | Shape<ShapeConfig>>
Returns void
- Defined in projects/some-charts-lib/src/chart/chart.ts:270

`Private` addMarginToBoundingRect

addMarginToBoundingRect(boundingRect: NumericDataRect, margin: Margin): NumericDataRect
Parameters
- boundingRect: NumericDataRect
- margin: Margin
Returns NumericDataRect
- Defined in projects/some-charts-lib/src/chart/chart.ts:436

addPlot

addPlot(plot: Plot<PlotOptions, PlotOptionsClass, TItemType, XDimensionType, YDimensionType>): void
Parameters
- plot: Plot<PlotOptions, PlotOptionsClass, TItemType, XDimensionType, YDimensionType>
Returns void
- Defined in projects/some-charts-lib/src/chart/chart.ts:281

`Private` buildLegend

buildLegend(plotOptionsArr: PlotOptionsClass[]): void
Parameters
- plotOptionsArr: PlotOptionsClass[]
Returns void
- Defined in projects/some-charts-lib/src/chart/chart.ts:516

`Private` createAxis

createAxis(dataTransformation: DataTransformation, orientation: AxisOrientation, options: AxisOptions): undefined | AxisBase<any, any>
Parameters
- dataTransformation: DataTransformation
- orientation: AxisOrientation
- options: AxisOptions
Returns undefined | AxisBase<any, any>
- Defined in projects/some-charts-lib/src/chart/chart.ts:449

`Protected` dimensionalVisibleRectToNumeric

dimensionalVisibleRectToNumeric(visibleRect: DataRect<XDimensionType, YDimensionType extends undefined ? number : Exclude<YDimensionType, undefined>>): NumericDataRect
Parameters
- visibleRect: DataRect<XDimensionType, YDimensionType extends undefined ? number : Exclude<YDimensionType, undefined>>
Returns NumericDataRect
- Defined in projects/some-charts-lib/src/chart/chart.ts:558

dispose

dispose(): void
Returns void
Implementation of IDisposable.dispose
- Defined in projects/some-charts-lib/src/chart/chart.ts:525

eventCallback

eventCallback(event: EventBase<Changed | Tick>, options?: any): void
Parameters
- event: EventBase<Changed | Tick>
- Optional options: any
Returns void
Implementation of EventListener.eventCallback
- Defined in projects/some-charts-lib/src/chart/chart.ts:484

fitToView

fitToView(): void
Fits all plots on chart to view them

Returns void
- Defined in projects/some-charts-lib/src/chart/chart.ts:391

getLayer

getLayer(layerId: string): undefined | Layer
Parameters
- layerId: string
Returns undefined | Layer
- Defined in projects/some-charts-lib/src/chart/chart.ts:265

getPlotSize

getPlotSize(): Size
Returns Size
- Defined in projects/some-charts-lib/src/chart/chart.ts:444

`Protected` numericVisibleRectToDimensional

numericVisibleRectToDimensional(visibleRectAsNumeric: NumericDataRect): undefined | DataRect<XDimensionType, YDimensionType extends undefined ? number : Exclude<YDimensionType, undefined>>
Parameters
- visibleRectAsNumeric: NumericDataRect
Returns undefined | DataRect<XDimensionType, YDimensionType extends undefined ? number : Exclude<YDimensionType, undefined>>
- Defined in projects/some-charts-lib/src/chart/chart.ts:566

onChartElementResized

onChartElementResized(): void
Returns void
- Defined in projects/some-charts-lib/src/chart/chart.ts:541

`Private` onFrameRenderedCycle

onFrameRenderedCycle(): void
Returns void
- Defined in projects/some-charts-lib/src/chart/chart.ts:547

removeContentItem

removeContentItem(contentItem: ChartRenderableItem<Group | Shape<ShapeConfig>>): void
Parameters
- contentItem: ChartRenderableItem<Group | Shape<ShapeConfig>>
Returns void
- Defined in projects/some-charts-lib/src/chart/chart.ts:274

update

update(visibleRect: DataRect<XDimensionType, YDimensionType extends undefined ? number : Exclude<YDimensionType, undefined>>, isTriggeredByInputDevice?: boolean): void
Updates chart's visible rectangle, using dimension values.
Parameters
- visibleRect: DataRect<XDimensionType, YDimensionType extends undefined ? number : Exclude<YDimensionType, undefined>>
  
  new visible rectangle for chart
- isTriggeredByInputDevice: boolean = false
  
  whether this update is triggered by user input device (Mouse, Keyboard, etc) or not.
Returns void
- Defined in projects/some-charts-lib/src/chart/chart.ts:290

`Protected` updateLabeledAxesLabels

updateLabeledAxesLabels(): void
Returns void
- Defined in projects/some-charts-lib/src/chart/chart.ts:498

updateNumeric

updateNumeric(visibleRectAsNumeric: NumericDataRect, isTriggeredByInputDevice?: boolean): void
Updates chart's visible rectangle, using numeric values.
Parameters
- visibleRectAsNumeric: NumericDataRect
  
  new visible rectangle for chart in numeric units
- isTriggeredByInputDevice: boolean = false
  
  whether this update is triggered by user input device (Mouse, Keyboard, etc) or not.
Returns void
- Defined in projects/some-charts-lib/src/chart/chart.ts:303

`Static` `Private` createLayers

createLayers(renderer: Renderer, layersConfigs: LayerConfig[]): void
Parameters
- renderer: Renderer
- layersConfigs: LayerConfig[]
Returns void
- Defined in projects/some-charts-lib/src/chart/chart.ts:480

`Static` `Private` getCommonLayersIds

getCommonLayersIds(): LayerId[]
Returns LayerId[]
- Defined in projects/some-charts-lib/src/chart/chart.ts:476

`Static` `Private` getNextId

getNextId(): number
Returns number
- Defined in projects/some-charts-lib/src/chart/chart.ts:440

Class Chart<TItemType, XDimensionType, YDimensionType>

Type Parameters

TItemType = any

XDimensionType extends number | string | Date = number | string | Date

YDimensionType extends number | string | Date | undefined = undefined

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

TItemType = any

XDimensionType extends string | number | Date = string | number | Date

YDimensionType extends undefined | string | number | Date = undefined

Parameters

elementSelector: string

dataSet: DataSet<TItemType, XDimensionType, YDimensionType>

options: ChartOptions

visibleRect: undefined | DataRect<XDimensionType, YDimensionType extends undefined ? number : Exclude<YDimensionType, undefined>> = undefined

plotFactory: PlotFactory = PlotFactory.Instance

keyboardNavigationsFactory: KeyboardNavigationsFactory = KeyboardNavigationsFactory.Instance

Returns Chart<TItemType, XDimensionType, YDimensionType>

Properties

Private Readonly _id

Private Readonly _location

Private _renderer

Private _screenRect

Private _size

Private _visibleRect

Private _visibleRectAsNumeric

Private chartGrid

Private Readonly contentItems

Private dataSet

Private dataTransformation

Private element

Private elementSelector

Private Readonly headerLabel

Private Optional horizontalAxis

Private isAsyncFitToViewRequired

Private isDisposed

Private isFitToViewModeEnabled

Private jqueryElt

Private Readonly keyboardNavigation

Private keyboardNavigationsFactory

Private layersConfigs

Private legend

Private Readonly mouseNavigation

Private options

Private plotFactory

Private Readonly plots

Private resizeSensor

Private resizeSensorCallback

Type declaration

Returns void

Private Optional verticalAxis

Static Readonly MinZoomLevel

Static Private currentChartId

Accessors

id

Returns number

location

Returns NumericPoint

minZoomLevel

Returns number

renderer

Returns Renderer

screenRect

Returns NumericDataRect

size

Returns Size

visibleRect

Returns undefined | DataRect<XDimensionType, YDimensionType extends undefined ? number : Exclude<YDimensionType, undefined>>

visibleRectAsNumeric

Returns NumericDataRect

Methods

addContentItem

`Private` `Readonly` _id

`Private` `Readonly` _location

`Private` _renderer

`Private` _screenRect

`Private` _size

`Private` _visibleRect

`Private` _visibleRectAsNumeric

`Private` chartGrid

`Private` `Readonly` contentItems

`Private` dataSet

`Private` dataTransformation

`Private` element

`Private` elementSelector

`Private` `Readonly` headerLabel

`Private` `Optional` horizontalAxis

`Private` isAsyncFitToViewRequired

`Private` isDisposed

`Private` isFitToViewModeEnabled

`Private` jqueryElt

`Private` `Readonly` keyboardNavigation

`Private` keyboardNavigationsFactory

`Private` layersConfigs

`Private` legend

`Private` `Readonly` mouseNavigation

`Private` options

`Private` plotFactory

`Private` `Readonly` plots

`Private` resizeSensor

`Private` resizeSensorCallback

`Private` `Optional` verticalAxis

`Static` `Readonly` MinZoomLevel

`Static` `Private` currentChartId

`Private` addMarginToBoundingRect

`Private` buildLegend

`Private` createAxis

`Protected` dimensionalVisibleRectToNumeric

`Optional` options: any

`Protected` numericVisibleRectToDimensional

`Private` onFrameRenderedCycle

`Protected` updateLabeledAxesLabels

`Static` `Private` createLayers