Plot#

selectFrequencyDisplayUnit#

const selectFrequencyDisplayUnit: (state) => FrequencyUnit & {
  clearCache: () => void;
  resetResultsCount: () => void;
  resultsCount: () => number;
} & {
  dependencies: [(state) => FrequencyUnit];
  dependencyRecomputations: () => number;
  lastResult: () => FrequencyUnit;
  memoizedResultFunc: (resultFuncArgs_0) => FrequencyUnit & {
     clearCache: () => void;
     resetResultsCount: () => void;
     resultsCount: () => number;
  };
  recomputations: () => number;
  resetDependencyRecomputations: () => void;
  resetRecomputations: () => void;
  resultFunc: (resultFuncArgs_0) => FrequencyUnit;
} & {
  argsMemoize: any;
  memoize: any;
};

Type Declaration#

clearCache#

clearCache: () => void;

Returns#

void

resetResultsCount#

resetResultsCount: () => void;

Returns#

void

resultsCount#

resultsCount: () => number;

Returns#

number

Type Declaration#

dependencies#

dependencies: [(state) => FrequencyUnit];

dependencyRecomputations#

dependencyRecomputations: () => number;

Returns#

number

lastResult#

lastResult: () => FrequencyUnit;

Returns#

FrequencyUnit

memoizedResultFunc#

memoizedResultFunc: (resultFuncArgs_0) => FrequencyUnit & {
  clearCache: () => void;
  resetResultsCount: () => void;
  resultsCount: () => number;
};

Type Declaration#

clearCache#

clearCache: () => void;

Returns#

void

resetResultsCount#

resetResultsCount: () => void;

Returns#

void

resultsCount#

resultsCount: () => number;

Returns#

number

recomputations#

recomputations: () => number;

Returns#

number

resetDependencyRecomputations#

resetDependencyRecomputations: () => void;

Returns#

void

resetRecomputations#

resetRecomputations: () => void;

Returns#

void

resultFunc#

resultFunc: (resultFuncArgs_0) => FrequencyUnit;

Parameters#

Parameter	Type
`resultFuncArgs_0`	`FrequencyUnit`

Returns#

FrequencyUnit

Type Declaration#

argsMemoize#

argsMemoize: any;

memoize#

memoize: any;

selectPlotConfig#

const selectPlotConfig: (state) => PlotsConfig & {
  clearCache: () => void;
  resetResultsCount: () => void;
  resultsCount: () => number;
} & {
  dependencies: [(state) => PlotsConfig];
  dependencyRecomputations: () => number;
  lastResult: () => PlotsConfig;
  memoizedResultFunc: (resultFuncArgs_0) => PlotsConfig & {
     clearCache: () => void;
     resetResultsCount: () => void;
     resultsCount: () => number;
  };
  recomputations: () => number;
  resetDependencyRecomputations: () => void;
  resetRecomputations: () => void;
  resultFunc: (resultFuncArgs_0) => PlotsConfig;
} & {
  argsMemoize: any;
  memoize: any;
};

Type Declaration#

clearCache#

clearCache: () => void;

Returns#

void

resetResultsCount#

resetResultsCount: () => void;

Returns#

void

resultsCount#

resultsCount: () => number;

Returns#

number

Type Declaration#

dependencies#

dependencies: [(state) => PlotsConfig];

dependencyRecomputations#

dependencyRecomputations: () => number;

Returns#

number

lastResult#

lastResult: () => PlotsConfig;

Returns#

PlotsConfig

memoizedResultFunc#

memoizedResultFunc: (resultFuncArgs_0) => PlotsConfig & {
  clearCache: () => void;
  resetResultsCount: () => void;
  resultsCount: () => number;
};

Type Declaration#

clearCache#

clearCache: () => void;

Returns#

void

resetResultsCount#

resetResultsCount: () => void;

Returns#

void

resultsCount#

resultsCount: () => number;

Returns#

number

recomputations#

recomputations: () => number;

Returns#

number

resetDependencyRecomputations#

resetDependencyRecomputations: () => void;

Returns#

void

resetRecomputations#

resetRecomputations: () => void;

Returns#

void

resultFunc#

resultFunc: (resultFuncArgs_0) => PlotsConfig;

Parameters#

Parameter	Type
`resultFuncArgs_0`	`PlotsConfig`

Returns#

PlotsConfig

Type Declaration#

argsMemoize#

argsMemoize: any;

memoize#

memoize: any;

selectPlotSettingsById#

const selectPlotSettingsById: (plotId) => (state) => PlotsSettings & {
  clearCache: () => void;
  resetResultsCount: () => void;
  resultsCount: () => number;
} & {
  dependencies: [(state) => PlotsSettingsRecord];
  dependencyRecomputations: () => number;
  lastResult: () => PlotsSettings;
  memoizedResultFunc: (resultFuncArgs_0) => PlotsSettings & {
     clearCache: () => void;
     resetResultsCount: () => void;
     resultsCount: () => number;
  };
  recomputations: () => number;
  resetDependencyRecomputations: () => void;
  resetRecomputations: () => void;
  resultFunc: (resultFuncArgs_0) => PlotsSettings;
} & {
  argsMemoize: any;
  memoize: any;
};

Parameters#

Parameter	Type
`plotId`	`string`

Returns#

