VARIABLES

Namespace

VARIABLES

Description:

  • This section regroups every object and variable needed globally for the whole app.

Source:

Members

(static) autoMeasureOptions :object

Description:

  • Object used to keep track of which "autoMeasure" are currently actives. These are the small values seen at the bottom of the screen to display informations such as highest value, lowest value, mean value, etc..

Source:
Properties:
Name Type Description
associatedChannel string

Which channel are the measurements based on.
min boolean

Is the smallest value (mV) displayed.
max boolean

Is the highest value (mV) displayed.
vpp boolean

Is the VPP (mV) displayed.
mean boolean

Is the mean value (mV) displayed.
rms boolean

Is the RMS (Root mean square) displayed.
freq boolean

Is the average frequency displayed (Hz).
highFreq boolean

Is the highest frequency displayed (Hz).
lowFreq boolean

Is the lowest frequency displayed (Hz).
mid boolean

Is the middle value of the signal displayed (mV).

Object used to keep track of which "autoMeasure" are currently actives. These are the small values seen at the bottom of the screen to display informations such as highest value, lowest value, mean value, etc..

Type:
  • object

(static) channelData :object

Description:

  • This object holds everything needed for the display and interaction with a signal. Every signal's data is stored within 'channelData' under the key name "CH" + Number of the signal (CH1, CH2, etc..).

Source:
Properties:
Name Type Description
colorDark string

Color of the signal on screen if the theme is set to dark.
colorLight string

Color of the signal on screen if the theme is set to light.
display boolean

Is the signal displayed or hidden on the screen.
focused boolean

Is the signal focused or not (channel button highlighted).
points array

Every point from a frame N to draw the signal.
type string

Signal type, in case a signal is the result of an operation from another signal (baseData / generatedData).
verticalOffset number

Offset for the signal.
verticalOffsetRelativeCursorPosition number

Position of the cursor relative to this signal for the vertical offset.
verticalScale number

Vertical scale for this signal
originChannel1 string

If generated signal - Original signal 1.
originChannel2 string

If generated signal - Original signal 2.
operation string

If generated signal - Operation type.

This object holds everything needed for the display and interaction with a signal. Every signal's data is stored within 'channelData' under the key name "CH" + Number of the signal (CH1, CH2, etc..).

Type:
  • object

(static) config :Object

Description:

  • Configuration object used to handle the server configuration. If the server configuration changes, update this object accordingly.

Source:
Properties:
Name Type Description
numChannels number | null

Number of expected channels.
frequency number | null

Frequency in Hz.
samplesPerFrame number | null

Number of samples per frame.
voltage number | null

Voltage range (from + to -).
bitsPerSample number | null

Bits per sample.
verticalDivisions number

Number of vertical divisions. Default is 16.
horizontalDivisions number

Number of horizontal divisions. Default is 20.
mode string | null

Operating mode (FILE / REAL-TIME).
maxSampleValue number | null

Maximum sample value (absolute).
gridDisplay boolean

Grid display status. 1 means on, 0 means off.
gridOpacity number

Grid opacity level (0 - 1).
theme string

Theme of the display (dark / light).

Configuration object used to handle the server configuration. If the server configuration changes, update this object accordingly.

Type:
  • Object

(static) currentFilePosition :number

Description:

  • When getting data from a .osc file, this variable stores the latest postion read within the file.

Source:

When getting data from a .osc file, this variable stores the latest postion read within the file.

Type:
  • number

(static) cursorOptions :object

Description:

  • Object used to keep track of the current status of the cursors that can be displayed on screen for measures. This does not concern the offset cursors, only those generated from the "CURSORS" menu.

Source:
Properties:
Name Type Description
isVerticalCursorOn boolean

Saves wether or not we need to display the vertical cursors with each frame (true / false).
isHorizontalCursorOn boolean

Saves wether or not we need to display the horizontal cursors with each frame (true / false).
cursorsValueDisplay string

Are we displaying each cursor's value near the line going to the cursor or within a frame in the top-right of the screen (oncursor / indisplay).
horizontalAPosition number

Distance from the top of the scrollbar to the horizontal cursor A (pixels).
horizontalBPosition number

Distance from the top of the scrollbar to the horizontal cursor B (pixels).
verticalAPosition number

Distance from the left of the scrollbar to the vertical cursor A (pixels).
verticalBPosition number

Distance from the left of the scrollbar to the vertical cursor B (pixels).

Object used to keep track of the current status of the cursors that can be displayed on screen for measures. This does not concern the offset cursors, only those generated from the "CURSORS" menu.

Type:
  • object

(static) failedAttempt :number

Description:

  • This variable holds the number of errors detected while gathering data.

Source:

This variable holds the number of errors detected while gathering data.

Type:
  • number

(static) fileName :string

Description:

  • This variable stores the local access to the file we are reading.

Source:

This variable stores the local access to the file we are reading.

Type:
  • string

(static) horizontalOffset :number

Description:

  • Horizontal offset for every channel.

Source:

Horizontal offset for every channel.

Type:
  • number

(static) horizontalScale :number

Description:

  • Horizontal scale for every channel.

Source:

Horizontal scale for every channel.

Type:
  • number

(static) isRunning :boolean

Description:

  • Is the oscilloscope currently running or not.

Source:

Is the oscilloscope currently running or not.

Type:
  • boolean

(static) loopDelay :number

Description:

  • Time between each frame & data gathering (ms).

Source:

Time between each frame & data gathering (ms).

Type:
  • number

(static) triggerClock :number

Description:

  • This variable holds the amount of time spent since the trigger has last been active (ms).

Source:

This variable holds the amount of time spent since the trigger has last been active (ms).

Type:
  • number

(static) triggerOptions :object

Description:

  • Object used to handle the trigger's behavior and options selected by the user.

Source:
Properties:
Name Type Description
isTriggerOn boolean

Is the trigger currently on (on / off).
triggerMode string

Which mode is the trigger set to (edge / window).
triggerChannel string

Which channel are we triggering for (CH1, CH2, etc..).
triggerLevel number

Value in Mv at which the trigger will activate (if triggerMode == edge).
windowLevelMin number

Value A in mV of the window in which the trigger will activate (if triggerMode == window).
windowLevelMax number

Value B in mV of the window in which the trigger will activate (if triggerMode == window).
triggerSlope string

Slope to check for when triggering (rising, falling, both).
holdOff number

Timeout for the trigger once activated (0-3600) (seconds).

Object used to handle the trigger's behavior and options selected by the user.

Type:
  • object

(static) triggered :boolean

Description:

  • Is the oscilloscope triggered or not.

Source:

Is the oscilloscope triggered or not.

Type:
  • boolean

(static) zoomConfig :object

Description:

  • Object used with the zoom option that allows a user to drag their mouse onto the oscilloscope's screen and zoom on the selected area.

Source:
Properties:
Name Type Description
isZoomed boolean

Is the screen currently zoomed in or not (true / false).
isDrawing boolean

Is the user currently dragging their mouse onto the oscilloscope's screen (true / false).
initX number

The initial X coordinate where the user started dragging.
initY number

The initial Y coordinate where the user started dragging.
finalX number

The final X coordinate where the user stopped dragging.
finalY number

The final Y coordinate where the user stopped dragging.
zoomX number

The factor by which the X axis is zoomed.
zoomY number

The factor by which the Y axis is zoomed.

Object used with the zoom option that allows a user to drag their mouse onto the oscilloscope's screen and zoom on the selected area.

Type:
  • object