{ "$schema": "../../TcHmiFramework/Schema/ControlDescription.Schema.json", "apiVersion": 1, "name": "TcHmiEventGrid", "namespace": "TcHmi.Controls.Beckhoff", "displayName": "Event Grid", "version": { "full": "14.4.1.0", "major": 14, "minor": 4, "build": 1, "revision": 0 }, "visible": true, "themeable": "Standard", "base": "TcHmi.Controls.System.TcHmiControl", "description": "Display Events in a Grid.", "defaultDesignerEvent": ".onSelectedItemChanged", "properties": { "containerControl": false, "geometry": { "width": 665, "height": 400 } }, "icons": [ { "name": "Icons/16x16.png", "width": 16, "height": 16 } ], "template": "Template.html", "dependencyFiles": [ { "name": "Style.css", "type": "Stylesheet", "description": "" }, { "name": "../dist/TcHmiEventGrid/TcHmiEventGrid.esm.js", "type": "EsModule", "description": "Contains all the main logic as ES module." } ], "themes": { "Base": { "resources": [ { "name": "Themes/Base/Defaults.theme", "type": "ThemedValues", "description": "" }, { "name": "Themes/Base/Style.css", "type": "Stylesheet", "description": "" } ] }, "Base-Dark": { "resources": [ { "name": "Themes/Base-Dark/Defaults.theme", "type": "ThemedValues", "description": "" }, { "name": "Themes/Base-Dark/Style.css", "type": "Stylesheet", "description": "" } ] } }, "attributes": [ { "name": "data-tchmi-filter", "displayName": "Filter", "propertyName": "Filter", "propertySetterName": "setFilter", "propertyGetterName": "getFilter", "visible": true, "themeable": "Standard", "type": "tchmi:server#/definitions/eventFilter", "category": "Common", "description": "The filter the events should match.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "allowSymbolExpressionsInObject": true, "defaultValue": [ { "path": "domain", "comparator": "==", "value": "TcHmiEventLogger" }, { "logic": "OR" }, { "path": "domain", "comparator": "==", "value": "TcHmiAlarm" } ], "defaultValueInternal": null }, { "name": "data-tchmi-columns", "displayName": "Columns", "propertyName": "Columns", "propertySetterName": "setColumns", "propertyGetterName": "getColumns", "visible": true, "themeable": "Standard", "type": "tchmi:framework#/definitions/TcHmi.Controls.Beckhoff.TcHmiEventGrid.ColumnList", "category": "Common", "description": "The columns shown in the grid.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "allowSymbolExpressionsInObject": true, "defaultValue": [ { "columnName": "type" }, { "columnName": "severity" }, { "columnName": "timeAndDateRaised" }, { "columnName": "text", "width": 1, "widthUnit": "factor" } ], "defaultValueInternal": [] }, { "name": "data-tchmi-sorting", "displayName": "Sorting", "propertyName": "Sorting", "propertySetterName": "setSorting", "propertyGetterName": "getSorting", "visible": true, "themeable": "Advanced", "displayPriority": 10, "type": "tchmi:framework#/definitions/Sorting", "category": "Common", "description": "Defines sorting rules for the displayed data.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "allowSymbolExpressionsInObject": true, "defaultValue": [ { "name": "timeRaised", "order": "Descending" } ], "defaultValueInternal": [] }, { "name": "data-tchmi-server-interval", "displayName": "Server Interval", "propertyName": "ServerInterval", "propertySetterName": "setServerInterval", "propertyGetterName": "getServerInterval", "visible": true, "themeable": "Advanced", "displayPriority": 60, "type": "tchmi:general#/definitions/Number", "category": "Common", "description": "Sets the interval for the ListEvents subscription in milliseconds. This is quite 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-allow-details-popup", "displayName": "Allow Details Popup", "propertyName": "AllowDetailsPopup", "propertySetterName": "setAllowDetailsPopup", "propertyGetterName": "getAllowDetailsPopup", "visible": true, "themeable": "Advanced", "displayPriority": 60, "type": "tchmi:general#/definitions/Boolean", "category": "Common", "description": "Controls whether the details popup is shown when the user doubleclicks an event", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "defaultValue": null, "defaultValueInternal": true }, { "name": "data-tchmi-selected-event", "displayName": "Selected Event", "propertyName": "SelectedEvent", "propertyGetterName": "getSelectedEvent", "visible": true, "type": "tchmi:framework#/definitions/ServerEvent", "category": "Common", "description": "The currently selected event.", "readOnly": true, "bindable": false, "defaultBindingMode": "OneWay", "heritable": true }, { "name": "data-tchmi-header-font-family", "propertyName": "HeaderFontFamily", "propertySetterName": "setHeaderFontFamily", "propertyGetterName": "getHeaderFontFamily", "displayName": "Header Font Family", "visible": true, "themeable": "Standard", "displayPriority": 60, "type": "tchmi:framework#/definitions/FontFamily", "category": "Grid", "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-header-font-size", "displayName": "Header Font Size", "propertyName": "HeaderFontSize", "propertySetterName": "setHeaderFontSize", "propertyGetterName": "getHeaderFontSize", "visible": true, "themeable": "Standard", "displayPriority": 10, "type": "tchmi:framework#/definitions/MeasurementValue", "category": "Grid", "description": "The font size of the header row.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "defaultValue": null, "defaultValueInternal": null }, { "name": "data-tchmi-header-font-size-unit", "displayName": "Header Font Size Unit", "propertyName": "HeaderFontSizeUnit", "propertySetterName": "setHeaderFontSizeUnit", "propertyGetterName": "getHeaderFontSizeUnit", "refTo": "HeaderFontSize", "visible": true, "themeable": "Advanced", "displayPriority": 10, "type": "tchmi:framework#/definitions/MeasurementUnit", "category": "Grid", "description": "The font size unit of the header row.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "defaultValue": null, "defaultValueInternal": "px" }, { "name": "data-tchmi-header-font-style", "propertyName": "HeaderFontStyle", "propertySetterName": "setHeaderFontStyle", "propertyGetterName": "getHeaderFontStyle", "displayName": "Header Font Style", "visible": true, "themeable": "Standard", "displayPriority": 60, "type": "tchmi:framework#/definitions/FontStyle", "category": "Grid", "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-header-font-weight", "propertyName": "HeaderFontWeight", "propertySetterName": "setHeaderFontWeight", "propertyGetterName": "getHeaderFontWeight", "displayName": "Header Font Weight", "visible": true, "themeable": "Standard", "displayPriority": 60, "type": "tchmi:framework#/definitions/FontWeight", "category": "Grid", "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-grid-font-family", "propertyName": "GridFontFamily", "propertySetterName": "setGridFontFamily", "propertyGetterName": "getGridFontFamily", "displayName": "Grid Font Family", "visible": true, "themeable": "Standard", "displayPriority": 60, "type": "tchmi:framework#/definitions/FontFamily", "category": "Grid", "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-grid-font-size", "displayName": "Grid Font Size", "propertyName": "GridFontSize", "propertySetterName": "setGridFontSize", "propertyGetterName": "getGridFontSize", "visible": true, "themeable": "Standard", "displayPriority": 10, "type": "tchmi:framework#/definitions/MeasurementValue", "category": "Grid", "description": "The font size of rows in the table.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "defaultValue": null, "defaultValueInternal": null }, { "name": "data-tchmi-grid-font-size-unit", "displayName": "Grid Font Size Unit", "propertyName": "GridFontSizeUnit", "propertySetterName": "setGridFontSizeUnit", "propertyGetterName": "getGridFontSizeUnit", "refTo": "GridFontSize", "visible": true, "themeable": "Advanced", "displayPriority": 10, "type": "tchmi:framework#/definitions/MeasurementUnit", "category": "Grid", "description": "The font size unit of rows in the table.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "defaultValue": null, "defaultValueInternal": "px" }, { "name": "data-tchmi-grid-font-style", "propertyName": "GridFontStyle", "propertySetterName": "setGridFontStyle", "propertyGetterName": "getGridFontStyle", "displayName": "Grid Font Style", "visible": true, "themeable": "Standard", "displayPriority": 60, "type": "tchmi:framework#/definitions/FontStyle", "category": "Grid", "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-grid-font-weight", "propertyName": "GridFontWeight", "propertySetterName": "setGridFontWeight", "propertyGetterName": "getGridFontWeight", "displayName": "Grid Font Weight", "visible": true, "themeable": "Standard", "displayPriority": 60, "type": "tchmi:framework#/definitions/FontWeight", "category": "Grid", "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-header-height", "displayName": "Header Height", "propertyName": "HeaderHeight", "propertySetterName": "setHeaderHeight", "propertyGetterName": "getHeaderHeight", "visible": true, "themeable": "Standard", "displayPriority": 10, "type": "tchmi:framework#/definitions/MeasurementValue", "category": "Grid", "description": "The height of the header row.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "defaultValue": null, "defaultValueInternal": null }, { "name": "data-tchmi-header-height-unit", "displayName": "Header Height Unit", "propertyName": "HeaderHeightUnit", "propertySetterName": "setHeaderHeightUnit", "propertyGetterName": "getHeaderHeightUnit", "refTo": "HeaderHeight", "visible": true, "themeable": "Advanced", "displayPriority": 10, "type": "tchmi:framework#/definitions/MeasurementUnit", "category": "Grid", "description": "The height unit of the header row.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "defaultValue": null, "defaultValueInternal": "px" }, { "name": "data-tchmi-row-height", "displayName": "Row Height", "propertyName": "RowHeight", "propertySetterName": "setRowHeight", "propertyGetterName": "getRowHeight", "visible": true, "themeable": "Standard", "displayPriority": 10, "type": "tchmi:framework#/definitions/MeasurementValue", "category": "Grid", "description": "The height of rows in the table.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "defaultValue": null, "defaultValueInternal": null }, { "name": "data-tchmi-row-height-unit", "displayName": "Row Height Unit", "propertyName": "RowHeightUnit", "propertyGetterName": "getRowHeightUnit", "refTo": "RowHeight", "visible": true, "displayPriority": 10, "type": "tchmi:framework#/definitions/PixelUnit", "category": "Grid", "description": "The height unit of rows in the table.", "readOnly": true, "bindable": false, "defaultBindingMode": "OneWay", "heritable": true, "defaultValueInternal": "px" }, { "name": "data-tchmi-ignore-escape-sequences", "propertyName": "IgnoreEscapeSequences", "propertySetterName": "setIgnoreEscapeSequences", "propertyGetterName": "getIgnoreEscapeSequences", "displayName": "Ignore Escape Sequences", "visible": true, "themeable": "Advanced", "displayPriority": 100, "type": "tchmi:general#/definitions/Boolean", "category": "Common", "description": "When set to true a backslash in an event text will be shown verbatim in the HMI. This affects all columns.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "defaultValue": null, "defaultValueInternal": false }, { "name": "data-tchmi-show-menu-bar", "displayName": "Show Menu Bar", "propertyName": "ShowMenuBar", "propertySetterName": "setShowMenuBar", "propertyGetterName": "getShowMenuBar", "visible": true, "themeable": "Advanced", "displayPriority": 10, "type": "tchmi:general#/definitions/Boolean", "category": "Menu Bar", "description": "Whether to show the menu bar.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "defaultValue": true, "defaultValueInternal": false }, { "name": "data-tchmi-menu-bar-position", "displayName": "Menu Bar Position", "propertyName": "MenuBarPosition", "propertySetterName": "setMenuBarPosition", "propertyGetterName": "getMenuBarPosition", "visible": true, "themeable": "Advanced", "displayPriority": 20, "type": "tchmi:framework#/definitions/TcHmi.Controls.Beckhoff.TcHmiEventGrid.MenuBarPosition", "category": "Menu Bar", "description": "The position of the menu bar.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "defaultValue": null, "defaultValueInternal": "Top" }, { "name": "data-tchmi-button-font-family", "propertyName": "ButtonFontFamily", "propertySetterName": "setButtonFontFamily", "propertyGetterName": "getButtonFontFamily", "displayName": "Button Font Family", "visible": true, "themeable": "Standard", "displayPriority": 60, "type": "tchmi:framework#/definitions/FontFamily", "category": "Menu Bar", "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-button-font-size", "displayName": "Button Font Size", "propertyName": "ButtonFontSize", "propertySetterName": "setButtonFontSize", "propertyGetterName": "getButtonFontSize", "visible": true, "themeable": "Standard", "displayPriority": 10, "type": "tchmi:framework#/definitions/MeasurementValue", "category": "Menu Bar", "description": "The font size of the buttons in the menu bar.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "defaultValue": null, "defaultValueInternal": null }, { "name": "data-tchmi-button-font-size-unit", "displayName": "Button Font Size Unit", "propertyName": "ButtonFontSizeUnit", "propertySetterName": "setButtonFontSizeUnit", "propertyGetterName": "getButtonFontSizeUnit", "refTo": "ButtonFontSize", "visible": true, "themeable": "Advanced", "displayPriority": 10, "type": "tchmi:framework#/definitions/MeasurementUnit", "category": "Menu Bar", "description": "The font size unit of the buttons in the menu bar.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "defaultValue": null, "defaultValueInternal": "px" }, { "name": "data-tchmi-button-font-style", "propertyName": "ButtonFontStyle", "propertySetterName": "setButtonFontStyle", "propertyGetterName": "getButtonFontStyle", "displayName": "Button Font Style", "visible": true, "themeable": "Standard", "displayPriority": 60, "type": "tchmi:framework#/definitions/FontStyle", "category": "Menu Bar", "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-button-font-weight", "propertyName": "ButtonFontWeight", "propertySetterName": "setButtonFontWeight", "propertyGetterName": "getButtonFontWeight", "displayName": "Button Font Weight", "visible": true, "themeable": "Standard", "displayPriority": 60, "type": "tchmi:framework#/definitions/FontWeight", "category": "Menu Bar", "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-button-height", "displayName": "Button Height", "propertyName": "ButtonHeight", "propertySetterName": "setButtonHeight", "propertyGetterName": "getButtonHeight", "visible": true, "themeable": "Standard", "displayPriority": 10, "type": "tchmi:framework#/definitions/MeasurementValue", "category": "Menu Bar", "description": "The height of the buttons in the menu bar.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "defaultValue": null, "defaultValueInternal": 30 }, { "name": "data-tchmi-button-height-unit", "displayName": "Button Height Unit", "propertyName": "ButtonHeightUnit", "propertyGetterName": "getButtonHeightUnit", "refTo": "ButtonHeight", "visible": true, "displayPriority": 10, "type": "tchmi:framework#/definitions/PixelUnit", "category": "Menu Bar", "description": "The height unit of the buttons in the menu bar.", "readOnly": true, "bindable": false, "defaultBindingMode": "OneWay", "heritable": true, "defaultValueInternal": "px" } ], "attributeCategories": [ { "name": "Grid", "displayPriority": 400, "defaultCollapsed": true, "description": "Attributes controlling the appearance of the grid." }, { "name": "Menu Bar", "displayPriority": 500, "defaultCollapsed": true, "description": "Attributes controlling the menu bar." } ], "themedResources": [ { "name": "MessageIcon", "displayName": "Message Icon", "description": "Icon for messages", "type": "tchmi:framework#/definitions/TcHmi.Controls.Beckhoff.TcHmiEventGrid.IconDefinition" }, { "name": "AlarmIcon", "displayName": "Alarm Icon", "description": "Icon for alarms", "type": "tchmi:framework#/definitions/TcHmi.Controls.Beckhoff.TcHmiEventGrid.IconDefinition" }, { "name": "VerboseIcon", "displayName": "Verbose Icon", "description": "Icon for events with severity verbose", "type": "tchmi:framework#/definitions/TcHmi.Controls.Beckhoff.TcHmiEventGrid.IconDefinition" }, { "name": "InfoIcon", "displayName": "Info Icon", "description": "Icon for events with severity info", "type": "tchmi:framework#/definitions/TcHmi.Controls.Beckhoff.TcHmiEventGrid.IconDefinition" }, { "name": "WarningIcon", "displayName": "Warning Icon", "description": "Icon for events with severity warning", "type": "tchmi:framework#/definitions/TcHmi.Controls.Beckhoff.TcHmiEventGrid.IconDefinition" }, { "name": "ErrorIcon", "displayName": "Error Icon", "description": "Icon for events with severity error", "type": "tchmi:framework#/definitions/TcHmi.Controls.Beckhoff.TcHmiEventGrid.IconDefinition" }, { "name": "CriticalIcon", "displayName": "Critical Icon", "description": "Icon for events with severity critical", "type": "tchmi:framework#/definitions/TcHmi.Controls.Beckhoff.TcHmiEventGrid.IconDefinition" } ], "functions": [ { "name": "confirmSelectedAlarm", "displayName": "confirmSelectedAlarm", "visible": true, "description": "Confirms the currently selected alarm.", "category": "Alarms", "params": [ { "name": "ctx", "displayName": "ctx", "type": "tchmi:framework#/definitions/ContextReference", "description": "Context Reference.", "bindable": false, "visible": true } ], "type": null, "heritable": true, "waitMode": "Asynchronous", "injectContextObject": true }, { "name": "confirmAllAlarms", "displayName": "confirmAllAlarms", "visible": true, "description": "Confirms all alarms.", "category": "Alarms", "params": [ { "name": "ctx", "displayName": "ctx", "type": "tchmi:framework#/definitions/ContextReference", "description": "Context Reference.", "bindable": false, "visible": true } ], "type": null, "heritable": true, "waitMode": "Asynchronous", "injectContextObject": true } ], "events": [ { "name": ".onSelectedItemChanged", "displayName": ".onSelectedItemChanged", "visible": true, "displayPriority": 5, "category": "Operator", "description": "The selecteditemchanged event is fired when the user changed the selected item.", "heritable": true, "arguments": [ { "type": "tchmi:general#/definitions/Any", "description": "The currently selected row value." } ] }, { "name": ".onItemDoubleClicked", "displayName": ".onItemDoubleClicked", "visible": true, "displayPriority": 5, "category": "Operator", "description": "The itemdoubleclicked event is fired when the user doubleclicks an item.", "heritable": true, "arguments": [ { "type": "tchmi:general#/definitions/Any", "description": "The currently selected row value." } ] } ], "dataTypes": [ { "schema": "Schema/Types.Schema.json" } ], "languages": { "en": "Lang/Language.en.json", "de": "Lang/Language.de.json" }, "access": [ { "name": "configure", "displayName": "Configure", "description": "Controls the ability to configure the sorting, filtering and columns of the grid. This defaults to true.", "visible": true, "defaultValueInternal": true, "dependsOn": [ "operate" ] }, { "name": "viewDetails", "displayName": "View Details", "description": "Controls the ability to view the details of an event. This defaults to true.", "visible": true, "defaultValueInternal": true } ] }