textmode.export.js / TextmodeExportAPI

Interface: TextmodeExportAPI

Runtime export helpers that createExportPlugin attaches to the Textmodifier instance.

Properties

Property	Type	Description
exportOverlay	ExportOverlayController	Controller for managing the export overlay UI visibility at runtime.

Methods

saveCanvas()

saveCanvas(options?): Promise<void>;

Saves the current canvas content to an image file ('png' by default).

Parameters

Parameter	Type	Description
options?	ImageExportOptions	Export options.

Returns

Promise<void>

---

copyCanvas()

copyCanvas(options?): Promise<void>;

Copies the current canvas to the user's clipboard as an image.

Parameters

Parameter	Type	Description
options?	ImageExportOptions	Export options.

Returns

Promise<void>

---

saveSVG()

saveSVG(options?): void;

Downloads the current frame as an SVG file.

Parameters

Parameter	Type	Description
options?	SVGExportOptions	Export options.

Returns

void

---

saveStrings()

saveStrings(options?): void;

Downloads the current text content as a plain-text file.

Parameters

Parameter	Type	Description
options?	TXTExportOptions	Export options.

Returns

void

---

toSVG()

toSVG(options?): string;

Generates the SVG markup for the current frame.

Parameters

Parameter	Type	Description
options?	SVGExportOptions	Export options.

Returns

string

The SVG content representing the artwork.

---

toString()

toString(options?): string;

Produces the current text content as a string.

Parameters

Parameter	Type	Description
options?	TXTExportOptions	Export options.

Returns

string

The textual representation of the artwork.

---

saveGIF()

saveGIF(options?): Promise<void>;

Records an animated GIF and saves it to disk.

Parameters

Parameter	Type	Description
options?	GIFExportOptions	Export options.

Returns

Promise<void>

---

saveWEBM()

saveWEBM(options?): Promise<void>;

Captures a WEBM video and saves it to disk.

Parameters

Parameter	Type	Description
options?	VideoExportOptions	Export options.

Returns

Promise<void>