textmode.export.js / ExportOverlayController

Interface: ExportOverlayController

Controller for managing the export overlay UI visibility at runtime.

Methods

getDefaults()

getDefaults(): Readonly<ExportDefaults>;

Read the current effective defaults for every format.

The returned object reflects the library's curated defaults merged with any runtime overrides applied via setDefaults.

Returns

Readonly<ExportDefaults>

The current per-format defaults.

Example

const defaults = t.exportOverlay.getDefaults();
console.log(defaults.image.scale); // 1 (or whatever was set)

---

getPosition()

getPosition(): Readonly<ExportOverlayPosition>;

Reads the current export overlay placement.

Returns

Readonly<ExportOverlayPosition>

The current canvas-relative overlay placement state.

Example

const position = t.exportOverlay.getPosition();
console.log(position.mode, position.offsetX, position.offsetY);

---

hide()

hide(): void;

Hides the export overlay UI.

Returns

void

Example

t.exportOverlay.hide();

---

isVisible()

isVisible(): boolean;

Checks if the export overlay is currently visible.

Returns

boolean

Example

const visible = t.exportOverlay.isVisible();

---

resetDefaults()

resetDefaults(format?): void;

Restore one or all formats to the library's curated defaults.

If a format is specified, only that format is reset; otherwise all formats are restored.

Parameters

Parameter	Type	Description
format?	keyof ExportDefaults	Optional format to reset. Omit to reset all.

Returns

void

Example

// Reset image defaults
t.exportOverlay.resetDefaults('image');

// Reset the overlay's selected default export format
t.exportOverlay.resetDefaults('format');

// Reset all formats
t.exportOverlay.resetDefaults();

---

resetPosition()

resetPosition(): void;

Restores the export overlay to its default canvas-relative placement and clears any remembered placement.

Returns

void

Example

t.exportOverlay.resetPosition();

---

setDefaults()

setDefaults(patch): void;

Override the curated overlay defaults at runtime.

Merges the supplied patch into the internal defaults store. Per-format option patches are pushed into mounted blades; top-level format updates the overlay's selected export format immediately.

Parameters

Parameter	Type	Description
patch	ExportDefaultsPatch	Partial defaults to merge per format.

Returns

void

Example

// Select image export by default, set image scale to 2×, and GIF to 30 fps
t.exportOverlay.setDefaults({ format: 'image', image: { scale: 2 }, gif: { frameRate: 30 } });

---

setPosition()

setPosition(position): void;

Moves the export overlay to a custom canvas-relative placement and remembers that placement for future sessions on the same origin.

Parameters

Parameter	Type	Description
position	ExportOverlayPositionInput	Canvas-relative overlay offsets in CSS pixels.

Returns

void

Example

t.exportOverlay.setPosition({ offsetX: 24, offsetY: 24 });

---

show()

show(): void;

Shows the export overlay UI.

Returns

void

Example

t.exportOverlay.show();

---

toggle()

toggle(): void;

Toggles the export overlay UI visibility.

Returns

void

Example

t.exportOverlay.toggle();