Variable ExportControlsComponentConst

ExportControlsComponent: {
    methods: {
        exportJPG: (() => void);
        exportPNG: (() => void);
        exportSVG: (() => void);
        loadSurface: ((cb: ((s: Surface) => any)) => void);
    };
    name: string;
    props: {
        allowJpgExport: {
            default: boolean;
            type: BooleanConstructor;
        };
        allowPngExport: {
            default: boolean;
            type: BooleanConstructor;
        };
        allowSvgExport: {
            default: boolean;
            type: BooleanConstructor;
        };
        imageOptions: {
            type: PropType<ImageExportUIOptions>;
        };
        label: {
            default: string;
            type: StringConstructor;
        };
        margins: {
            type: PropType<PointXY>;
        };
        showLabel: {
            default: boolean;
            type: BooleanConstructor;
        };
        surfaceId: {
            default: string;
            type: StringConstructor;
        };
        svgOptions: {
            type: PropType<SvgExportUIOptions>;
        };
    };
    render(): VNode<RendererNode, RendererElement, {
        [key: string]: any;
    }>;
} = ...

Provides a component that offers buttons for export to SVG, PNG and/or JPG.

Type declaration

  • methods: {
        exportJPG: (() => void);
        exportPNG: (() => void);
        exportSVG: (() => void);
        loadSurface: ((cb: ((s: Surface) => any)) => void);
    }
    • exportJPG: (() => void)
        • (): void

        • Returns void

    • exportPNG: (() => void)
        • (): void

        • Returns void

    • exportSVG: (() => void)
        • (): void

        • Returns void

    • loadSurface: ((cb: ((s: Surface) => any)) => void)
        • (cb): void

        • Parameters

          • cb: ((s: Surface) => any)
              • (s): any

              • Parameters

                • s: Surface

                Returns any

          Returns void

  • name: string
  • props: {
        allowJpgExport: {
            default: boolean;
            type: BooleanConstructor;
        };
        allowPngExport: {
            default: boolean;
            type: BooleanConstructor;
        };
        allowSvgExport: {
            default: boolean;
            type: BooleanConstructor;
        };
        imageOptions: {
            type: PropType<ImageExportUIOptions>;
        };
        label: {
            default: string;
            type: StringConstructor;
        };
        margins: {
            type: PropType<PointXY>;
        };
        showLabel: {
            default: boolean;
            type: BooleanConstructor;
        };
        surfaceId: {
            default: string;
            type: StringConstructor;
        };
        svgOptions: {
            type: PropType<SvgExportUIOptions>;
        };
    }
    • allowJpgExport: {
          default: boolean;
          type: BooleanConstructor;
      }

      Defaults to true.

      • default: boolean
      • type: BooleanConstructor
    • allowPngExport: {
          default: boolean;
          type: BooleanConstructor;
      }

      Defaults to true.

      • default: boolean
      • type: BooleanConstructor
    • allowSvgExport: {
          default: boolean;
          type: BooleanConstructor;
      }

      Defaults to true.

      • default: boolean
      • type: BooleanConstructor
    • imageOptions: {
          type: PropType<ImageExportUIOptions>;
      }

      Options for image exports.

      • type: PropType<ImageExportUIOptions>
    • label: {
          default: string;
          type: StringConstructor;
      }

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

      • default: string
      • type: StringConstructor
    • margins: {
          type: PropType<PointXY>;
      }

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

      • type: PropType<PointXY>
    • showLabel: {
          default: boolean;
          type: BooleanConstructor;
      }

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

      • default: boolean
      • type: BooleanConstructor
    • surfaceId: {
          default: string;
          type: StringConstructor;
      }
      • default: string
      • type: StringConstructor
    • svgOptions: {
          type: PropType<SvgExportUIOptions>;
      }

      Options for SVG exports.

      • type: PropType<SvgExportUIOptions>
  • render:function
    • render(): VNode<RendererNode, RendererElement, {
          [key: string]: any;
      }>

    • Returns VNode<RendererNode, RendererElement, {
          [key: string]: any;
      }>

Settings

Member Visibility
Version :