Script API - v1.26.10.25
    Preparing search index...

    Interface ITagContainerPropertyItem

    A property item which supports Tag Container properties

    interface ITagContainerPropertyItem {
        enable: boolean;
        id: string;
        paneId: string;
        tags: readonly string[];
        tagsPool: readonly string[];
        typeName: PropertyItemType;
        visible: boolean;
        addTag(tag: string): void;
        addTagToPool(tag: string): void;
        removeTag(tag: string): void;
        removeTagFromPool(tag: string): void;
        setTags(tags: string[]): void;
        setTagsPool(tagsPool: string[]): void;
        setTitle(title: LocalizedString): void;
        setVariant(variant: TagContainerVariant): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    enable id paneId tags tagsPool typeName visible

    Methods

    addTag addTagToPool removeTag removeTagFromPool setTags setTagsPool setTitle setVariant

    Properties

    enable: boolean

    If the item is enabled in the UI.

    id: string

    Unique ID for the property item.

    paneId: string

    The parent pane id.

    tags: readonly string[]

    Current tags value of the property item.

    tagsPool: readonly string[]

    Current tags pool value of the property item.

    typeName: PropertyItemType

    The type name of the target property.

    visible: boolean

    If the item should be visible in the UI.

    Methods

    • Parameters

      • tag: string

        Tag to add.

      Returns void

      Adds a tag to the current tags.

    • Parameters

      • tag: string

        Tag to add to the pool.

      Returns void

      Adds a tag to the tags pool.

    • Parameters

      • tag: string

        Tag to remove.

      Returns void

      Removes a tag from the current tags.

    • Parameters

      • tag: string

        Tag to remove from the pool.

      Returns void

      Removes a tag from the tags pool.

    • Parameters

      • tags: string[]

        New tags array.

      Returns void

      Updates all tags.

    • Parameters

      • tagsPool: string[]

        New tags pool array.

      Returns void

      Updates the tags pool.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods