Options
All
  • Public
  • Public/Protected
  • All
Menu

SettingsOptions are the runtime settings used in SigPlot's top-level Plot.

While largely similar to the ISettingsOptions interface, this class uses the enumerations in SigPlot-TS to avoid, "magic numbers," and related issues.

preferred

Hierarchy

Index

Properties

all

all: boolean

autol

autol: AutoScale.none | AutoScale.min | AutoScale.max | AutoScale.full

autox

autox: AutoScale.none | AutoScale.min | AutoScale.max | AutoScale.full

autoy

autoy: AutoScale.none | AutoScale.min | AutoScale.max | AutoScale.full

autoz

autoz: AutoScale.none | AutoScale.min | AutoScale.max | AutoScale.full

cmap

cmap: number | Mc.Greyscale | Mc.Ramp | Mc.ColorWheel | Mc.Spectrum | Mc.calewhite | Mc.HotDesat | Mc.Sunset | string | IColorMap

For 2D plots, controls the colors used to draw the magnitude of a data point See m.Mc.colormap (in SigPlot) for explicit declarations corresponding to the Mc enumeration.

cmode

cmode: CMode.IN | CMode.AB | CMode.MA | CMode.PH | CMode.RE | CMode.IM | CMode.L0 | CMode.L2 | CMode.RI | CMode.IR

colors

colors: IPlotColors

Controls foreground and background colors

cross

cross: boolean

Enables/disables the mouse cursor being a cross(hair)

drawmode

drawmode: DrawMode

enabled_streaming_pcut

enabled_streaming_pcut: boolean

fillStyle

fillStyle: string | Array<string>

HTML5 canvas fillStyle (so "red" or an array, etc.)

grid

grid: boolean

Controls the visibility of the grid

gridBackground

gridBackground: string | Array<string>

HTML5 canvas fillStyle (so "red" or an array, etc.)

gridStyle

gridStyle: IGridStyle

Styling for the background grid on 1D plots, if enabled

index

index: boolean

invert

invert: boolean

Controls inverting foreground and background colors, use null to toggle

legend

legend: boolean

lg_colorbar

lg_colorbar: boolean

nomenu

nomenu: boolean

Controls access to the menu, use null to toggle

note

note: object

p_cuts

p_cuts: boolean

pan

pan: boolean

Controls visibility of scroll bars

phunits

phunits: PHUnits.D | PHUnits.R | PHUnits.C

rasterSmoothing

rasterSmoothing: boolean

Controls raster smoothing, use null to toggle

rightclick_rubberbox_action

rightclick_rubberbox_action: RubberboxAction

rightclick_rubberbox_mode

rightclick_rubberbox_mode: RubberboxMode

rubberbox_action

rubberbox_action: RubberboxAction

rubberbox_mode

rubberbox_mode: RubberboxMode

show_axis_on_plot

show_axis_on_plot: boolean

show_readout

show_readout: boolean

show_x_axis

show_x_axis: boolean

show_y_axis

show_y_axis: boolean

specs

specs: boolean

wheelZoom

wheelZoom: boolean

wheelZoomPercent

wheelZoomPercent: number

wheelscroll_enable

wheelscroll_enable: boolean

wheelscroll_mode_natural

wheelscroll_mode_natural: string

xcnt

xcnt: XCNT

xcut_now

xcut_now: boolean

xinv

xinv: boolean

xmax

xmax: number

xmin

xmin: number

xyKeys

xyKeys: string

ycut_now

ycut_now: boolean

yinv

yinv: boolean

ymax

ymax: number

ymin

ymin: number

zinv

zinv: boolean

zmax

zmax: number

zmin

zmin: number

Methods

fromInterface

  • Import settings from an ISettingsOptions interface

    Parameters

    Returns void

toInterface

  • Convert to the ISettingsOptions interface

    Returns ISettingsOptions

Static interfaceMerge

  • interfaceMerge(source: any, dest: any): void
  • Merge two ISettingsOptions -based interfaces together

    Parameters

    • source: any
    • dest: 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