Chart settings

Figure 7. Settings Window in Workbench

NOTE: In the Niagara 4.8 Workbench and later, if the chart width is less than 800 pixels several of the chart commands icons are moved into the Settings window above the tabs. When the chart is resized wider than 800 pixels, those icons revert back to the Commands Bar in the chart.

Figure 8. Commands icons in the Settings window

Series tab

Settings Options Description

Settings	Options	Description
`Color`	Color block assigned to each component	Change default data color by clicking color block and selecting different color via Color Picker. As of Niagara 4.12, the Color Picker is also available when you are connected to your station via the browser using the HTML5 browser-based implementation of the WebChart view.
`Chart type`	`Line`, `Discrete line`, `Shade`, `Bar`	`Line` — plots a smooth line with interpolation. The default chart type for Numeric points and histories. `Discrete line` — plots a “stepped” line without interpolation. `Shade` — plots shaded areas, known as “swim lanes,” representing state change. The default chart type for Boolean and Enum points. `Bar` — plots vertical bars. Samples data into common intervals based on available width, When you have more than one component in a chart using bar chart type, they become a Bar Group, where the individual bars are adjacent (no space between). As shown below, clicking on a Bar Group selects the entire group and the values for all components in the group are shown in the Fixed Data Popup. While the mouseover Data Value Popup, shows the value of a single component.

Color

Color block assigned to each component

Change default data color by clicking color block and selecting different color via Color Picker. As of Niagara 4.12, the Color Picker is also available when you are connected to your station via the browser using the HTML5 browser-based implementation of the WebChart view.

Chart type

Line,
Discrete line,
Shade,
Bar

Line — plots a smooth line with interpolation. The default chart type for Numeric points and histories.

Discrete line — plots a “stepped” line without interpolation.

Shade — plots shaded areas, known as “swim lanes,” representing state change. The default chart type for Boolean and Enum points.

Bar — plots vertical bars. Samples data into common intervals based on available width, When you have more than one component in a chart using bar chart type, they become a Bar Group, where the individual bars are adjacent (no space between).

As shown below, clicking on a Bar Group selects the entire group and the values for all components in the group are shown in the Fixed Data Popup. While the mouseover Data Value Popup, shows the value of a single component.

Right-click menu

A right-click menu is available on data series in the Series tab. The right-click menu allows you to hide or show specific data or even completely remove data from a chart.

Figure 9. Right-click menu options

Axis tab

Settings	Options	Description
`Y-Axis Orientation`	`left` `right (default)`	Aligns Y-axis of primary data to either the left or right side of the chart.
`Data Zoom Scope`	`primary` (default) `all`	Sets the Data Zoom Scope to primary or all. `Primary` — zooms to the X-axis of the primary data set only. If the primary data set is numeric, it zooms on the Y-axis. `All` — changes the X-axis to accommodate all available data, including live data as it is recorded.
`Show Grid`	`true` (default) `false`	Turns on/off the chart grid. `true` — the grid displays in chart behind data. `false` — the grid does not display.
`Background Color`	`On` `Off` (default)	Turns on/off the background area color for the current theme. `On` — the background area color displays in chart behind data. `Off` — the background area color does not display.
`Chart Cursor`	`Crosshair (default)` `None`	Sets the appearance of mouse pointer while positioned over a chart. `Crosshair` — the mouse pointer appears as a crosshair. `None` — turns off the mouse pointer visibility (while positioned over a chart), hiding it completely.
`Facets Limit Mode`	`Off (default)` `Inclusive` `Locked`	Configures whether the WebChart uses a point’s facets for `Min` and `Max`. `Off` (default) — the WebChart ignores a point’s facets for `Min` and `Max`. `Inclusive` — the WebChart includes a point’s facets for `Min` and `Max`. `Locked` — forces the WebChart to use a point’s facets for `Min` and `Max`. NOTE: In each of these settings `chartMin` and `chartMax` facet keys can be used as a higher priority substitute to “min” and “max”. Even if the Facet Limit Mode is “Off” it can be overridden for specific series if a facet key of `chartLimitMode` is supplied with the corresponding values of “Inclusive” or “Locked”. NOTE: Previously, if you were not using a chart file to load a WebChart, there was no way to preset any options. In latest version of Niagara, there is a `Default Options` WebProperty on a Px page which you can modify to preset WebChart default options. By default, modifications are saved to `file:^charts/defaultOptions.chart`. Even when not on a px page, non-chart files will load their options from this file if it exists and the user has permissions to view it. This includes the ability to change all options, so even the default time range can be preset.
`Show Start Trend Gaps`	`Yes` (default) `No`	Configures the behavior when drawing the chart line, providing a visual indication (a line gap) of an interruption in data collection. For example, a station restart or that history collection was disabled and re-enabled. `Yes` — if there is a start trend flag on a record the chart does not connect the dot for that record to the previous record, resulting in a gap in the line `No` — allows the dots to be connected, eliminating any such gaps.
`Show Data Gaps`	`Yes` `No` (default)	Configures the behavior when drawing the chart line, it providing a visual indication (a line gap) for records that have either the hidden flag set or invalid values (+inf, -inf, NaN). `Yes` — if a record has a hidden flag set or invalid values (+inf, -inf, NaN) the record’s dots are not connected to adjacent records. `No` — if a record has a hidden flag set or invalid values (+inf, -inf, NaN) the record’s dots are connected to adjacent records.

