Interface Snippet

A unit is a container of elements, it can not contain other units.

interface Snippet {
    $CreationOptions?: SnippetCreationOptions;
    $ID: string;
    $Type: "Pages$Snippet";
    $UnitID?: string;
    canvasHeight: number;
    canvasWidth: number;
    documentation: string;
    excluded: boolean;
    exportLevel: ExportLevel;
    name: string;
    parameters: SnippetParameter[];
    type: SnippetType;
    variables: LocalVariable[];
    widgets: Pages.Widget[];
}

Hierarchy (View Summary)

FormBaseBase
- Snippet

Index

Properties

$CreationOptions? $ID $Type $UnitID? canvasHeight canvasWidth documentation excluded exportLevel name parameters type variables widgets

Properties

`Optional`$CreationOptions

$CreationOptions?: SnippetCreationOptions

Options to pass during the element creation

$ID

$ID: string

The unique id of the element.

$Type

$Type: "Pages$Snippet"

The type of the element.

`Optional`$UnitID

$UnitID?: string

canvasHeight

canvasHeight: number

canvasWidth

canvasWidth: number

documentation

documentation: string

excluded

excluded: boolean

exportLevel

exportLevel: ExportLevel

name

name: string

parameters

parameters: SnippetParameter[]

type

type: SnippetType

variables

variables: LocalVariable[]

widgets

widgets: Pages.Widget[]