@companion-module/base
    Preparing search index...

    Interface CompanionGraphicsCompositeElementDefinition<TSchema>

    interface CompanionGraphicsCompositeElementDefinition<
        TSchema extends
            CompanionCompositeElementSchema<any> = CompanionCompositeElementSchema<
            any,
        >,
    > {
        description?: string;
        elements: SomeButtonGraphicsElement[];
        name: string;
        options: SomeCompanionFeedbackInputField<
            Extract<keyof TSchema["options"], string>,
        >[];
        sortName?: string;
        type: "composite";
    }

    Type Parameters

    Index

    Properties

    description? elements name options sortName? type

    Properties

    description?: string

    Additional description of the element

    elements: SomeButtonGraphicsElement[]

    The elements that make up this composite element

    name: string

    Name to show in the elements list

    options: SomeCompanionFeedbackInputField<
        Extract<keyof TSchema["options"], string>,
    >[]

    The input fields for the element

    sortName?: string

    Alternate value to use when sorting the list of elements By default, the elements are ordered by the name field, but you can override this without altering the visible name by setting this value

    type: "composite"

    Settings

    Member Visibility

    On This Page

    Properties