{ "$schema": "../../TcHmiFramework/Schema/ControlDescription.Schema.json", "apiVersion": 1, "name": "TcHmiRecipeSelect", "namespace": "TcHmi.Controls.Beckhoff", "displayName": "Recipe Select", "version": { "full": "14.4.1.0", "major": 14, "minor": 4, "build": 1, "revision": 0 }, "visible": true, "themeable": "Standard", "base": "TcHmi.Controls.System.TcHmiControl", "description": "A control to select recipes at runtime", "defaultDesignerEvent": "", "properties": { "containerControl": false, "geometry": { "width": 350, "height": 101 } }, "icons": [ { "name": "Icons/16x16.png", "width": 16, "height": 16 } ], "template": "Template.html", "dependencyFiles": [ { "name": "Style.css", "type": "Stylesheet", "description": "" }, { "name": "../dist/TcHmiRecipeSelect/TcHmiRecipeSelect.esm.js", "type": "EsModule", "description": "Contains all the main logic as ES module." } ], "themes": { "Base": { "resources": [ { "name": "Themes/Base/Style.css", "type": "Stylesheet", "description": "" } ] }, "Base-Dark": { "resources": [ { "name": "Themes/Base-Dark/Style.css", "type": "Stylesheet", "description": "" } ] } }, "attributes": [ { "name": "data-tchmi-server-domain", "propertyName": "ServerDomain", "propertySetterName": "setServerDomain", "propertyGetterName": "getServerDomain", "displayName": "Server Domain", "visible": true, "displayPriority": 100, "type": "tchmi:general#/definitions/String", "category": "Common", "themeable": "Advanced", "description": "The domain of the recipe management extension in the server. Defaults to 'TcHmiRecipeManagement'.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "defaultValue": null, "defaultValueInternal": "TcHmiRecipeManagement" }, { "name": "data-tchmi-server-interval", "propertyName": "ServerInterval", "propertySetterName": "setServerInterval", "propertyGetterName": "getServerInterval", "displayName": "Server Interval", "visible": true, "displayPriority": 100, "type": "tchmi:general#/definitions/Number", "category": "Common", "themeable": "Advanced", "description": "Sets the interval for the subscription to the Config::recipeList and GetActiveRecipes symbols of the configured server domain in milliseconds. This might be expensive performance wise, so do not set to a very low value.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "defaultValue": 1000, "defaultValueInternal": null }, { "name": "data-tchmi-selected-recipe-full-name", "propertyName": "SelectedRecipeFullName", "propertyGetterName": "getSelectedRecipeFullName", "displayName": "Selected Recipe Full Name", "visible": true, "displayPriority": 100, "type": "tchmi:general#/definitions/String", "category": "Common", "description": "The full name of the selected recipe", "readOnly": true, "bindable": false, "defaultBindingMode": "OneWay", "heritable": true }, { "name": "data-tchmi-selected-recipe-name", "propertyName": "SelectedRecipeName", "propertyGetterName": "getSelectedRecipeName", "displayName": "Selected Recipe Name", "visible": true, "displayPriority": 100, "type": "tchmi:general#/definitions/String", "category": "Common", "description": "The name of the selected recipe", "readOnly": true, "bindable": false, "defaultBindingMode": "OneWay", "heritable": true }, { "name": "data-tchmi-selected-recipe-path", "propertyName": "SelectedRecipePath", "propertyGetterName": "getSelectedRecipePath", "displayName": "Selected Recipe Path", "visible": true, "displayPriority": 100, "type": "tchmi:general#/definitions/String", "category": "Common", "description": "The path of the selected recipe", "readOnly": true, "bindable": false, "defaultBindingMode": "OneWay", "heritable": true }, { "name": "data-tchmi-allowed-recipe-types", "propertyName": "AllowedRecipeTypes", "propertySetterName": "setAllowedRecipeTypes", "propertyGetterName": "getAllowedRecipeTypes", "displayName": "Allowed Recipe Types", "visible": true, "displayPriority": 12, "type": "tchmi:framework#/definitions/TcHmi.Controls.Beckhoff.TcHmiRecipeSelect.NameArray", "category": "Common", "themeable": "Advanced", "description": "Which recipe types are allowed. Recipes that are based on other types are hidden.\nIf not set, or set to an empty array, recipes of all types will be shown.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "allowSymbolExpressionsInObject": true, "defaultValue": null, "defaultValueInternal": null }, { "name": "data-tchmi-prompt-before-activating", "propertyName": "PromptBeforeActivating", "propertySetterName": "setPromptBeforeActivating", "propertyGetterName": "getPromptBeforeActivating", "displayName": "Prompt Before Activating", "visible": true, "displayPriority": 15, "type": "tchmi:general#/definitions/Boolean", "category": "Common", "themeable": "Advanced", "description": "Whether to display a popup asking the user for confirmation before activating a recipe.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "defaultValue": null, "defaultValueInternal": false }, { "name": "data-tchmi-prompt-before-teaching", "propertyName": "PromptBeforeTeaching", "propertySetterName": "setPromptBeforeTeaching", "propertyGetterName": "getPromptBeforeTeaching", "displayName": "Prompt Before Teaching", "visible": true, "displayPriority": 16, "type": "tchmi:general#/definitions/Boolean", "category": "Common", "themeable": "Advanced", "description": "Whether to display a popup asking the user for confirmation before teaching a recipe.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "defaultValue": null, "defaultValueInternal": false } ], "attributeCategories": [], "functions": [], "events": [ { "name": ".onRecipeActivated", "displayName": ".onRecipeActivated", "visible": true, "displayPriority": 6, "category": "Operator", "description": "The onRecipeActivated event is fired when the selected recipe is activated.", "heritable": true, "arguments": [ { "type": "tchmi:framework#/definitions/TcHmiRecipeSelectRecipeNameEventObject", "description": "The event object containing information about the recipe name." } ] }, { "name": ".onRecipeTaught", "displayName": ".onRecipeTaught", "visible": true, "displayPriority": 6, "category": "Operator", "description": "The onRecipeTaught event is fired when the selected recipe is taught.", "heritable": true, "arguments": [ { "type": "tchmi:framework#/definitions/TcHmiRecipeSelectRecipeNameEventObject", "description": "The event object containing information about the recipe name." } ] } ], "access": [ { "name": "activateRecipe", "displayName": "Activate Recipe", "description": "Controls the ability to activate the selected recipe. This defaults to true.", "visible": true, "defaultValueInternal": true, "dependsOn": [ "operate" ] }, { "name": "teachRecipe", "displayName": "Teach Recipe", "description": "Controls the ability to teach the selected recipe. This defaults to true.", "visible": true, "defaultValueInternal": true, "dependsOn": [ "operate" ] } ], "dataTypes": [ { "schema": "Schema/Types.Schema.json" } ], "languages": { "en": "Lang/Language.en.json", "de": "Lang/Language.de.json" } }