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

    Interface IBoolPropertyItemOptions

    Optional properties for Bool property item

    interface IBoolPropertyItemOptions {
        checkboxIcon?: string;
        enable?: boolean;
        hiddenLabel?: boolean;
        onChange?: (newValue: boolean, oldValue: boolean) => void;
        style?: PaneItemStyle;
        title?: LocalizedString;
        tooltip?: BasicTooltipContent;
        variant?: BoolPropertyItemVariant;
        visible?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    checkboxIcon? enable? hiddenLabel? onChange? style? title? tooltip? variant? visible?

    Properties

    checkboxIcon?: string

    Changes checkbox variant to use a custom icon

    enable?: boolean

    Initial enabled state of property item. If undefined, it will default to true.

    hiddenLabel?: boolean

    If true label text will be hidden. It will be visible by default.

    onChange?: (newValue: boolean, oldValue: boolean) => void

    This callback is called when UI control value is changed.

    style?: PaneItemStyle

    Optional styling overrides for the item.

    title?: LocalizedString

    Localized title of the text item.

    tooltip?: BasicTooltipContent

    Tooltip description of the property item

    variant?: BoolPropertyItemVariant

    Determines how we display bool as a UI element. If undefined, it will default to Checkbox.

    visible?: boolean

    Initial visibility state of property item. If undefined, it will default to true.

    Settings

    Member Visibility

    On This Page

    Properties