Object 'Visualization Manager' - 'Settings'

 

Symbol: _visu_icon_manager.png

The Visualization Manager is responsible for the configuration settings for all display variants of the visualizations of the current application.

The object is inserted below the application when a visualization object is inserted. By double-clicking it, you open a configuration dialog with several tabs. By default, the Settings dialog opens first.

If the device in use supports display variants of the visualization, then the visualization manager provides respective objects automatically (CODESYS WebVisu, CODESYS TargetVisu).

See also

Tab 'Visualization Manager' - 'Settings'

 

Symbol: _visu_icon.png

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

'General settings'

 

Use unicode strings

_cds_icon_option_activated.png: The visualization encodes character strings in Unicode.

Use CurrentVisu variable

_cds_icon_option_activated.png: The application recognizes and uses the global variable VisuElems.CurrentVisu of type STRING. This contains the name of the active visualization when the application is in runtime mode.

In the application code, the variable can be read forgetting 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

  • Assigning a variable: VisuElems.CurrentVisu := strVisuName;

  • Assigning a visualization name: VisuElems.CurrentVisu := 'visu1';

Preview: Support client animations and overlay of native elements

_cds_icon_option_activated.png: Visualization elements can be animated by the client. At the moment, this is possibly by a WebVisu browser only. 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 CODESYS elements. This is not possible with CODESYS versions before 3.5.14.0.

Note: This is a preliminary function. The following limitations currently apply:

  • This functionality is currently not possible with the target visualization.

  • This functionality does not currently support online mode.

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

  • The following visualization elements are not supported:

    • Time range picker

    • Path3D

    • CAMEditor

    • Text editor

  • The input variant "Use text input with limits" is not possible.

  • If visualizations which are referenced in a frame are larger than the frame element, then they are cropped. You can avoid this problem by resizing the frame element accordingly.

  • In the case of the polygon visualization element, dynamic points are not supported.

  • Dynamically changing the line width at runtime is not supported.

See also

'Style settings'

 

Note

The Visualization Style Editor allows you to create, test and install new styles to 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 drop-down list.

_cds_icon_drop_down_list.png 

Opens a drop-down list with styles that are installed in the visualization style repository.

Display all versions (for experts only)

_cds_icon_option_deactivated.png: The drop-down list 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.

_cds_icon_option_activated.png: The drop-down list includes all versions of all installed styles.

Button: _visu_icon_activate_style_editor_cmds.png

Opens a drop-down list 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 a new visualization style dialog. The dialog includes 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 Open existing style as copy dialog opens (Visualization Style Editor). The dialog includes 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.

See also

'Language settings'

 

Selected language

Language used by the display variant when starting a visualization

'Additional settings'

 

Activate multitouch handling

_cds_icon_option_activated.png: At runtime, the visualization expects user input by means of gesture recognition and touch events.

Elements concerned

  • Elements with input configuration

  • Element of type Frame

  • Element of type Tab control

Activate semi-transparent drawing

_cds_icon_option_activated.png: The visualization draws 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.

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

Activate standard keyboard handling

  • Tab

  • Shift+Tab

  • Enter

  • Up arrow

  • Down arrow

  • Right arrow

  • Left arrow

See also

'Advanced'

 

Memory settings

Size of Memory for Visu

Memory size (in bytes) allocated by the visualization at runtime. Default: 400000

Size of Memory for Visu (initial value)

This is the initialization value for visualization profile V3.5 SP10 and later. If the memory usage exceeds this value, then the memory is doubled dynamically.

Size of Paintbuffer (per Client)

Memory size (in bytes) allocated by the visualization per display variant and used for drawing actions. Default: 50000

Size of Paintbuffer (per Client, initial value)

This is the initialization value for visualization profile V3.5 SP10 and later. If the memory usage exceeds this value, then the memory is doubled dynamically.

File transfer mode

Transfer visualization files to the PLC

_cds_icon_radiobutton_activated.png: When downloading the application from the visualization directories to the PLC, CODESYS copies files, such as images and text lists, that are referenced by the visualization. A CODESYS TargetVisu needs the files on the PLC, as well as dialogs, that support numerical and keyboard input.

Use local visualization files

_cds_icon_radiobutton_activated.png: The visualization uses images and text lists in local directories.

Note: In order for the visualization to access local files, the file paths must be relative. You can specify these paths in Project ‣ Project Settings (Visualization category). The settings the Options dialog of Visualization are also considered.

Note: It is also necessary for the link type to be set to Link to File for an image. The link type is specified in the image pool.

See also

Note

With "Display variant", the type of visualization is identified, either WebVisu, TargetVisu, or HMI. A display variant is a connected display medium. In this way, multiple browsers (clients) can be connected at the same time for the display variant WebVisu.

Client settings

Maximum number of visualization clients

Restricts the number of display variants that are executed at the same time.

If you configure elements to vary depending on the display variant, then you must limit the number of display variants. A visualization receives an ID at runtime that identifies the display variant and processes data accordingly. CODESYS can interrogate the ID with the system variable CURRENTCLIENTID for information about which of the running variants is affected.

Example: arr[CURRENTCLIENTID].dwColor

Requirement: The library VisuGlobalClientManager is included in the project.

Hint: In CODESYS Store, you will find the sample project "Global Client Manager".

Transfer both svg images and converted images

The option is visible only if both a WebVisu and TargetVisu are used. This affects image in SVG format only.

The option is available if the device description of the controller of the TargetVisu does not support the format "SVG (full)".

_cds_icon_option_activated.png: The images are transferred in PNG or BMP format (for TargetVisu) and also in SVG format (for WebVisu).

Note

Not all settings are available for an integrated CODESYS visual­ization.