SandDance

Class which presents a Stage of chart data using MorphCharts to render.

Hierarchy

  • Presenter

Index

Constructors

constructor

  • Instantiate a new Presenter.

    Parameters

    • el: HTMLElement

      Parent HTMLElement to present within.

    • Optional style: PresenterStyle

      Optional PresenterStyle styling options.

    Returns Presenter

Properties

animationTimer

animationTimer: number

Handle of the timer for animation.

el

el: HTMLElement

logger

logger: (message?: any, ...optionalParams: any[]) => void

Logger, such as console.log

Type declaration

    • (message?: any, ...optionalParams: any[]): void
    • Logger, such as console.log

      Parameters

      • Optional message: any
      • Rest ...optionalParams: any[]

      Returns void

morphChartsRenderResult

morphChartsRenderResult: MorphChartsRenderResult

Handle to recent MorphCharts rendering result.

morphchartsref

morphchartsref: MorphChartsRef

MorphCharts instance for rendering WebGL.

style

Options for styling the output.

Accessors

stage

  • Get the previously rendered Stage object.

    Returns Stage

view

  • Get the current View camera type.

    Returns View

Methods

animationCancel

  • animationCancel(): void
  • Cancels any pending animation, calling animationCanceled() on original queue.

    Returns void

animationQueue

  • Stops the current animation and queues a new animation.

    Parameters

    • handler: () => void

      Function to invoke when timeout is complete.

        • (): void
        • Returns void

    • timeout: number

      Length of time to wait before invoking the handler.

    • Optional options: QueuedAnimationOptions

      Optional QueuedAnimationOptions object.

    Returns void

canvasToDataURL

  • canvasToDataURL(): Promise<string>
  • Returns Promise<string>

configColors

  • Parameters

    Returns void

finalize

  • finalize(): void
  • Returns void

getElement

  • Retrieve a sub-element of the rendered output.

    Parameters

    Returns HTMLElement

homeCamera

  • homeCamera(): void
  • Home the camera to the last initial position.

    Returns void

present

  • Present the Vega Scene, or Stage object using Morphcharts.

    Parameters

    • sceneOrStage: Stage | Scene3d

      Vega Scene object, or Stage object containing chart layout info.

    • height: number

      Height of the rendering area.

    • width: number

      Width of the rendering area.

    • Optional config: PresenterConfig

      Optional presentation configuration object.

    Returns void

showGuides

  • showGuides(): void
  • Show guidelines of rendering height/width and center of OrbitView.

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc