Home
Engineering
Powerful tools for easy or complex engineering tasks.
Graphics Editor (GEDI)
Used for creating and editing panels, provides tools for creating and configuring graphic objects.
Complex graphics objects
EWO Basics and Development
Maps Widget (EWO)
Maps Widget
This section provides the reference documentation for all properties, functions, and events available for the Maps Widget.
"mapThemeId"
Allows you to select one of the predefined map themes to be shown.

Version Information
Release Notes, Update information, Certifications and Frequently Asked Questions.
Concepts
Your first step into modern and powerful process visualization.
Deployment
Topics you need to know before using WinCC OA.
Security
Go beyond the norm in cybersecurity.
Engineering
Powerful tools for easy or complex engineering tasks.
- Project Administration
  The chapter contains a description of the process monitor as well as the project administration.
- Graphics Editor (GEDI)
  Used for creating and editing panels, provides tools for creating and configuring graphic objects.
  - GEDI, basics
  - The catalog window
  - The Script Editor
  - The Property Sheet
  - Creating graphics objects
  - Simple graphics objects
  - Complex graphics objects
    - Selection list
    - Bar trend
    - Combo box
      Combo boxes allow you to choose only one option from a list of pre-defined alternatives. Since only the selected option is displayed once the selection has been made, a combo box does not take up much space in a system diagram.
    - Check box
      Check boxes are lists containing small, square buttons to the left of the options, one or more of which can be selected ("checked") simultaneously. Check boxes differ in appearance from radio boxes that have a round shape.
    - DpTreeView
    - DpTypeView
    - Embedded module
    - EWO Basics and Development
      - WinCC OA EWOs
      - WebView.ewo
      - Maps Widget (EWO)
        Maps Widget - Configuration
        Maps Widget
        This section provides the reference documentation for all properties, functions, and events available for the Maps Widget.
        Maps Widget - Notes and Restrictions
        License Agreement
        Maps Widget Example - Google Maps Integration
        Maps Widget Example - Web Map Service
        Maps Widget
        This section provides the reference documentation for all properties, functions, and events available for the Maps Widget.
        "animationsEnabled"
        Specifies how a new visible section of the map is displayed.
        "distance"
        Distance of the view point from the globe in meters.
        "latitude"
        Specifies the latitude of the center of the visible map section in degrees.
        "longitude"
        Specifies the longitude of the center of the visible map section in degrees.
        "mapThemeId"
        Allows you to select one of the predefined map themes to be shown.
        "persistentTileCacheLimit"
        Maximum size of the persistent tile cache (tiles stored on disk) in kilobytes.
        "projection"
        The type of projection that is used to display the 3D globe onto the 2D screen.
        "renderPlugins"
        Returns a list of plug-in names that are available in the Maps Widget.
        "showCrosshairs"
        Specifies whether a crosshairs symbol should be displayed for the current position.
        "showGrid"
        Specifies whether a coordinate grid is shown within the map.
        "showNavigation"
        Specifies whether the interactive navigation box is displayed in the lower right corner of the Maps Widget.
        "showOverviewmap"
        Specifies whether an overview map as well as the current position on the map are displayed.
        "showScalebar"
        Specifies whether a scale bar for the map is displayed.
        "volatileTileCacheLimit"
        Maximum size of the volatile tile cache (tiles stored in memory) in kilobytes.
        "workOffline"
        Specifies whether the Maps Widget will try to access online data or only displays data available locally.
        "zoomStep"
        Specifies the factor which is zoomed per step when using the function zoom().
        "addEmptyLayer()"
        This function adds a new empty layer to the Maps EWO.
        "addGeoDataFile()"
        The function adds offline map material into the Maps Widget.
        "addLine()"
        This function adds a new empty line to the Maps EWO.
        "addPlacemark()"
        The function adds a new placemark to the map.
        "addPointToLine()"
        The function adds a point to a line of the Maps EWO.
        "addPolygon()"
        The function adds an empty polygon to the Maps EWO.
        "addSymbol()"
        The function allows to add a custom symbol to the Maps Widget.
        "appendPolygonInnerBoundaries()"
        The function adds a cutout to a polygon of the Maps EWO.
        "centerOn()"
        Changes the map view to stated coordinates.
        "centerOnBox()"
        Changes the map view within the stated region borders.
        "centerOnHome()"
        Changes the map view to the defined home coordinate.
        "centerOnLine()"
        Changes the map view to the center of the specified line.
        "centerOnPlacemark()"
        Changes the map view to the stated placemark.
        "centerOnPolygon()"
        Changes the map view to the center of the specified polygon.
        "centerOnSymbol()"
        Changes the map view to the stated object.
        "clearLayer()"
        The function removes all polygons, lines and symbols of a specific layer of the Maps EWO.
        "getLayerClickEnabled()"
        The function returns whether the click events for a specific layer of the Maps EWO are enabled.
        "getLayerFromName()"
        The function returns the layer number for a given name of a layer in the Maps EWO.
        "getLayerName()"
        The function returns the name of a specified layer of the Maps EWO.
        "getLayers()"
        The function returns all layers of the Maps EWO.
        "getLineColor()"
        The function gets the color of a line of the Maps EWO.
        "getLinePoints()"
        Returns the points of a specified line of the Maps EWO.
        "getLines()"
        The function returns all lines of the Maps EWO.
        "getLineType()"
        Returns the type of a specified line of the Maps EWO.
        "getLineWidth()"
        The function returns the width of a line of the Maps EWO.
        "getMapCoordinates()"
        Returns the current map coordinates for a specified position on the panel..
        "getPluginData()"
        The function returns the properties of a specific plugin.
        "getPolygonColor()"
        The function gets the colors of a polygon of the Maps EWO.
        "getPolygonFillPattern()"
        Returns the fill pattern for a specified polygon of the Maps EWO.
        "getPolygonInnerBoundaries()"
        Returns the inner boundaries of a specified polygon of the Maps EWO..
        "getPolygonLineType()"
        Returns the line type of the border of a specified polygon of the Maps EWO.
        "getPolygonLineWidth()"
        The function returns the line width of the outline of a polygon.
        "getPolygonOuterBoundaries()"
        Returns the outer boundaries of a specified polygon of the Maps EWO.
        "getPolygons()"
        The function returns a list of all polygons of the Maps EWO.
        "getScreenCoordinates()"
        Returns the current screen position of a location on the map.
        "getVisibleBox()"
        The function gets the current visible maps area.
        "hideLayer()"
        This function hides a layer of the Maps EWO.
        "ignoreSslErrors()"
        Instructs the Maps Widget to ignore specific SSL errors when loading map tiles.
        "isLayerVisible()"
        This function is used to get the visibility of a layer of the Maps EWO.
        "isPositionVisible()"
        Returns if the specified coordinates are shown in the current visible map area.
        "latLonToString()"
        The function converts float coordinates into string coordinates.
        "layerExists()"
        Returns whether the specified layer exists on the Maps EWO.
        "lineExists()"
        Returns whether the specified line exists on the Maps EWO.
        "moveLayerToTop()"
        The function moves a layer of the Maps EWO to the top in the hierarchy.
        "pan()"
        The function moves the map by the given number of steps
        "polygonExists()"
        Returns whether the specified polygon exists on the Maps EWO.
        "removeGeoDataFile()"
        The function removes offline map material from the Maps Widget.
        "removeLayer()"
        This function removes a layer from the Maps EWO.
        "removeLine()"
        The function deletes a line from the Maps EWO.
        "removePlacemark()"
        Removes the stated placemark.
        "removePolygon()"
        The function removes a polygon from the Maps EWO.
        "removeSymbol()"
        Removes the stated object.
        "setHome()"
        Sets the home coordinate within the map.
        "setLayerClickEnabled()"
        Enables or disables the click events for a specific layer of the Maps EWO.
        "setLayerVisibleRange()"
        The function sets the viewing distance, for which the specified layer will be shown.
        "setLineColor()"
        The function changes the color of a line of the Maps EWO.
        "setLineType()"
        Sets the type of a specified line of the Maps EWO.
        "setLineWidth()"
        The function sets the width of a line of the Maps EWO.
        "setPluginData()"
        The function sets the properties of a plugin.
        "setPolygonColor()"
        The function sets the color of a polygon of the Maps EWO.
        "setPolygonFillPattern()"
        Sets the fill pattern for a specified polygon of the Maps EWO.
        "setPolygonLineType()"
        Sets the line type of the border of a specified polygon of the Maps EWO.
        "setPolygonLineWidth()"
        The function sets the line width of the outline of a polygon.
        "setPolygonOuterBoundaries()"
        The function sets the corner coordinates of a polygon of the Maps EWO.
        "showLayer()"
        This function shows a previously hidden layer of the Maps EWO.
        "stringToLatLon()"
        The function converts string coordinates into float coordinates.
        "zoom()"
        The function is used to zoom in or out of the map.
        "clicked"
        The event is triggered whenever the left mouse button is released on the Maps Widget.
        "geoDataFileAdded"
        The event is triggered if a geoDataFile has been loaded using the function addGeoDataFile().
        "lineClicked"
        The event is triggered whenever a line is clicked on the map.
        "polygonClicked"
        The event is triggered whenever a polygon is clicked on the map.
        "visibleBoxChanged"
        The event is triggered as soon as the visible maps area changes.
    - Calendar
    - Cascade
    - Label
    - LCD number
    - Panel reference
    - Progress Bar
    - Radio box
      Radio boxes are lists containing small, circular buttons to the left of the entries (or options), only one of which can be selected at a time.
    - Tab
    - Button
    - Slider
    - Spin button
    - Splitter
    - Table
    - TextEdit
    - Text field
    - Thumb wheel
    - Trend widget
      The Trend widget is an advanced visualization tool designed to provide a comprehensive view of how two or more values change in relation to one another over time. This powerful feature is essential for tracking and monitoring performance metrics, analyzing emerging patterns, and identifying anomalies. By leveraging the Trend widget, users can make informed, data-driven decisions that enhance operational efficiency and strategic planning.
    - Tree widget
    - Clock
    - Zoom Navigator
      With the zoom navigator widget you can zoom a module.
  - Simple Configuration
    Simple configuration windows and panels support you in combining events (such as a mouse click) with different actions such as setting datapoint values, showing panels or changing attributes.
  - ScriptWizard
    Simple wizard for creating graphical user interfaces for users without prior programming knowledge.
  - Version control, basics
  - Style Sheets, basics
  - Standard Symbols (STD_Symbols)
    Symbol library consisting of graphics objects for the quick display and design of system diagrams.
  - Expandability of GEDI
  - Simple Symbols, basics
    The "Simple Symbols" functionality is used to simply assign corresponding symbols to datapoint types and increase the working comfort when working with different symbols.
  - Layout management
    Layouts change the size and position of objects according to parameters previously defined in the GEDI.
  - Object-Oriented Panel References
    Reusable objects built with the GEDI tools. Insert them within an existing panel to provide a graphical element.
  - Input Event Recorder
    The Input Event Recorder (also known as Macro Recorder) captures mouse and keyboard events in runtime panels and generates CTRL scripts for automated playback. Use it to create automated test sequences and repeatable workflows.
  - Encryption
- System Management
  The System Management is the central administrative unit for WinCC OA Systems.
- Wizard Framework
  Used for easy creation of wizards in a uniform layout style. The key elements "Navigation Bar" and "Bottom Bar" can be customized to fit the needs of the custom wizard.
- XML Panel Format
  The XML (Extensible Markup Language) panel format allows creating WinCC OA panels.
- Simple Symbols, basics
  The "Simple Symbols" functionality is used to simply assign corresponding symbols to datapoint types and increase the working comfort when working with different symbols.
- ScriptWizard
  Simple wizard for creating graphical user interfaces for users without prior programming knowledge.
- Panel topology/Group alert facility
  Tree structure for process panels with integrated group alert system
- Object-Oriented Panel References
  Reusable objects built with the GEDI tools. Insert them within an existing panel to provide a graphical element.
- Multilingual Projects
  WinCC OA is designed to provide both Native Language Support and Multi Language Support.
- Translator
  The WinCC OA Translator functionality supports you in creating and maintaining multilingual projects. It offers a convenient interface for translation of reusable terms.
- Layout management
  Layouts change the size and position of objects according to parameters previously defined in the GEDI.
- Generic Dialog Framework
  The Generic Dialog Framework is an easy way to generate your own dialogs by adjusting a set of prefabricated panels.
