Interface ImageCollection

See: relevant section in reference guide

interface ImageCollection {
    $CreationOptions?: ImageCollectionCreationOptions;
    $ID: string;
    $Type: "Images$ImageCollection";
    documentation: string;
    excluded: boolean;
    exportLevel: ExportLevel;
    images: Image[];
    name: string;
    addImage(options: ImageCreationOptions): Promise<Image>;
    getImage(name: string): undefined | Image;
}

Hierarchy (View Summary)

Document
- ImageCollection

Index

Properties

$CreationOptions? $ID $Type documentation excluded exportLevel images name

Methods

addImage getImage

Properties

`Optional`$CreationOptions

$CreationOptions?: ImageCollectionCreationOptions

Options to pass during the element creation

$ID

$ID: string

The unique id of the element.

$Type

$Type: "Images$ImageCollection"

The type of the element.

documentation

documentation: string

excluded

excluded: boolean

exportLevel

exportLevel: ExportLevel

images

images: Image[]

name

name: string

Methods

addImage

addImage(options: ImageCreationOptions): Promise<Image>
Parameters
- options: ImageCreationOptions
Returns Promise<Image>

getImage

getImage(name: string): undefined | Image
Parameters
- name: string
Returns undefined | Image