Layers tab

Settings Options Description

Settings	Options	Description
`Data Popup`	On (default) Displays OffPauses	Enables/disables the Fixed Data popup. `On` — clicking on chart data displays the recorded date and time, as well as the name, value and status for each component in the chart at the point where you click. The persistent data popup remains visible until you close it. `Off` — suspends display of fixed data popup.
`Data Mouseover`	On (default) Off	Enables/disables the mouseover Data Value popup. `On` — mouse position on chart data displays the recorded component value, status, and the time for that mouse position. `Off` — suspends display of mouseover data value popup.
`Status Coloring`	On `Off` (default)	Turns On/Off data status coloring. `On` — displays data points with status colors in a line chart and in a bar chart displays a status color band at the top of each bar. `Off` — hides status color data points/color bands in the chart.

Data Popup

On (default) Displays
OffPauses

Enables/disables the Fixed Data popup.

On — clicking on chart data displays the recorded date and time, as well as the name, value and status for each component in the chart at the point where you click. The persistent data popup remains visible until you close it.

Off — suspends display of fixed data popup.

Data Mouseover

On (default)
Off

Enables/disables the mouseover Data Value popup.

On — mouse position on chart data displays the recorded component value, status, and the time for that mouse position.

Off — suspends display of mouseover data value popup.

Status Coloring

On
Off (default)

Turns On/Off data status coloring.

On — displays data points with status colors in a line chart and in a bar chart displays a status color band at the top of each bar.

Off — hides status color data points/color bands in the chart.

Sampling tab

Settings	Options	Description
`Auto Sampling`	`true` (default) `false`	Enables/disables automatic sampling optimizations. `true` — automatically begins sampling if the focused data set exceeds 2500. `false` — automatically stops sampling if the focused data set is below 2500.
`Sampling Type`	`Average` (default) `Min` `Max` Sum	Sets the Sampling type. `Average` - samples average values for the selected rollup period. `Min` - samples minimum values for the selected rollup period. `Max` - samples maximum values for the selected rollup period. `Sum` - samples the total of the values in the selected rollup period.
`Desired Period`	`Best Fit` (default) `1 Minute` `15 Minutes` `30 Minutes` `Hour` `Day` `Week` `Month` `Year` `Custom`	Configurable setting allows you to choose the desired sampling interval. By default, set to `Best Fit` which finds the best sampling period that fits the page that is one the standard collection intervals which are: Year, Month, Day, Hour, 30 minutes, 15 minutes,1 minute, and other smaller common intervals.
`Sample Size`	2500 (default)	Specifies the number of points in the data set to sample. Range is 1–50000. NOTE: The default auto sampling size is configurable in the `system.properties` file.
`Sampling`	`true` `false` (default)	Enables/disables sampling for any size data set. `true` — turns on sampling `false` — turns off sampling NOTE: For performance reasons, sampling cannot be turned off once the focused data set exceeds 50,000. This threshold is configurable in the `system.properties` file.
`Data Points`	Read only	Displays the maximum number of points in the data set that are available to sample.
`Sampling Period`	Read only	Visible only once sampling has begun, displays the calculated average of the amount of time between each of the points that have been sampled.