Class Smith

constructor

• new Smith(options?: SmithOptions): Smith

  Parameters

  • Optionaloptions: SmithOptions

  Returns Smith

Readonlylayers

ReadonlyperipheralScales

cursorReading

• get cursorReading(): SmithReading

  Last cursor position. Use cursor events to detect pointer leave.

  Returns SmithReading

referenceImpedanceOhms

• get referenceImpedanceOhms(): number

  Current positive real reference impedance, in ohms.

  Returns number

addMarker

• addMarker(traceId: string, sampleIndex?: number): string | undefined

  Place a marker on an existing sample; no interpolation is performed.

  Parameters

  • traceId: string
  • OptionalsampleIndex: number

  Returns string | undefined

addTrace

• addTrace(values: TraceSamples, options?: TraceOptions): string

  Add a named trace without markers. Use addMarker to create markers explicitly. Returns a chart-local, stable ID.

  Parameters

  • values: TraceSamples
  • Optionaloptions: TraceOptions

  Returns string

• addTrace(values: readonly TraceTuple[], options?: TraceOptions): string

  Add a named trace without markers. Use addMarker to create markers explicitly. Returns a chart-local, stable ID.

  Parameters

  • values: readonly TraceTuple[]
  • Optionaloptions: TraceOptions

  Returns string

• addTrace(values: Float64Array, options?: TraceOptions): string

  Add a named trace without markers. Use addMarker to create markers explicitly. Returns a chart-local, stable ID.

  Parameters

  • values: Float64Array
  • Optionaloptions: TraceOptions

  Returns string

• addTrace(values: TraceInput, options?: TraceOptions): string

  Add a named trace without markers. Use addMarker to create markers explicitly. Returns a chart-local, stable ID.

  Parameters

  • values: TraceInput
  • Optionaloptions: TraceOptions

  Returns string

clearTraces

• clearTraces(): void

  Returns void

compareMarkers

• compareMarkers(a: string, b: string): MarkerComparison | undefined

  Return B − A, or undefined if either marker no longer exists.

  Parameters

  • a: string
  • b: string

  Returns MarkerComparison | undefined

destroy

• destroy(): void

  Remove this chart and release its event handlers. Safe to call more than once.

  Returns void

draw

• draw(target: string | HTMLElement): void

  Parameters

  • target: string | HTMLElement

  Returns void

focusMarker

• focusMarker(id: string): boolean

  Focus a mounted, visible marker for keyboard interaction.

  Parameters

  • id: string

  Returns boolean

getMarker

• getMarker(id: string): MarkerSnapshot | undefined

  Parameters

  • id: string

  Returns MarkerSnapshot | undefined

getTraces

• getTraces(): TraceInfo[]

  Detached metadata snapshots; IDs and marker display numbers survive removals.

  Returns TraceInfo[]

onEvent

• onEvent(listener: (event: SmithEvent) => void): () => void

  Subscribe to chart events. The returned function removes this subscription.

  Parameters

  • listener: (event: SmithEvent) => void

  Returns () => void

removeMarker

• removeMarker(id: string): boolean

  Parameters

  • id: string

  Returns boolean

removeTrace

• removeTrace(id: string): boolean

  Parameters

  • id: string

  Returns boolean

renormalize

• renormalize(referenceImpedanceOhms: number): void

  Renormalize all traces while retaining physical impedance, IDs, and selected sample indices.

  Parameters

  • referenceImpedanceOhms: number

  Returns void

resetView

• resetView(): void

  Returns void

setAppearance

• setAppearance(appearance: SmithAppearance): void

  Replace the appearance while retaining explicit layer styles and trace colors.

  Parameters

  • appearance: SmithAppearance

  Returns void

setCursorEnabled

• setCursorEnabled(enabled: boolean): void

  Enable or disable the cursor overlay and readings independently of zoom and markers.

  Parameters

  • enabled: boolean

  Returns void

setGridDetail

• setGridDetail(detail: GridDetail): void

  Set the same detail level on all impedance and admittance grid layers.

  Parameters

  • detail: GridDetail

  Returns void

setMarkerFrequency

• setMarkerFrequency(id: string, frequencyHz: number): boolean

  Select the nearest measured frequency; ties choose the earliest input sample.

  Parameters

  • id: string
  • frequencyHz: number

  Returns boolean

setMarkerSample

• setMarkerSample(id: string, sampleIndex: number): boolean

  Parameters

  • id: string
  • sampleIndex: number

  Returns boolean

setOptions

• setOptions(options: SmithOptions): void

  Apply a validated patch. Omitted fields retain their current settings.

  Parameters

  • options: SmithOptions

  Returns void

setTraceOptions

• setTraceOptions(id: string, options: TraceOptions): boolean

  Parameters

  • id: string
  • options: TraceOptions

  Returns boolean

setZoomEnabled

• setZoomEnabled(enabled: boolean): void

  Enable or disable wheel, double-click, and mouse/touch zoom/pan. Keeps the current view.

  Parameters

  • enabled: boolean

  Returns void

toPng

• toPng(options?: SmithImageExportOptions): Promise<Blob>

  Export the mounted view as PNG, optionally with radial scales and a trace legend.

  Parameters

  • Optionaloptions: SmithImageExportOptions

  Returns Promise<Blob>

toSvg

• toSvg(options?: SmithImageExportOptions): string

  Export the current mounted view as standalone SVG with its configured background.

  Parameters

  • Optionaloptions: SmithImageExportOptions

  Returns string

updateTrace

• updateTrace(
      id: string,
      values: TraceSamples,
      options?: TraceUpdateOptions,
  ): boolean

  Replace samples; by default each marker follows its nearest measured frequency.

  Parameters

  • id: string
  • values: TraceSamples
  • Optionaloptions: TraceUpdateOptions

  Returns boolean

• updateTrace(
      id: string,
      values: readonly TraceTuple[],
      options?: TraceUpdateOptions,
  ): boolean

  Replace samples; by default each marker follows its nearest measured frequency.

  Parameters

  • id: string
  • values: readonly TraceTuple[]
  • Optionaloptions: TraceUpdateOptions

  Returns boolean

• updateTrace(
      id: string,
      values: Float64Array,
      options?: TraceUpdateOptions,
  ): boolean

  Replace samples; by default each marker follows its nearest measured frequency.

  Parameters

  • id: string
  • values: Float64Array
  • Optionaloptions: TraceUpdateOptions

  Returns boolean

• updateTrace(
      id: string,
      values: TraceInput,
      options?: TraceUpdateOptions,
  ): boolean

  Replace samples; by default each marker follows its nearest measured frequency.

  Parameters

  • id: string
  • values: TraceInput
  • Optionaloptions: TraceUpdateOptions

  Returns boolean