Smithkit - v0.5.0
    Preparing search index...

    Interface SmithImageExportOptions

    interface SmithImageExportOptions {
        background?: string;
        height?: number;
        legend?: boolean;
        lineDetail?: "view" | "full";
        markerLegend?: boolean | MarkerLegendOptions;
        scaleReadout?: ScaleExportReadout;
        scales?: SmithScales;
        width?: number;
    }

    Hierarchy (View Summary)

    Index
    background? height? legend? lineDetail? markerLegend? scaleReadout? scales? width?
    background?: string

    A concrete CSS color, or transparent. Omit to preserve configured SVG backgrounds.

    height?: number

    With both dimensions, center and fit the image without stretching or cropping.

    legend?: boolean

    Include a footer with the names and colors of visible traces. Default: false.

    lineDetail?: "view" | "full"

    Full samples (default) or current displayed line geometry. View detail scales with export dimensions.

    markerLegend?: boolean | MarkerLegendOptions

    Include a marker legend below the chart/scales, independently of the trace legend. Default: false.

    scaleReadout?: ScaleExportReadout

    Override readings in the included radial scales without changing the live view. Requires scales.

    scales?: SmithScales

    Include mounted radial scales centered below the chart, preserving their current layout/readings.

    width?: number

    Output pixels. Default: the snapshot dimensions. With only one dimension, preserve the complete image's aspect ratio.

    Settings

    On This Page
    Properties