Skip to main content

LensStudio:LensPreview.LensPreviewOptions

Class

Options passed to the LensPreview constructor.

Index

Properties

Example

Tag a headless preview so its log output can be told apart from other previews.

import { LensPreview, LensPreviewOptions } from 'LensStudio:LensPreview';

export function createTaggedPreview(pluginSystem: Editor.PluginSystem, tag: string): LensPreview {
const options = new LensPreviewOptions();
options.tag = tag; // without a tag, the preview is labeled with a number
return new LensPreview(pluginSystem, options);
}

Constructors

Constructor

new LensPreviewOptions(): LensPreviewOptions

Constructs LensPreviewOptions with an empty tag.

Returns

LensPreviewOptions

Properties

tag

tag: string

Label that identifies the preview in log output. When empty, the preview is labeled with an automatically assigned number.