sigplot-ts
Options
All
  • Public
  • Public/Protected
  • All
Menu

BasePlot is an abstract base class for sigplot.Plot to help unify some of the API for downstream classes.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Parameters

    • el: any

      The DOM element to draw within (div, etc.)

    • Default value options: ConstructorOptions = new ConstructorOptions()

      The ConstructorOptions for this plot.

    Returns BasePlot

Properties

Private _options

_options: ConstructorOptions

The options used when creating the plot

_plot

_plot: Plot

Accessors

settings

settings:

The settings related to the current plot. For use with checkSettings.

xlab

xlab:

If your ConstructorOptions use the default xlabel and ylabel, changing these values will update the X and Y labels by getting the string name of the enumeration (Units).

ylab

ylab:

Methods

checkResize

  • checkResize(): void

  • If you resize the DOM element for the plot, call this to cause the plot to redraw

    Returns void

checkSettings

  • checkSettings(): void

  • Push any changes in the settings to the underlying plot instance.

    Returns void

getLayer

  • getLayer(...args: any[]): ILayer

  • Get the plot layer for the data

    Parameters

    • Rest ...args: any[]

    Returns ILayer

push

  • push(plotData: PlotData, ...args: any[]): any

  • Update the plot with the data buffer

    Parameters

    • plotData: PlotData
    • Rest ...args: any[]

    Returns any

removeLayer

  • removeLayer(...args: any[]): void

  • Remove a/the plot layer

    Parameters

    • Rest ...args: any[]

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • 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