Skip to content

components/flow/DeviceAPI#

RawPlotSegment#

A raw Plotly-compatible trace segment for custom visualizations. Used with Action.Raw to let plugins provide arbitrary plot shapes.

Properties#

fill?#

optional fill?: string;

fillcolor?#

optional fillcolor?: string;

line?#

optional line?: {
  color?: string;
  dash?: string;
  width?: number;
};
color?#
optional color?: string;
dash?#
optional dash?: string;
width?#
optional width?: number;

marker?#

optional marker?: Record<string, any>;

mode?#

optional mode?: string;

name#

name: string;

showlegend?#

optional showlegend?: boolean;

x#

x: number[];

y#

y: number[];

ChannelId#

type ChannelId = 
  | "tx1"
  | "tx2"
  | "rx"
  | "blanking"
  | "lo"
  | "phase"
  | "grad_x"
  | "grad_y"
  | "grad_z"
  | string;

Command#

type Command = {
  action: Action;
  blanking?: boolean;
  channel?: ChannelId;
  duration: number;
  frequency?: number;
  label?: string;
  loopCount?: number;
  phaseLabel?: string;
  raw?: RawPlotSegment;
  sweep?: boolean;
};

Properties#

action#

action: Action;

blanking?#

optional blanking?: boolean;

channel?#

optional channel?: ChannelId;

duration#

duration: number;

frequency?#

optional frequency?: number;

label?#

optional label?: string;

loopCount?#

optional loopCount?: number;

phaseLabel?#

optional phaseLabel?: string;

raw?#

optional raw?: RawPlotSegment;

sweep?#

optional sweep?: boolean;

SpecialCommand#

type SpecialCommand = {
  action: SpecialAction;
  id: string;
  num?: number;
};

Properties#

action#

action: SpecialAction;

id#

id: string;

num?#

optional num?: number;

Action#

Enumeration Members#

Enumeration Member Value
ADC "ADC"
Cycle "Cycle"
DDS_A "DDS_A"
EndCycle "EndCycle"
Gradient_On "Gradient_On"
GradientEncode "GradientEncode"
GradW "GradW"
GradX "GradX"
GradY "GradY"
GradZ "GradZ"
Pulse_0 "Pulse_0"
Pulse_180 "Pulse_180"
Pulse_270 "Pulse_270"
Pulse_90 "Pulse_90"
Pulse_Phase "Pulse_Phase"
Raw "Raw"
RXBlank "RXBlank"
Silence "Silence"
stop "stop"
VIZ_FOR_END "VIZ_FOR_END"
VIZ_FOR_FIRST_ITER "VIZ_FOR_FIRST_ITER"
VIZ_FOR_START "VIZ_FOR_START"
Wobble "Wobble"

SpecialAction#

Enumeration Members#

Enumeration Member Value
FOR_BEGIN "for-begin"
FOR_END "for-end"
FOR_ITERATION "for-iter"