Class Chart3D

Properties

engine

engine: PublicEngine

pixelScale

pixelScale: Vec2<Scale>

uiScale

uiScale: Vec2<Scale>

Methods

addLegendBox

addLegendBox(builder: UIElementBuilder<UIElementType>, scale: Vec2<Scale>): UIElementType & UIElement

Type parameters
- UIElementType: UIPart
Parameters
- Default value builder: UIElementBuilder<UIElementType>
- Default value scale: Vec2<Scale>
Returns UIElementType & UIElement

LegendBox that fulfills interfaces: UIElementType (typeparam) and UIElement

addLineSeries

addLineSeries(): LineSeries3D

Returns LineSeries3D

LineSeries3D.

addPointLineSeries

addPointLineSeries(options: PointLineSeriesOptions3D): PointLineSeries3D

Parameters
- Optional options: PointLineSeriesOptions3D
Returns PointLineSeries3D

PointLineSeries3D.

addPointSeries

addPointSeries(options: PointSeriesOptions3D<T>): InstanceType<T>

Type parameters
- T: PointSeriesTypes3D
Parameters
- Optional options: PointSeriesOptions3D<T>
Returns InstanceType<T>

Created Series. If options were omitted or undefined, the Series type defaults to PointSeries3D, otherwise corresponds to class referenced by options.type.

addUIElement

addUIElement(builder: UIElementBuilder<UIElementType>, scale: Vec2<Scale>): UIElementType & UIElement

Type parameters
- UIElementType: UIPart
Parameters
- Default value builder: UIElementBuilder<UIElementType>
- Default value scale: Vec2<Scale>
Returns UIElementType & UIElement

Object that fulfills interfaces: UIElementType (typeparam) and UIElement

disableAnimations

disableAnimations(): this

Returns this

Chart itself for fluent interface.

dispose

dispose(): this

Returns this

Object itself for fluent interface

forEachAxis

forEachAxis(clbk: function): void

Parameters
- clbk: function
  - - Parameters
      - axis: Axis3D
      Returns void
Returns void

getBackgroundFillStyle

getBackgroundFillStyle(): FillStyle

Returns FillStyle

FillStyle

getBackgroundStrokeStyle

getBackgroundStrokeStyle(): LineStyle

Returns LineStyle

LineStyle

getBoundingBox

getBoundingBox(): Point3D

Returns Point3D

Dimensions of bounding box as World Units.

getCameraDirection

getCameraDirection(): Point3D

Returns Point3D

Camera direction in 3D space. Always an unit vector.

getCameraLocation

getCameraLocation(): Point3D

Returns Point3D

Camera location in 3D space.

getDefaultAxisX

getDefaultAxisX(): Axis3D

Returns Axis3D

Axis3D object.

getDefaultAxisY

getDefaultAxisY(): Axis3D

Returns Axis3D

Axis3D object.

getDefaultAxisZ

getDefaultAxisZ(): Axis3D

Returns Axis3D

Axis3D object.

getMouseInteractionsWhileScrolling

getMouseInteractionsWhileScrolling(): boolean

Returns boolean

True if interactions with series are disabled, false if not.

getPadding

getPadding(): Margin

Returns Margin

Padding datastructure

getTitle

getTitle(): string

Returns string

Chart title as a string.

getTitleFillStyle

getTitleFillStyle(): FillStyle

Returns FillStyle

FillStyle object

getTitleFont

getTitleFont(): FontSettings

Returns FontSettings

FontSettings object

getTitleMarginBottom

getTitleMarginBottom(): number

Returns number

Padding after Chart title

getTitleMarginTop

getTitleMarginTop(): number

Returns number

Padding before Chart title

offResize

offResize(token: Token): boolean

Parameters
- token: Token
Returns boolean

True if the listener is successfully removed and false if it is not found

onResize

onResize(handler: function): Token

Parameters
- handler: function
  - - Parameters
      - obj: this
      - width: pixel
      - height: pixel
      - engineWidth: pixel
      - engineHeight: pixel
      Returns void
Returns Token

Token of subscription

saveToFile

saveToFile(fileName: string, type: undefined | string, encoderOptions: undefined | number): this

Parameters
- fileName: string
- Optional type: undefined | string
- Optional encoderOptions: undefined | number
Returns this

setBackgroundFillStyle

setBackgroundFillStyle(value: FillStyle | ImmutableMutator<FillStyle>): this

Parameters
- value: FillStyle | ImmutableMutator<FillStyle>
Returns this

Object itself

setBackgroundStrokeStyle

setBackgroundStrokeStyle(value: LineStyle | ImmutableMutator<LineStyle>): this

Parameters
- value: LineStyle | ImmutableMutator<LineStyle>
Returns this

Object itself

setBoundingBox

setBoundingBox(dimensions: Point3D): this

Parameters
- dimensions: Point3D
Returns this

Object itself for fluent interface

setCameraLocation

setCameraLocation(cameraLocation: Point3D): void

Parameters
- cameraLocation: Point3D
Returns void

setMouseInteractionsWhileScrolling

setMouseInteractionsWhileScrolling(state: boolean): this

Parameters
- state: boolean
Returns this

Chart itself for fluent interface.

setPadding

setPadding(padding: Partial<Margin> | number): this

Parameters
- padding: Partial<Margin> | number
Returns this

Object itself

setSeriesHighlightOnHover

setSeriesHighlightOnHover(state: boolean): this

Parameters
- state: boolean
Returns this

Object itself for fluent interface.

setTitle

setTitle(title: string): this

Parameters
- title: string
Returns this

Object itself for fluent interface.

setTitleFillStyle

setTitleFillStyle(value: FillStyle | ImmutableMutator<FillStyle>): this

Parameters
- value: FillStyle | ImmutableMutator<FillStyle>
Returns this

Chart itself

setTitleFont

setTitleFont(value: FontSettings | ImmutableMutator<FontSettings>): this

Parameters
- value: FontSettings | ImmutableMutator<FontSettings>
Returns this

Chart itself

setTitleMarginBottom

setTitleMarginBottom(marginPixels: pixel): this

Parameters
- marginPixels: pixel
Returns this

Chart itself for fluent interface

setTitleMarginTop

setTitleMarginTop(marginPixels: pixel): this

Parameters
- marginPixels: pixel
Returns this

Chart itself for fluent interface