Options
All
  • Public
  • Public/Protected
  • All
Menu

The LinePlot is a one-dimensional representation of data, for example sinusoids, PSD, and FFT. It supports plotting multiple lines at the same time by using unique Data IDs, which become the names in the plot's legend.

preferred

Hierarchy

Index

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 LinePlot

Properties

Private _dataLayers

_dataLayers: DataLayers

Internal layer mapping

_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

addHighlight

  • addHighlight(highlight: IHighlight, dataId?: string): void
  • Add a highlight to the dataId's plot

    Parameters

    • highlight: IHighlight

      The highlight to apply.

    • Default value dataId: string = DEFAULT_SIGNAL

      The data signal ID corresponding to the layer.

    Returns void

changeLayerSettings

  • changeLayerSettings(settings: ILayerSettings, dataId?: string): void
  • This is a simple way to mess with color, opacity, etc. while a plot is instantiated.

    That said: use with caution! You can incidentally override various settings that may have really awful effects in SigPlot.

    Parameters

    • settings: ILayerSettings

      The settings to change in the layer

    • Default value dataId: string = DEFAULT_SIGNAL

      The data signal ID corresponding to the layer

    Returns void

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

clearHighlights

  • clearHighlights(dataId?: string): void
  • Clear all highlights for a given dataId

    Parameters

    • Default value dataId: string = DEFAULT_SIGNAL

      The data signal ID corresponding to the layer.

    Returns void

Private dataLayer

  • Get the Layer ID for the data ID. If it doesn't exist, create one using the provided header options.

    Parameters

    • Default value dataId: string = DEFAULT_SIGNAL

      Data (signal) ID whose layer to fetch from the map

    • Optional options: IBlueHeaderOptions

      header options

    • Optional frameSize: number

    Returns DataLayer

    The data layer for the SigPlot layer

getLayer

  • getLayer(dataId?: string): Layer1D
  • Get the plotting Layer

    Parameters

    • Default value dataId: string = DEFAULT_SIGNAL

      The dataId corresponding to the layer.

    Returns Layer1D

push

  • Push the data buffer and other information to the plot.

    Parameters

    Returns void

removeHighlight

  • removeHighlight(highlight: IHighlight, dataId?: string): void
  • Remove a highlight from dataId's plot

    Parameters

    • highlight: IHighlight

      The highlight to apply.

    • Default value dataId: string = DEFAULT_SIGNAL

      The data signal ID corresponding to the layer.

    Returns void

removeLayer

  • removeLayer(dataId?: string): void
  • Removes the (data signal) layer corresponding to the dataId from the plot

    Parameters

    • Default value dataId: string = DEFAULT_SIGNAL

      The data signal ID corresponding to the layer.

    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