textmode.export.js

Export plugin for textmode.js - save artworks as images, videos, SVG, JSON, and text.

This plugin adds comprehensive export capabilities to textmode.js instances, allowing you to save your generative artworks in multiple formats with a convenient overlay UI for quick access to all export options.

Available export formats

Image formats

• PNG/JPEG/WebP - Save canvas as raster image

Vector formats

• SVG - Save as scalable vector graphics

Text formats

• TXT - Save text content as plain text
• JSON - Save document data as structured JSON

Animation formats

• GIF - Save as animated GIF
• Video - Save as WebM or MP4 video

Interfaces

Interface	Description
LayerExportOptions	Shared option for exporters that read layer framebuffer data.
JSONRGBAColor	RGBA color representation used in JSON exports.
JSONCellTransform	Cell transform data for JSON exports.
JSONObjectRowCell	Rich per-cell representation for readable JSON exports.
JSONObjectRowsCellCollection	Row-based cell encoding.
JSONLayerGrid	Grid dimensions exported for a layer.
JSONExportMetadata	Optional export metadata.
TextmodeSelectedDocumentLayer	Selected-layer entry in a JSON document export.
TextmodeSelectedDocumentJSON	Selected-layer document exported by the JSON exporter.
TextmodeDocumentLayer	Single layer entry in an all-layers JSON export.
TextmodeAllDocumentJSON	Layer stack document exported by the JSON exporter.
ExportOverlayController	Controller for managing the export overlay UI visibility at runtime.
TextmodeExportAPI	Runtime export helpers that createExportPlugin attaches to the Textmodifier instance.
TextmodeExportPluginOptions	Options for configuring the export plugin.

Type Aliases

Type Alias	Description
GIFExportProgress	Progress information emitted during the GIF export process.
GIFExportOptions	Options for exporting the textmode content to GIF format.
ImageExportOptions	Options for exporting the textmode content to image format.
JSONExportTarget	Target scope for JSON export.
JSONDocumentFormat	Canonical JSON document format identifier.
JSONDocumentVersion	Canonical JSON document format version.
JSONExportColorMode	Supported JSON color output modes.
JSONColorValue	Color value used in the exported JSON document.
JSONCellCollection	Supported JSON cell collection variants.
TextmodeDocumentJSON	JSON document exported by the JSON exporter.
JSONExportOptions	Options for exporting the textmode content to JSON format.
SVGExportOptions	Options for exporting the textmode content to SVG format.
TXTExportOptions	Options for exporting the textmode content to TXT format.
VideoRecordingState	Lifecycle state reported while a video export is being prepared, recorded, encoded, or completed.
VideoExportPhase	More granular phase information for progress UIs that need to distinguish setup, rendering, and finalization.
VideoBitratePreset	Subjective bitrate preset used when an exact bits-per-second value is not supplied.
VideoExportFormat	Video container format written by saveVideo.
VideoBitrateMode	Bitrate allocation strategy for the native encoder.
VideoLatencyMode	Encoder scheduling mode.
VideoHardwareAcceleration	WebCodecs hardware acceleration preference.
VideoExportErrorCode	-
VideoExportProgress	Progress information emitted during the video export process.
VideoExportOptions	Options for exporting the textmode content to video format.

Variables

Variable	Description
ExportPlugin	Export plugin for textmode.js.

Functions

Function	Description
createTextmodeExportPlugin	Creates the textmode.export.js plugin for textmode.js.