Home
Business Logic / Control
Endless possibilities in data processing for your projects.
Control graphics
BarChart3D EWO
"backgroundEnabled"
Defines if the color specified with "backgroundColor" is displayed or not.

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.
Data Management
Classify, structure and archive your data.
Business Logic / Control
Endless possibilities in data processing for your projects.
- Introduction to CTRL
  An introduction to the product's own programming language Control(CTRL).
- Control Classes
  The overview of classes available in Control.
- Types of Control Functions
  An overview of the types of functions distinguished within Control.
- Control graphics
  - Graphics objects
  - Attributes of graphics objects
  - Arc
  - AttentionEffect EWO functions
  - Bar trend
  - BarChart3D EWO
    - "acceptDrops"
      Specifies whether drop events are enabled for this object.
    - "addSeriesRow"
      The attribute "addSeriesRow" adds a new row with the specified values to the given series.
    - "ambientLightStrength"
      The attribute "ambientLightStrength" defines the ambient light strength for the graph.
    - "backgroundColor"
      Defines the background color of the BarChart3D EWOs
    - "backgroundEnabled"
      Defines if the color specified with "backgroundColor" is displayed or not.
    - "barSelectionMode"
      Defines the selection mode for the BarChart3D EWO.
    - "barShadowQuality"
      This attribute defines the quality of bar shadows.
    - "barSpacing"
      This attribute defines the empty space between bars on the X and Z axis.
    - "barThickness"
      This attribute defines the bar thickness ratio between X and Z dimensions.
    - "baseColor"
      This attribute defines the color of the first series when colorStyle is "ColorStyleUniform".
    - "baseGradient"
    - "clearSelection"
      Removes the marking of all items in a graphical object.
    - "colorStyle"
      Defines the color style of the graph.
    - "columnLabels"
      Allows to specify the text for the column labels.
    - "columnTitle"
      Allows to specify the column title.
    - "focus"
      The attribute "focus"; returns TRUEif the object has the focus.
    - "getSelectedBar"
      Returns series index, row index and column index for the currently selected bar.
    - "getSeriesBarValue"
      Returns the value of the given bar.
    - "getSeriesColumnCount"
      Returns the number of columns for the given row of a series.
    - "getSeriesCount"
      Returns the number of series of the EWO.
    - "getSeriesRow"
      Returns the values for the row of the given series.
    - "getSeriesRowCount"
      Returns the number of rows for the given series.
    - "gridColor"
      Sets or gets the grid color of a table or trend grid at runtime.
    - "gridEnabled"
      This property defines if the grid lines for the BarChart3D EWO are enabled.
    - "highlightLightStrength"
      This attribute defines the specular light strength for highlighted objects.
    - "isActiveWindow"
      The attribute "isActiveWindow"; returns TRUE if this widget is the active window, otherwise FALSE.
    - "isSeriesVisible"
      Checks whether the given series is currently visible or not.
    - "labelBackgroundColor"
      This attribute defines the background color for labels.
    - "labelBackgroundEnabled"
      This attribute defines if the background of labels is displayed.
    - "lightColor"
      This attribute defines the color for the specular light.
    - "lightStrength"
      This attribute defines the specular light strength for the whole graph.
    - "multiHighlightColor"
      This attribute defines the color for highlighted bars when colorStyle is ColorStyleUniform.
    - "multiHighlightGradient"
      This attribute defines the color for highlighted bars when colorStyle is not "ColorStyleUniform".
    - "primarySubViewport"
      Allows to define the position and size of the primary sub viewport.
    - "removeSeriesRow"
      Deletes the specified row of the given series.
    - "rowLabels"
      Defines the text for the row labels (Z axis).
    - "rowTitle"
      Defines the row title (z axis).
    - "secondarySubViewport"
      Allows to define the position and size of the secondary sub viewport.
    - "selectBar"
      Selects the given bar.
    - "setSeriesBarLabelFormat"
      Defines the label format for the selected bars of the given series.
    - "setSeriesBarValue"
      Allows to change the value of a specific bar.
    - "setSeriesBaseColor"
      Sets the bar color for the given series.
    - "setSeriesBaseGradient"
      Defines the gradient for the bars of the given series.
    - "setSeriesColorStyle"
      Defines the color style for the given series.
    - "setSeriesMeshType"
      Defines the shape of the bars.
    - "setSeriesMultiHighlightColor"
      Defines the bar color if several bars of the given series are selected.
    - "setSeriesMultiHighlightGradient"
      Defines the gradient color if several bars of the given series are selected.
    - "setSeriesName"
      Assigns a name to the given series.
    - "setSeriesRotationAngle"
      Rotates the bar of the given series on its own axis.
    - "setSeriesRow"
      Sets or replaces the values for one specific row of the given series.
    - "setSeriesSingleHighlightColor"
      Defines the bar color if the bar of the given series is selected in selection mode single.
    - "setSeriesSingleHighlightGradient"
      Defines the gradient color if the bar of the given series is selected in selection mode single.
    - "setSeriesVisible"
      Defines whether the given series is visible or invisible.
    - "singleHighlightColor"
      This attribute defines the color for the selected bar when colorStyle is "ColorStyleUniform".
    - "singleHighlightGradient"
    - "slicingActive"
      Defines if the 2D slice mode is enabled.
    - "tooltipDuration"
      Specifies how long a tooltip is shown.
    - "updatesEnabled"
      This attribute specifies whether updates of a widget (for example, a textEdit, slider, progress bar, zoom navigator, LCD number or thumb wheel) have been enabled.
    - "valueAxisSegmentCount"
      Defines how many segments (grid lines with labels) are drawn on the Y axis.
    - "valueAxisSubSegmentCount"
      Defines how many sub segments are drawn on the Y axis.
    - "valueLabelFormat"
      Defines the format which is used for the labels on the Y axis.
    - "valueLabels"
      Returns the value labels displayed on the Y axis.
    - "valueTitle"
      Defines the title for the Y axis.
    - "x", "y"
      The attributes x and y return the coordinate of an object (e.g. a textEdit, a progress bar, a slider, a zoom navigator, an LCD number or a thumb wheel). x returns the X coordinate of an object. y returns the Y coordinate of an object.
    - "xRotation"
      Defines the X-rotation angle of the camera around the target point in degrees.
    - "yRotation"
      Defines the Y-rotation angle of the camera around the target point in degrees.
    - "zoomLevel"
      Defines the camera zoom level.
  - Button
  - Calendar
  - Cascade
  - Chart.ewo
  - Checkbox
  - Clock
  - Combobox
  - DateTimeEdit EWO functions
  - DialGauge EWO
  - DoubleSpinbox EWO
  - DpTreeView
  - DpTypeView
  - Embedded module
  - Frame
  - GIS Viewer EWO
    WinCC OA GIS Viewer provides the cartographic representation of objects in WinCC OA. This new feature provides numerous advantages, particularly in geographical distributed systems, like in Water, Traffic, Oil & Gas or Energy.
  - Label Functions
  - Layoutgroup functions
  - LCD number
  - Maps Widget - Properties and Functions
  - Panel functions
  - PDF Viewer EWO
  - PictureFlow EWO functions
  - Pipe
  - Polyline
  - Primitive text
  - Progress bar
  - Radio box
  - Rectangle
  - Reference Functions
  - Scheduler.ewo
  - Selection list
  - Slider
  - Spin button
  - Splitter
  - Tab
  - Table
    The available functions of the Table object.
  - TextEdit
  - Text field
  - Thumb wheel
  - ToggleSwitch EWO
  - Tree widget
  - Trend Functions
  - VideoPlayer.ewo
  - WebView EWO
    All events and functions, specifically available for the WebView EWO.
  - Zoom Navigator
    Functions available for the Zoom Navigator widget.
- CONTROL Functions
- CtrlExtension
  The CtrlExtension allows the addition of custom C++ code.
- CTRL Debugger
  You can use the CTRL debugger to debug the Control programming language. The debugger can be used via its own panel, which also enables the monitoring and setting of variable values during the execution of a script.
- SQL in CONTROL
  The database functions enable you to quickly carry out value queries on data points and elements.
- WinCC OA JavaScript Manager for Node.js
  The WinCC OA JavaScript Manager for Node.js is a manager that allows for the integration of the TypeScript/JavaScript runtime environment Node.js® into WinCC OA.
- API Manager
  The WinCC OA API (Application Programming Interface) offers a number of functions adding special Managers to this process control system.
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.
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.

"backgroundEnabled"

Defines if the color specified with "backgroundColor" is displayed or not.

Synopsis

shape.backgroundEnabled(bool enabled);

Parameter


Parameter	Description
shape	Name of the object
enabled	TRUE: Background color is displayed FALSE: Background color is not displayed

Description

Defines if the color specified with "backgroundColor" is displayed or not.

Assignment

BarChart3D EWO