Skip to main content

Tab: Settings

Function: The tab includes settings for all visualizations throughout the application.

Symbol: _visu_icon.png

Note

Not all settings are available for an integrated CODESYS visualization.

Group: General Settings

Use unicode strings

standard icon: The visualization encodes strings in Unicode.

Use CurrentVisu variable

standard icon: The application recognizes and uses the global variable VisuElems.CurrentVisu of type STRING.

It contains the name of the active visualization at application runtime.

In the application code, the variable can be read in order to retain the name of the active visualization. The variable can be written to for calling a switch of visualizations. The switch is done at the same time on all display devices.

Example: A TargetVisu display variant and several WebVisu display variants are active. When the CurrentVisu variable is written to, all display variants switch to this visualization.

Requirement: The application includes a visualization that calls other visualizations.

Example:

  • Assignment of variable: VisuElems.CurrentVisu := strVisuName;

  • Assignment of visualization name: VisuElems.CurrentVisu := 'visu1';

Support client animations and overlay of native elements

standard icon: Visualization elements can be animated by the client.

This function is possible only for browsers of a CODESYS WebVisu and in a CODESYS TargetVisu. However, CODESYS TargetVisu has to support this function. Then, additional properties are visible in the visualization elements.

Moreover, native elements, which are integrated in the visualization (for example, a web browser), can be overlaid with native CODESYS elements. This is not possible with CODESYS versions before 3.5.16.0.

Note

The following restriction applies currently:

In the case of nested frames combined with a scaling, elements can be positioned in a slightly different manner.

Group: Style Settings

Tip

You can use the Visualization Style Editor to create new styles, review them, and install them in the visualization style repository.

Selected style

  • Style from the Visualization Style Repository that every visualization of the application uses

    Example: Flat Style

  • <None>: The visualization displays its elements without a defined style or according to internal defaults. In the Color and Font element properties, a default dialog opens for selection instead of a list box.

_cds_icon_drop_down_list.png

Opens a list box with styles that are installed in the Visualization Style Repository

Display all versions (for experts only)

_cds_icon_option_deactivated.png: The list box includes only the latest version of the selected style and all other styles. If a newer version is installed for the selected style, then it is also listed.

standard icon: The list box contains all versions of all installed styles.

Button: _visu_icon_activate_style_editor_cmds.png

Opens list box with commands for using the Visualization Style Editor

Open Style Editor

The Visualization Style Editor opens.

Create and Edit Derived Style

The Visualization Style Editor opens with the Create New Visualization Style dialog. The dialog contains the settings for the first configuration step.

Requirement: In Selected style, a base style is selected.

Note

A derived style makes sense for adapting or extending only a few style properties.

Copy and Edit Style

The Visualization Style Editor opens with the Open Existing Style as Copy dialog. The dialog contains the settings for the first configuration step.

Requirement: A style is selected in Selected style.

Preview

The displayed elements represent the style that is specified in Selected style.

Group: Language Settings

Selected language

Language used by the display variant when starting a visualization

Group: Additional Settings

Multitouch handling

This property defines what handles the touch events. This is done either by the visualization or, in the case of the WebVisu, by the browser. With this setting, touch gestures can be performed on various visualization elements.

standard icon: The visualization processes user input via gestures, touch, and mouse events. The WebVisu does not forward these events to the browser (no scrolling possible). The forwarding of events affects only the WebVisu, not the TargetVisu.

_cds_icon_option_deactivated.png: The visualization does not process input events explicitly. Mouse, touch, and gesture events work as usual in the browser.

Affected elements

  • Elements with input configuration

  • Element type Frame

  • Element type Tabs

  • Table, Alarm Table, Combo Box, Integer, Combo Box, Array with the Fixed and scrollable property

    These scroll elements can be scrolled either with a gesture (touch event) or with a scroll bar (mouse event). The scroll bar has to be configured explicitly. Therefore, select the Scroll elements with scrollbar property if an element should be equipped with a scrollbar.

Scroll elements with scrollbar

standard icon: The scroll elements are displayed with a scroll bar. The contents excerpt can be scrolled with the mouse only this way.

_cds_icon_option_deactivated.png: Scrolling by panning is enabled.

The visualization elements Table, Alarm Table, Combo Box, Integer, Combo Box, Array, and Frame with the Fixed and scrollable property are affected by this option.

Semi-transparent drawing

standard icon: The visualization paints the elements in a semitransparent color.

When defining a color, you can also specify the gradient value for transparency. This value is defined in the Transparency property.

The leading byte is evaluated in color variables.

Default: enabled.

Requirement: You have created a new visualization and the display variants can paint with semitransparency.

Standard keyboard handling

The following user input is provided by default:

  • Tab

    Tip

    Configure its behavior in Tab order in the Element list.

  • Shift + Tab

  • Enter

  • Arrow Up

  • Arrow Down

  • Arrow Right

  • Arrow Left

Paint disabled elements grayed out

standard icon: All disabled elements are grayed out without you having configured their element properties, such as color variables.

The following results in the disabling of an element:

  • The variable which has been assigned to the State variables, Deactivate inputs element property is set to TRUE.

  • The visualization user management prohibits the user from making entries. The user has Only visible permission.

Call after visu initialization

Function name. The function is called after initialization. That is the right time to register an additional event handler for the EventManager.

Example: VisuInit

Implementation of VisuInit:

// This function is called after visu initialization (see Visualization Manager 'Call after visu initialization')
FUNCTION VisuInit : BOOL
VAR_INPUT
END_VAR
// Set the mouse event handler
VisuElems.VisuElemBase.g_VisuEventManager.SetMouseEventHandler(PLC_PRG.evHandler);

Another user case is the registration of the ClientManagerListener for the ClientManager.

Responsive visualization size

standard icon The size of the visualization is refreshed when the client size is changed. The elements in the top-level visualization can be positioned dynamically. The requirement is isotropic or anisotropic scaling.

The client size can be queried with the Container.Width and Container.Height variables.

Container.Size is the client size for all top-level visualizations. In order for a visualization with repositioned elements to scale correctly again, Visu.Size has to be recalculated.

Example:

Container.Width - Visu.Width
Container.Width - Visu.Width - 50