Interface ExportControlsComponentOptions

Options for the ExportControlsComponent

interface ExportControlsComponentOptions {
    allowJpgExport?: boolean;
    allowPngExport?: boolean;
    allowSvgExport?: boolean;
    imageOptions?: ImageExportUIOptions;
    label?: string;
    labelProperty?: string;
    margins?: PointXY;
    shapeLibrary?: ShapeLibraryImpl<any>;
    showLabel?: boolean;
    svgOptions?: SvgExportUIOptions;
}

Properties

allowJpgExport? allowPngExport? allowSvgExport? imageOptions? label? labelProperty? margins? shapeLibrary? showLabel? svgOptions?

Properties

OptionalallowJpgExport

allowJpgExport?: boolean

Defaults to true.

OptionalallowPngExport

allowPngExport?: boolean

Defaults to true.

OptionalallowSvgExport

allowSvgExport?: boolean

Defaults to true.

OptionalimageOptions

imageOptions?: ImageExportUIOptions

Options for image exports.

Optionallabel

label?: string

What to show in the label, if visible. Defaults to "Export:".

OptionallabelProperty

labelProperty?: string

The name of the property that holds the label for a vertex

Optionalmargins

margins?: PointXY

Optional margins to apply to both SVG and image exports. Will not override any margins specified in svgOptions or imageOptions.

OptionalshapeLibrary

shapeLibrary?: ShapeLibraryImpl<any>

It should not be necessary to supply this as we get it from the Surface. We've moved it to an option and deprecated it.

Deprecated

OptionalshowLabel

showLabel?: boolean

Whether or not to show a label in front of the buttons. Defaults to true.

OptionalsvgOptions

svgOptions?: SvgExportUIOptions

Options for SVG exports.

Settings

Member Visibility

On This Page

Properties
Version :