Global settings
The global settings of the various TcHmiBa NuGet packages can be overwritten. The entry point is the callback from the TcHmiBaEvents.onOverrideSettings event that is to be created in the CodeBehind.
module TcHmi.BuildingAutomation {
TcHmi.EventProvider.register(TcHmiBaEvents.onOverrideSettings, function (e, data) {
e.destroy();
// Todo
});
}The value is then changed in the ToDo area, as described below for the respective property.
TcHmiBaControls
EventList
MaximumEventTypePulse
Defines for each user level whether a pulse is displayed if an active event with this or a higher priority is pending.
Controls.Management.EventList.MaximumEventTypePulse.set(BA.Role.eGuest, BA.EventType.eDisturb);
Controls.Management.EventList.MaximumEventTypePulse.set(BA.Role.eBasic, BA.EventType.eDisturb);
Controls.Management.EventList.MaximumEventTypePulse.set(BA.Role.eAdvanced, BA.EventType.eDisturb);
Controls.Management.EventList.MaximumEventTypePulse.set(BA.Role.eExpert, BA.EventType.eDisturb);
Controls.Management.EventList.MaximumEventTypePulse.set(BA.Role.eInternal, BA.EventType.eDisturb);
ProjectNavigationTextual
DefaultContentViewDialogWidth
Defines the default size of the dialog that displays the content of a BaObject.
Controls.Management.ProjectNavigationTextual.DefaultContentViewDialogWidth = 1000;
RoomControl
DefaultBaObjectListDialogWidth
Defines the default size of the dialog that displays the BaObject list.
Controls.RoomAutomation.RoomControl.DefaultBaObjectListDialogWidth = 1000;
Light
Defines whether the quick settings are displayed for Light.
Controls.RoomAutomation.Light.ShowQuickLinks = false;
PriorityIcons
Defines the icons that are displayed on the Light control for a certain priority.
If no icon is defined for a priority, no icon is displayed.
Controls.RoomAutomation.Light.PriorityIcons = new Map<number, Icons.IIconAttributes>([
[Controls.RoomAutomation.Light.Priority.fire, Icons.convertIIconDataToIIconAttributes({ ...Icons.Building.FireAlarm, color: Color.RGBAColor.Red })],
[Controls.RoomAutomation.Light.Priority.communicationError, Icons.convertIIconDataToIIconAttributes({ ...Icons.Events.Flag.Fault, color: Color.RGBAColor.Red })],
[Controls.RoomAutomation.Light.Priority.burglary, Icons.convertIIconDataToIIconAttributes({ ...Icons.Building.BurglarAlarm, color: Color.RGBAColor.Red })],
[Controls.RoomAutomation.Light.Priority.maintenance, Icons.convertIIconDataToIIconAttributes({ ...Icons.Building.Maintenance, color: Color.RGBAColor.DarkOrange })],
[Controls.RoomAutomation.Light.Priority.cleaning, Icons.convertIIconDataToIIconAttributes({ ...Icons.Building.Cleaning, color: Color.RGBAColor.Yellow })],
[Controls.RoomAutomation.Light.Priority.nightWatch, Icons.convertIIconDataToIIconAttributes({ ...Icons.Building.NightWatch, color: Color.RGBAColor.Blue })],
[Controls.RoomAutomation.Light.Priority.manual, Icons.convertIIconDataToIIconAttributes({ ...Icons.RoomAutomation.Manual, color: Color.RGBAColor.DarkOrange })],
[Controls.RoomAutomation.Light.Priority.automaticLight, Icons.convertIIconDataToIIconAttributes({ ...Icons.RoomAutomation.Automatic, color: Color.RGBAColor.TcHmiGreen })]
]);
Sunblind
PriorityIcons
Defines the icons that are displayed on the Sunblind control for a certain priority.
If no icon is defined for a priority, no icon is displayed.
Controls.RoomAutomation.Sunblind.PriorityIcons = new Map<number, Icons.IIconAttributes>([
[Controls.RoomAutomation.Sunblind.Priority.fire, Icons.convertIIconDataToIIconAttributes({ ...Icons.Building.FireAlarm, color: Color.RGBAColor.Red })],
[Controls.RoomAutomation.Sunblind.Priority.storm, Icons.convertIIconDataToIIconAttributes({ ...Icons.Building.StormAlarm, color: Color.RGBAColor.Blue })],
[Controls.RoomAutomation.Sunblind.Priority.ice, Icons.convertIIconDataToIIconAttributes({ ...Icons.Building.IceAlarm, color: Color.RGBAColor.Blue })],
[Controls.RoomAutomation.Sunblind.Priority.commError, Icons.convertIIconDataToIIconAttributes({ ...Icons.Events.Flag.Fault, color: Color.RGBAColor.Red })],
[Controls.RoomAutomation.Sunblind.Priority.burglary, Icons.convertIIconDataToIIconAttributes({ ...Icons.Building.BurglarAlarm, color: Color.RGBAColor.Red })],
[Controls.RoomAutomation.Sunblind.Priority.maintenance, Icons.convertIIconDataToIIconAttributes({ ...Icons.Building.Maintenance, color: Color.RGBAColor.DarkOrange })],
[Controls.RoomAutomation.Sunblind.Priority.manualActuator, Icons.convertIIconDataToIIconAttributes({ ...Icons.RoomAutomation.Manual, color: Color.RGBAColor.DarkOrange })],
[Controls.RoomAutomation.Sunblind.Priority.manualGroup, Icons.convertIIconDataToIIconAttributes({ ...Icons.RoomAutomation.Manual, color: Color.RGBAColor.DarkOrange })],
[Controls.RoomAutomation.Sunblind.Priority.facadeThermoAutomatic, Icons.convertIIconDataToIIconAttributes({ ...Icons.RoomAutomation.Automatic, color: Color.RGBAColor.TcHmiGreen })],
[Controls.RoomAutomation.Sunblind.Priority.facadeTwilightAutomatic, Icons.convertIIconDataToIIconAttributes({ ...Icons.RoomAutomation.Automatic, color: Color.RGBAColor.TcHmiGreen })],
[Controls.RoomAutomation.Sunblind.Priority.sunProtection, Icons.convertIIconDataToIIconAttributes({ ...Icons.RoomAutomation.Automatic, color: Color.RGBAColor.TcHmiGreen })]
]);
Window
ShowQuickLinks
Defines whether the quick settings are displayed for Window.
Controls.RoomAutomation.Window.ShowQuickLinks = false;
TcHmiBaFramework
Button
DoublePressDuration
Defines the time that may elapse between two clicks until the two clicks are recognized as a double click.
Components.Button.DoublePressDuration = 200;
Calendar
DefaultEventDialogSize
Defines the default size of the event dialog.
Components.Calendar.DefaultEventDialogSize = {
width: 700,
height: 350
};CalendarList
DefaultCalendarListDialogSize
Defines the default size of the CalendarList dialog.
Components.CalendarList.DefaultCalendarListDialogSize = {
width: 750,
height: 400
};DateTimePicker
DefaultDateTimePickerDialogSize
Defines the default size of the DateTimePicker dialog.
Components.DateTimePicker.DefaultDateTimePickerDialogSize = {
width: 650,
height: 450
};DefaultDatePickerDialogSize
Defines the default size of the DatePicker dialog.
Components.DateTimePicker.DefaultDatePickerDialogSize = {
width: 300,
height: 300
};TimePicker
DefaultTimePickerDialogSize
Defines the default size of the TimePicker dialog.
Components.TimePicker.DefaultTimePickerDialogSize = {
width: 350,
height: 200
};ProjectNavigationList
MaximumEventTypePulse
Defines for each user level whether a pulse is displayed if an active event with this or a higher priority is pending.
Navigation.ProjectNavigationList.MaximumEventTypePulse.set(BA.Role.eGuest, BA.EventType.eDisturb);
Navigation.ProjectNavigationList.MaximumEventTypePulse.set(BA.Role.eBasic, BA.EventType.eDisturb);
Navigation.ProjectNavigationList.MaximumEventTypePulse.set(BA.Role.eAdvanced, BA.EventType.eDisturb);
Navigation.ProjectNavigationList.MaximumEventTypePulse.set(BA.Role.eExpert, BA.EventType.eDisturb);
Navigation.ProjectNavigationList.MaximumEventTypePulse.set(BA.Role.eInternal, BA.EventType.eDisturb);
MaximumEventConditionDisplayed
Defines the maximum EventCondition for each user level, which is displayed in the lines of the ProjectNavigation.
Navigation.ProjectNavigationList.MaximumEventConditionDisplayed.set(BA.Role.eGuest, BA.EventCondition.eTypeOther);
Navigation.ProjectNavigationList.MaximumEventConditionDisplayed.set(BA.Role.eBasic, BA.EventCondition.eTypeOther);
Navigation.ProjectNavigationList.MaximumEventConditionDisplayed.set(BA.Role.eAdvanced, BA.EventCondition.eEventIconDisplayed);
Navigation.ProjectNavigationList.MaximumEventConditionDisplayed.set(BA.Role.eExpert, BA.EventCondition.eEventIconDisplayed);
Navigation.ProjectNavigationList.MaximumEventConditionDisplayed.set(BA.Role.eInternal, BA.EventCondition.eEventIconDisplayed);
UiIcon
AutoActivateHasEvent
Defines whether the HasEvent attribute is set automatically when events are configured. With this setting, the icon is colored in the defined event color when an event is active.
Components.UiIcon.AutoActivateHasEvent = false;
EnableEventCountBadge
Defines whether the number of events of the same event type are displayed.
Components.UiIcon.EnableEventCountBadge = true;
MaximumEventTypePulse
Defines for each user level whether a pulse is displayed if an active event with this or a higher priority is pending.
Components.UiIcon.MaximumEventTypePulse.set(BA.Role.eGuest, BA.EventType.eDisturb);
Components.UiIcon.MaximumEventTypePulse.set(BA.Role.eBasic, BA.EventType.eDisturb);
Components.UiIcon.MaximumEventTypePulse.set(BA.Role.eAdvanced, BA.EventType.eDisturb);
Components.UiIcon.MaximumEventTypePulse.set(BA.Role.eExpert, BA.EventType.eDisturb);
Components.UiIcon.MaximumEventTypePulse.set(BA.Role.eInternal, BA.EventType.eDisturb);
MaximumEventConditionDisplayed
Defines the maximum EventCondition for each user level, which is displayed at UiIcon.
Components.UiIcon.MaximumEventConditionDisplayed.set(BA.Role.eGuest, BA.EventCondition.eTypeOther);
Components.UiIcon.MaximumEventConditionDisplayed.set(BA.Role.eBasic, BA.EventCondition.eTypeOther);
Components.UiIcon.MaximumEventConditionDisplayed.set(BA.Role.eAdvanced, BA.EventCondition.eEventIconDisplayed);
Components.UiIcon.MaximumEventConditionDisplayed.set(BA.Role.eExpert, BA.EventCondition.eEventIconDisplayed);
Components.UiIcon.MaximumEventConditionDisplayed.set(BA.Role.eInternal, BA.EventCondition.eEventIconDisplayed);
Charting
Axis
DefaultAxisOptionsDialogSize
Defines the default size of the dialog for the axis options.
Charting.Axis.DefaultAxisOptionsDialogSize = {
height: 180,
width: 350
};CollectionConfigurator
DefaultConfiguratorDialogWidth
Defines the default width of the trend collection configurator dialog.
Charting.Trend.CollectionConfigurator.DefaultConfiguratorDialogWidth = 1000;
DefaultTrendCollectionSelectionDialogWidth
Defines the default width of the dialog for the selection of trend collections to be displayed.
Charting.Trend.CollectionConfigurator.DefaultTrendCollectionSelectionDialogWidth = 400;
Storage
UserData
LastContentSorageLocation
Defines the location where a user's last opened content is saved.
Storage.UserData.LastContentStorageLocation = Storage.Location.baSite;
LastThemeSorageLocation
Defines the location where a user's last used theme is saved.
Storage.UserData.LastThemeStorageLocation = Storage.Location.baSite;
TrendSettingsStorageLocation
Defines the location where a user's trend settings are saved.
Storage.UserData.TrendSettingsStorageLocation = Storage.Location.baSite;
TrendCollectionStorageLocation
Defines the location where a user's trend collections are saved.
Storage.UserData.TrendCollectionStorageLocation = Storage.Location.baSite;
TrendCollectionSelectionStorageLocation
Defines the location where a user's displayed trend collections are saved.
Storage.UserData.TrendCollectionSelectionStorageLocation = Storage.Location.baSite;
Server
BaSite
DefaultDiagnosticsDialogSize
Defines the default size of the diagnostics dialog.
Server.BaSite.DefaultDiagnosticsDialogSize = {
height: 500,
width: 500
};EventHelper
MaximumEventCondition
Defines the maximum EventCondition for each user level, that is displayed in the HMI .
Default setting displays all events, flags, priorities and locks.
BA.EventHelper.MaximumEventCondition.set(BA.Role.eGuest, BA.EventCondition.eEventIconDisplayed);
BA.EventHelper.MaximumEventCondition.set(BA.Role.eBasic, BA.EventCondition.eEventIconDisplayed);
BA.EventHelper.MaximumEventCondition.set(BA.Role.eAdvanced, BA.EventCondition.eEventIconDisplayed);
BA.EventHelper.MaximumEventCondition.set(BA.Role.eExpert, BA.EventCondition.eEventIconDisplayed);
BA.EventHelper.MaximumEventCondition.set(BA.Role.eInternal, BA.EventCondition.eEventIconDisplayed);
BaDevice
DialogConnectionAutoCloseStateChanged
Defines whether the notification is automatically closed when a device loses the connection after the connection is restored.
BA.BaDevice.DialogConnectionAutoCloseStateChanged = true;
DialogConnectionAutoReloadOnReconnect
Defines whether the HMI is automatically reloaded after the connection to a device is restored.
BA.BaDevice.DialogConnectionAutoReloadOnReconnect = true;
DialogConnectionAutoReloadOnReconnectTime
Defines the delay time until the HMI is automatically reloaded after the connection to a device is restored.
BA.BaDevice.DialogConnectionAutoReloadOnReconnectTime = 30;
BaBasicObject
DisableParameterDialogHeaderIcon
Defines whether the object/node icon is not displayed in the header of the parameter dialog.
BA.BaBasicObject.DisableParameterDialogHeaderIcon = false;
DefaultParameterDialogWidth
Defines the default width of the parameter window.
BA.BaBasicObject.DefaultParameterDialogWidth = 800;
DefaultOnlineTrendDialogSize
Defines the standard size of the window of the online trend.
BA.BaBasicObject.DefaultOnlineTrendDialogSize = {
height: 250,
width: 450
}DefaultNavigationDialogWidth
Defines the default width of the dialog that displays the ProjectNavgiationList of a BaObject.
BA.BaBasicObject.DefaultNavigationDialogWidth= 1000;
BaView
DisableNodeTypeIcons
DisableNodeTypeIcons
Defines whether the NodeTypeIcons are used in the HMI.
BA.BaView.DisableNodeTypeIcons = true;