RecipeType

[ Interface ]

export interface RecipeType {
    recipeTypeNames?: string[];
    members: Dictionary<{
        symbol: string;
        defaultValue?: any;
        schema?: TcHmi.JsonSchema;
        unit?: string;
        comment?: string;
        enabled?: boolean;
        group?: string;
        order?: number;
    } | {
        recipeType: string;
    }>;
    options?: {
        enabled?: 'None' | 'Disabled';
        comment?: string;
    };
}

Definition of a recipe type.

Properties

Name	Type	Description
recipeTypeNames [optional]	string[]	List of recipes from which this recipe type inherits.
members		List of symbols that define the recipe type
options [optional]		Recipe type options
options.enabled [optional]	'None' \| 'Disabled'	Specifies whether the recipe type is active. `None`: No restriction at recipe type level. `Disabled`: All members of the recipe are deactivated.
options.comment [optional]	string	Free text comment

Properties of the symbol definition

Name	Type	Description
symbol [optional]	string[]	Name of the symbol
defaultValue [optional]	any	Value that applies if a recipe does not define its own value
schema [optional]	TcHmi.JsonSchema	Schema that defines value restrictions. (For example minimum or maximum value)
unit [optional]	string	Physical unit of the value
comment [optional]	string	Free text comment
enabled [optional]	boolean	Indicates whether the symbol is active in the recipe type
group [optional]	string	Group for the display in Visual Studio
order [optional]	number	Order for the display in Visual Studio

	Available from version 1.10.1171.142