- Simple Configuration
  Simple configuration windows and panels support you in combining events (such as a mouse click) with different actions such as setting datapoint values, showing panels or changing attributes.
Data Management
Classify, structure and archive your data.
Business Logic / Control
Endless possibilities in data processing for your projects.
Data Visualization
User interfaces, Trends and Reports for every purpose and device.
Southbound Interfaces
The process connection to the actual machines/sensors.
Northbound Interfaces
Your portal to the cloud or supervising systems.
Web Connectivity / Network Interfaces
Data exchange, APIs and web technologies
User Management
All about authorization, authentication and login-customization.
Availability
How to get your system uptime to the maximum.
Reporting
Create state of the art project reports without limits.
Addons
Useful tools and enhancements for special demands.
Reference Tables
Detailed and extensive content for special project adaptation.
Videos & Tutorials
Explore the capabilities of WinCC OA with our carefully selected collection of video tutorials and guides.
eLearning
Build Your Expertise Step by Step
Documentation
Basic information about terms and functions within the documentation.
Support & Services
An experienced team of support agents, consultants and trainers are ready to facilitate active partnerships with our customers, so they can profit from our comprehensive service.
Disclaimer
A brief clarification of liability exclusions or legal notices.
SIMATIC WinCC OA World
Explore the World of WinCC OA and Stay updated with the latest product news

"mapThemeId"

Allows you to select one of the predefined map themes to be shown.

Synopsis

shape.mapThemeId(string themeId);

Parameters


Parameter	Description
themeId	Relative path to the .dgml file of the map theme. Following themes are provided with the Maps Widget and located within the "data/marble/maps/" directory of the version: Earth at Night (earth/citylights/citylights.dgml) Empty Map (used as a base for offline maps) (earth/empty/empty.dgml) OpenStreetMap (earth/openstreetmap/openstreetmap.dgml) OpenTopoMap (earth/opentopomap/opentopomap.dgml) Plain Map (cities, borders, rivers etc.) (earth/plain/plain.dgml) Satellite View (earth/bluemarble/bluemarble.dgml) WMS Example (earth/wmsexample/wmsexample.dgml)

Details

Additional themes can be manually added to the Maps Widget, see Configuration - Map Themes.

The themes must be selected by stating the relative path to either the project directory "data/maps/maps/" or the version directory "data/marble/maps/" to the .dgml file of the map theme.

Note:

Note that additional folders within the version, e.g. "clouds" or "humanitarian" cannot be used as a map theme but are referenced by other map themes.

For downloading the map material it is also necessary to set the property workOffline to false.

Assignment

Maps Widget