(state) => PlotsSettings & { clearCache: () => void; resetResultsCount: () => void; resultsCount: () => number; } & { dependencies: [(state) => PlotsSettingsRecord]; dependencyRecomputations: () => number; lastResult: () => PlotsSettings; memoizedResultFunc: (resultFuncArgs_0) => PlotsSettings & { clearCache: () => void; resetResultsCount: () => void; resultsCount: () => number; }; recomputations: () => number; resetDependencyRecomputations: () => void; resetRecomputations: () => void; resultFunc: (resultFuncArgs_0) => PlotsSettings; } & { argsMemoize: any; memoize: any; }

PlotExtraConfig#

Custom config extensions supported by the D3FC plot provider.

Properties#

autoFitYOnXZoom?#

optional autoFitYOnXZoom?: boolean;

doubleClick?#

optional doubleClick?: false | "reset+autosize" | "reset" | "autosize";

edits?#

optional edits?: any;

referenceFrequencyHz?#

optional referenceFrequencyHz?: number | null;

userDraw?#

optional userDraw?: boolean;

xUnitsLabel?#

optional xUnitsLabel?: string;

PlotProps#

Properties#

aspectRatio?#

optional aspectRatio?: string | number;

bottomComponent?#

optional bottomComponent?: Element;

contourThreshold?#

optional contourThreshold?: number;

Override the contour threshold multiplier (d3fc default 0.075). Higher filters out low-level contours so peaks read more clearly in small previews. Applied to type: 'contour' traces only.

data?#

optional data?: PlotData[];

extraConfig?#

optional extraConfig?: any;

extraLayout?#

optional extraLayout?: any;

headerElements?#

optional headerElements?: Element[];

Extra elements injected into PlotFlipper's header toolbar (right side)

linesOnly?#

optional linesOnly?: boolean;

Force every trace to render lines-only (strips markers from saved trace settings). Used by small ambient previews like the cockpit live readout.

logX?#

optional logX?: boolean;

logY?#

optional logY?: boolean;

mergeWithRedux?#

optional mergeWithRedux?: boolean;

noCaptureRoot?#

optional noCaptureRoot?: boolean;

When true, omits data-plot-capture-root so a parent can provide it instead

noFlip?#

optional noFlip?: boolean;

onClearOverlays?#

optional onClearOverlays?: () => void;

Returns#

void

onClick?#

optional onClick?: (event) => void;

Parameters#

Parameter	Type
`event`	`PlotlyClickEvent`

Returns#

void

onHover?#

optional onHover?: (event) => void;

Parameters#

Parameter	Type
`event`	`PlotlyHoverEvent`

Returns#

void

onRelayout?#

optional onRelayout?: (event) => void;

Parameters#

Parameter	Type
`event`	`Record`<`string`, `unknown`>

Returns#

void

onShapeRemove?#

optional onShapeRemove?: (detail) => void;

Fired when the user clicks the ✕ remove button on a shape

Parameters#

Parameter	Type
`detail`	{ `removeKey`: `string`; }
`detail.removeKey`	`string`

Returns#

void

onShapeUpdate?#

optional onShapeUpdate?: (detail) => void;

Fired when the user finishes dragging a shape handle

Parameters#

Parameter	Type
`detail`	{ `shapeIndex`: `number`; `x0`: `number`; `x1`: `number`; `y0?`: `number`; `y1?`: `number`; }
`detail.shapeIndex`	`number`
`detail.x0`	`number`
`detail.x1`	`number`
`detail.y0?`	`number`
`detail.y1?`	`number`

Returns#

void

onUnhover?#

optional onUnhover?: () => void;

Returns#

void

onUserDraw?#

optional onUserDraw?: (detail) => void;

Fired when the user finishes a right-click+drag draw gesture (requires config.userDraw)

Parameters#

Parameter	Type
`detail`	{ `x0`: `number`; `x1`: `number`; `y0?`: `number`; `y1?`: `number`; }
`detail.x0`	`number`
`detail.x1`	`number`
`detail.y0?`	`number`
`detail.y1?`	`number`

Returns#

void

overlayGroupTitle?#

optional overlayGroupTitle?: string;

paddedHeight?#

optional paddedHeight?: boolean;

plotId#

plotId: string;

rapid?#

optional rapid?: boolean;

When true, disables useDeferredValue for rapid/streaming data updates

showHiddenTraces?#

optional showHiddenTraces?: boolean;

Force every trace visible, ignoring visible: false from the handler (e.g. 1D spectra hide Imag/Abs by default). Used by the cockpit readout to show all components at a glance.

sideElement?#

optional sideElement?: Element;

Element rendered to the right of the plot content (e.g. action sidebar)

style?#

optional style?: CSSProperties;

title#

title: string;

xLabel?#

optional xLabel?: string;

yLabel?#

optional yLabel?: string;

PlotlyClickEvent#

type PlotlyClickEvent = {
  points: {
     x: number;
     y: number;
  }[];
};

Properties#

points#

points: {
  x: number;
  y: number;
}[];

x#

x: number;

y#

y: number;

PlotlyHoverEvent#

type PlotlyHoverEvent = {
  points: {
     x: number;
     y: number;
     z?: number;
  }[];
};

Properties#

points#

points: {
  x: number;
  y: number;
  z?: number;
}[];

x#

x: number;

y#

y: number;

z?#

optional z?: number;

Plot#

Re-exports Plot