Interface CustomIconCollection

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

interface CustomIconCollection {
    $CreationOptions?: unknown;
    $ID: string;
    $Type: "CustomIcons$CustomIconCollection";
    $UnitID?: string;
    collectionClass: string;
    documentation: string;
    excluded: boolean;
    exportLevel: ExportLevel;
    fontData: any;
    icons: CustomIcon[];
    name: string;
    prefix: string;
    addCustomIcon(): Promise<CustomIcon>;
    getCustomIcon(name: string): undefined | CustomIcon;
}

Hierarchy (View Summary)

Document
- CustomIconCollection

Index

Properties

$CreationOptions? $ID $Type $UnitID? collectionClass documentation excluded exportLevel fontData icons name prefix

Methods

addCustomIcon getCustomIcon

Properties

`Optional`$CreationOptions

$CreationOptions?: unknown

Options to pass during the element creation

$ID

$ID: string

The unique id of the element.

$Type

$Type: "CustomIcons$CustomIconCollection"

The type of the element.

`Optional`$UnitID

$UnitID?: string

collectionClass

collectionClass: string

documentation

documentation: string

excluded

excluded: boolean

exportLevel

exportLevel: ExportLevel

fontData

fontData: any

icons

icons: CustomIcon[]

name

name: string

prefix

prefix: string

Methods

addCustomIcon

addCustomIcon(): Promise<CustomIcon>
Returns Promise<CustomIcon>

getCustomIcon

getCustomIcon(name: string): undefined | CustomIcon
Parameters
- name: string
Returns undefined | CustomIcon