Interface CompanionInputFieldBase

The common properties for an input field

interface CompanionInputFieldBase {
    id: string;
    isVisible?: ((options: CompanionOptionValues, data: any) => boolean);
    isVisibleData?: any;
    label: string;
    tooltip?: string;
    type:
        | "number"
        | "static-text"
        | "textinput"
        | "dropdown"
        | "multidropdown"
        | "colorpicker"
        | "checkbox"
        | "custom-variable"
        | "bonjour-device";
}

Hierarchy (view full)

Properties

id isVisible? isVisibleData? label tooltip? type

Properties

id

id: string

The unique id of this input field within the input group

OptionalisVisible

isVisible?: ((options: CompanionOptionValues, data: any) => boolean)

A function called to check whether this input should be visible, based on the current options selections within the input group

Note: This function must not depend on anything outside of its scope. If it does it will fail to compile and will be skipped.

OptionalisVisibleData

isVisibleData?: any

JSON serializable data to provide to isVisible

label

label: string

The label of the field

Optionaltooltip

tooltip?: string

A hover tooltip for this field

type

type:
    | "number"
    | "static-text"
    | "textinput"
    | "dropdown"
    | "multidropdown"
    | "colorpicker"
    | "checkbox"
    | "custom-variable"
    | "bonjour-device"

The type of this input field

Settings

Member Visibility

On This Page

Properties