{ "$schema": "../../TcHmiFramework/Schema/ControlDescription.Schema.json", "apiVersion": 1, "name": "TcHmiTimespanInput", "namespace": "TcHmi.Controls.Beckhoff", "displayName": "Timespan Input", "version": { "full": "14.4.1.0", "major": 14, "minor": 4, "build": 1, "revision": 0 }, "visible": true, "themeable": "Standard", "base": "TcHmi.Controls.System.TcHmiControl", "description": "An input control which only accepts ISO 8601 timespans.", "defaultDesignerEvent": ".onValueChanged", "properties": { "containerControl": false, "geometry": { "width": 264, "height": 26 } }, "icons": [ { "name": "Icons/16x16.png", "width": 16, "height": 16 } ], "template": "Template.html", "dependencyFiles": [ { "name": "Style.css", "type": "Stylesheet", "description": "" }, { "name": "../dist/TcHmiTimespanInput/TcHmiTimespanInput.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-value-color", "propertyName": "ValueColor", "propertySetterName": "setValueColor", "propertyGetterName": "getValueColor", "displayName": "Value Color", "visible": true, "themeable": "Standard", "displayPriority": 10, "type": "tchmi:framework#/definitions/SolidColor", "category": "Colors", "description": "The color of the displayed value", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "allowSymbolExpressionsInObject": true, "defaultValue": null, "defaultValueInternal": null }, { "name": "data-tchmi-value", "propertyName": "Value", "propertySetterName": "setValue", "propertyGetterName": "getValue", "displayName": "Value", "visible": true, "themeable": "Standard", "displayPriority": 10, "type": "tchmi:general#/definitions/TimeSpan", "category": "Common", "description": "The timespan value defined as ISO timespan.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "defaultValue": "", "defaultValueInternal": null }, { "name": "data-tchmi-max-value", "propertyName": "MaxValue", "propertySetterName": "setMaxValue", "propertyGetterName": "getMaxValue", "displayName": "Max Value", "visible": true, "displayPriority": 10, "type": "tchmi:general#/definitions/TimeSpan", "category": "Common", "description": "The max value defined as ISO timespan.", "themeable": "Advanced", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "defaultValue": null, "defaultValueInternal": null }, { "name": "data-tchmi-value-symbol", "propertyName": "ValueSymbol", "propertySetterName": "setValueSymbol", "propertyGetterName": "getValueSymbol", "displayName": "Value Symbol", "visible": true, "themeable": "None", "displayPriority": 10, "type": "tchmi:framework#/definitions/TcHmi.Controls.Beckhoff.TcHmiTimespanInput.ValueSymbol", "category": "Common", "description": "A symbol which represents a time variable from the server. This attribute overwrites an existing Value attribute.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "allowEarlySymbolReferenceInjection": true, "defaultValue": null, "defaultValueInternal": null }, { "name": "data-tchmi-value-horizontal-alignment", "propertyName": "ValueHorizontalAlignment", "propertySetterName": "setValueHorizontalAlignment", "propertyGetterName": "getValueHorizontalAlignment", "displayName": "Value Horizontal Alignment", "visible": true, "themeable": "Standard", "displayPriority": 20, "type": "tchmi:framework#/definitions/HorizontalAlignment", "category": "Value", "description": "The horizontal alignment of the displayed value", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "defaultValue": null, "defaultValueInternal": null }, { "name": "data-tchmi-content-padding", "propertyName": "ContentPadding", "propertySetterName": "setContentPadding", "propertyGetterName": "getContentPadding", "displayName": "Content Padding", "visible": true, "themeable": "Standard", "displayPriority": 55, "type": "tchmi:framework#/definitions/Padding", "category": "Value", "description": "The distance of the value to the border.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "allowSymbolExpressionsInObject": true, "defaultValue": { "top": 3, "right": 3, "bottom": 3, "left": 3 }, "defaultValueInternal": null }, { "name": "data-tchmi-value-font-family", "propertyName": "ValueFontFamily", "propertySetterName": "setValueFontFamily", "propertyGetterName": "getValueFontFamily", "displayName": "Value Font Family", "visible": true, "themeable": "Standard", "displayPriority": 60, "type": "tchmi:framework#/definitions/FontFamily", "category": "Value", "description": "Comma separated list of family name or keyword: 'serif', 'sans-serif', 'monospace'.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "defaultValue": null, "defaultValueInternal": null }, { "name": "data-tchmi-value-font-size", "propertyName": "ValueFontSize", "propertySetterName": "setValueFontSize", "propertyGetterName": "getValueFontSize", "displayName": "Value Font Size", "visible": true, "themeable": "Standard", "displayPriority": 30, "type": "tchmi:framework#/definitions/MeasurementValue", "category": "Value", "description": "The size of the font. Percent values are relative to the parent elements font size.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "defaultValue": null, "defaultValueInternal": null }, { "name": "data-tchmi-value-font-size-unit", "propertyName": "ValueFontSizeUnit", "propertySetterName": "setValueFontSizeUnit", "propertyGetterName": "getValueFontSizeUnit", "refTo": "ValueFontSize", "displayName": "Value Font Size Unit", "visible": true, "themeable": "Advanced", "displayPriority": 30, "type": "tchmi:framework#/definitions/MeasurementUnit", "category": "Value", "description": "Could be 'px' or for relative sizing '%'.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "defaultValue": null, "defaultValueInternal": "px" }, { "name": "data-tchmi-value-font-style", "propertyName": "ValueFontStyle", "propertySetterName": "setValueFontStyle", "propertyGetterName": "getValueFontStyle", "displayName": "Value Font Style", "visible": true, "themeable": "Standard", "displayPriority": 60, "type": "tchmi:framework#/definitions/FontStyle", "category": "Value", "description": "'Normal', 'Italic' (slanted with special glyphs), 'Oblique' (slanted normal glyphs) or 'Auto' for inherited.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "defaultValue": null, "defaultValueInternal": "Auto" }, { "name": "data-tchmi-value-font-weight", "propertyName": "ValueFontWeight", "propertySetterName": "setValueFontWeight", "propertyGetterName": "getValueFontWeight", "displayName": "Value Font Weight", "visible": true, "themeable": "Standard", "displayPriority": 60, "type": "tchmi:framework#/definitions/FontWeight", "category": "Value", "description": "'Normal', 'Bold' (glyphs with more weight) or 'Auto' for inherited.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "defaultValue": null, "defaultValueInternal": "Auto" }, { "name": "data-tchmi-placeholder", "propertyName": "Placeholder", "propertySetterName": "setPlaceholder", "propertyGetterName": "getPlaceholder", "displayName": "Placeholder", "visible": true, "themeable": "Standard", "displayPriority": 50, "type": "tchmi:general#/definitions/String", "category": "Value", "description": "A placeholder text to display if the timespan input is empty.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "defaultValue": null, "defaultValueInternal": null }, { "name": "data-tchmi-auto-focus-out", "propertyName": "AutoFocusOut", "propertySetterName": "setAutoFocusOut", "propertyGetterName": "getAutoFocusOut", "displayName": "Auto Focus Out", "visible": true, "themeable": "Advanced", "displayPriority": 45, "type": "tchmi:general#/definitions/Boolean", "category": "Common", "description": "Whether the control should automatically lose focus when the user confirms or cancels his interaction via enter or escape.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "defaultValue": true, "defaultValueInternal": false }, { "name": "data-tchmi-auto-select-text", "propertyName": "AutoSelectText", "propertySetterName": "setAutoSelectText", "propertyGetterName": "getAutoSelectText", "displayName": "Auto Select Text", "visible": true, "themeable": "Advanced", "displayPriority": 50, "type": "tchmi:general#/definitions/Boolean", "category": "Common", "description": "Whether a focusIn selects the whole text or not.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "defaultValue": null, "defaultValueInternal": false }, { "name": "data-tchmi-reset-to-last-valid-value", "propertyName": "ResetToLastValidValue", "propertySetterName": "setResetToLastValidValue", "propertyGetterName": "getResetToLastValidValue", "displayName": "Reset to Last Valid Value", "visible": true, "themeable": "Advanced", "displayPriority": 45, "type": "tchmi:general#/definitions/Boolean", "category": "Common", "description": "Whether the displayed text is reseted to the last valid value on focus out.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "defaultValue": true, "defaultValueInternal": false }, { "name": "data-tchmi-input-processing-point", "propertyName": "InputProcessingPoint", "propertySetterName": "setInputProcessingPoint", "propertyGetterName": "getInputProcessingPoint", "displayName": "Input Processing Point", "visible": true, "themeable": "Advanced", "displayPriority": 50, "type": "tchmi:framework#/definitions/TcHmi.Controls.Beckhoff.InputProcessingPoint", "category": "Common", "description": "When to process the input made by the user. Either while the input is still happening (i.e. on every keystroke) or after the interaction has finished (i.e. the control loses focus).", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "defaultValue": null, "defaultValueInternal": "InteractionFinished" }, { "name": "data-tchmi-button-Position", "propertyName": "ButtonPosition", "propertySetterName": "setButtonPosition", "propertyGetterName": "getButtonPosition", "displayName": "Button Position", "visible": true, "themeable": "Standard", "displayPriority": 40, "type": "tchmi:framework#/definitions/TcHmi.Controls.Beckhoff.TcHmiTimespanInput.ButtonPosition", "category": "Common", "description": "Defines the position of the button", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "defaultValue": null, "defaultValueInternal": "Right" }, { "name": "data-tchmi-direct-input-unit", "propertyName": "DirectInputUnit", "propertySetterName": "setDirectInputUnit", "propertyGetterName": "getDirectInputUnit", "displayName": "Direct Input Unit", "visible": true, "themeable": "Standard", "displayPriority": 40, "type": "tchmi:framework#/definitions/TcHmi.Controls.Beckhoff.TcHmiTimespanInput.DirectInputUnit", "category": "Common", "description": "Defines the unit in which numeric input is possible in the textbox. If 'None' is selected only the ISO 8601 timespan format is accepted.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "defaultValue": null, "defaultValueInternal": "None" }, { "name": "data-tchmi-is-read-only", "propertyName": "IsReadOnly", "propertySetterName": "setIsReadOnly", "propertyGetterName": "getIsReadOnly", "displayName": "Is Read Only", "visible": true, "themeable": "Standard", "displayPriority": 52, "type": "tchmi:general#/definitions/Boolean", "category": "Common", "description": "Controls whose primary purpose is data input can be set to read-only to only display data without allowing modification.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "defaultValue": null, "defaultValueInternal": false }, { "name": "data-tchmi-time-units", "propertyName": "TimeUnits", "propertySetterName": "setTimeUnits", "propertyGetterName": "getTimeUnits", "displayName": "Time Units", "visible": true, "themeable": "Standard", "displayPriority": 60, "type": "tchmi:framework#/definitions/TcHmi.Controls.Beckhoff.TcHmiTimespanPicker.TimeUnits", "category": "Common", "description": "Defines for each field whether it should be displayed.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "allowSymbolExpressionsInObject": true, "defaultValue": null, "defaultValueInternal": { "days": true, "hours": true, "milliseconds": true, "minutes": true, "months": true, "seconds": true, "years": true } } ], "attributeCategories": [ { "name": "Value", "displayPriority": 500, "defaultCollapsed": true, "description": "Attributes defining the value of the control." } ], "functions": [], "events": [ { "name": ".onFocusIn", "displayName": ".onFocusIn", "visible": true, "displayPriority": 7, "category": "Operator", "description": "The focusin event is fired when an element is about to receive focus.", "heritable": true, "arguments": [ { "type": "tchmi:framework#/definitions/DOMFocusEvent", "description": "The FocusEvent object of the underlying focusin dom event." } ] }, { "name": ".onFocusOut", "displayName": ".onFocusOut", "visible": true, "displayPriority": 7, "category": "Operator", "description": "The focusout event is fired when an element is about to lose focus.", "heritable": true, "arguments": [ { "type": "tchmi:framework#/definitions/DOMEvent", "description": "The Event object of the underlying focusout dom event." } ] }, { "name": ".onValueChanged", "displayName": ".onValueChanged", "visible": true, "displayPriority": 10, "category": "Control", "description": "The valuechanged event is fired when the value was changed. This event could be fired multiples times while a user interaction.", "heritable": true, "arguments": [ { "type": "tchmi:general#/definitions/TimeSpan", "description": "The new value of the TimespanInput." } ] }, { "name": ".onUserInteractionFinished", "displayName": ".onUserInteractionFinished", "visible": true, "displayPriority": 5, "category": "Operator", "description": "The userinteractionfinished event is fired after leaving the timespan input.", "heritable": true, "arguments": [] }, { "name": ".onUserInteractionCanceled", "displayName": ".onUserInteractionCanceled", "visible": true, "displayPriority": 7, "category": "Operator", "description": "The userinteractioncanceled event is fired when the user presses the escape key, causing the value to reset to its previous value.", "heritable": true, "arguments": [] } ], "dataTypes": [ { "schema": "Schema/Types.Schema.json" } ], "languages": { "en": "Lang/Language.en.json", "de": "Lang/Language.de.json" } }