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

    Interface CompanionPresetGroupTemplate<_TManifest>

    A preset which generates a series of buttons from a matrix of values Tip: This allows you to avoid generating repetitive presets which vary just by a few simple values

    interface CompanionPresetGroupTemplate<
        _TManifest extends InstanceTypes = InstanceTypes,
    > {
        commonVariableValues?: CompanionVariableValues;
        description?: string;
        id: string;
        keywords?: string[];
        name: string;
        presetId: string;
        templateValues: { name?: string; value: CompanionVariableValue }[];
        templateVariableName: string;
        type: "template";
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    commonVariableValues? description? id keywords? name presetId templateValues templateVariableName type

    Properties

    commonVariableValues?: CompanionVariableValues

    Local variable values to override on the template

    description?: string

    A description of the preset group

    id: string

    Unique identifier for the preset group This should be stable across updates to the presets

    keywords?: string[]

    Keywords for the preset This is extra search terms to allow users to find the right preset

    name: string

    A name for this preset group

    presetId: string

    The id of preset definition to use as the template for this group

    templateValues: { name?: string; value: CompanionVariableValue }[]

    The values to inject into the template, to generate presets for each value

    Type Declaration

    • Optionalname?: string

      An optional name for the preset, to be shown in the UI, if not provided the name of the referenced preset will be used instead

    • value: CompanionVariableValue

      The value to inject into the template variable

    templateVariableName: string

    The name of the local variable on the template which will be replaced by the values

    type: "template"

    The type of the preset group

    Settings

    Member Visibility

    On This Page

    Properties