Web chart Ux settings window

Property	Value	Description
interval	optional drop-down list (defaults to the optimal number of records on reports); interval=option	Refers to the BInterval component, which the framework uses to identify the time between values in a trend (time series). When specified, a rollup is required, which causes the system to combine all values that fall into a single interval. Options range from `None` to a `Year`. Above the drop-down list, the `Use This Value` check box turns on and off the check box next to `Interval` in the Settings window (you access this window by clicking the Edit button (), followed by clicking the Settings button () on the chart). The availability of this check box provides an easy way for a user to enable and disable the use of intervals in chart calculations.
rollup	Check box (if optional, and) drop-down list or ORD parameter (when configured in the data definition, defaults to `First`, when configured elsewhere, defaults to the value as defined in the Data Definition); rollup=option	Configures the default function to apply when the analytic request needs to rollup records from a single data source into less granular records. This typically only applies to trend request, but may also apply to value requests where the Id is an algorithm that contains a block like Runtime or Sliding Window, which processes a trend request. If rollup is not enabled in the binding/settings window, the rollup value configured in the Data Definition applies to all chart bindings, reports and tables. `And` returns the logical “and” of Boolean values. `Avg` returns the statistical mean, which is determined by calculating the sum of all values and dividing by the number of values. `Count` returns the total number or quantity of values in a combination. If you request this value on a binding in a PX view, the system counts the number of values based on the properties defined by the data source block and the algorithm’s Property Sheet. `First` returns the first value in the combination. `Last` returns the last value in the combination. `Max` returns the highest value in the combination. `Median` returns the value in the middle of a sorted combination—the number that separates the higher half from the lower half. `Min` returns the lowest value in the combination. `Mode` returns the statistically most frequently occurring number in the combination. `Or` returns the logical “or” of Boolean values. `Range` returns the statistical difference between the largest and smallest values in the combination. `Sum` adds together all values in the combination resulting in a single value. `Std Dev` calculates the standard deviation of the values in the combination. `Load Factor` calculates the average divided by peak (Max) value.
aggregation	check box (if optional, and) drop-down list (property, defaults to `First`) or ORD parameter (aggregation=option)	Configures the default function to apply when the analytic request needs to combine values from multiple data sources into a single value. This applies to both value and trend requests. If aggregation is not enabled in the binding/settings window, the aggregation value defined in the Data Definition applies to all chart bindings, reports and tables. `And` returns the logical “and” of Boolean values. `Avg` returns the statistical mean, which is determined by calculating the sum of all values and dividing by the number of values. `Count` returns the total number or quantity of values in a combination. If you request this value on a binding in a PX view, the system counts the number of values based on the properties defined by the data source block and the algorithm’s Property Sheet. `First` returns the first value in the combination. `Last` returns the last value in the combination. `Max` returns the highest value in the combination. `Median` returns the value in the middle of a sorted combination—the number that separates the higher half from the lower half. `Min` returns the lowest value in the combination. `Mode` returns the statistically most frequently occurring number in the combination. `Or` returns the logical “or” of Boolean values. `Range` returns the statistical difference between the largest and smallest values in the combination. `Sum` adds together all values in the combination resulting in a single value. `Load Factor` returns the average value divided by peak value. `Std Dev` returns the standard deviation of the values in the combination.
unit	unit=option (unit of measure)	Selects the unit name and display symbol to associate with a data source.
data	algorithm (or tag) name; data=algorithm or tag name	Specifies the an algorithm (or tag) used to retrieve data. The purpose of an alert is to detect a fault condition (Boolean value result). In most cases, you would pick an algorithm that has a Boolean result when configuring this property for an alert. Algorithms with a numeric or enum value greater than zero are considered true and less than zero are considered false. This is how output from one algorithm becomes the input data source to another algorithm. The prefix for algorithms is alg:.
dataFilter	optional NEQL query (property) or ORD parameter (dataFilter=query)	Identifies data sources in the subtree of the request node. When a predicate accepts a node that contains the desired data, the system does not search the node’s subtree for additional values (including the root node).
Days to Include	graphic with the days	Selects which days of the week to include.
seriesName	BFormat (defaults to %node.navDisplayName-data.name%)	Defines the node and tag name configured by the `Data` property. The BFormat value may contain static text or scripts that use the percentage symbol delimiter, such as %node.navDisplayName%. The default value is %node.navDisplayName%-%data.name%, which resolves to the navDisplayName of the node and the name of the tag configured by the `Data` property, such as ”Building1-Power.” The %data.name% script drops the tags namespace, such as “hs:” or the algorithm reference, such as “alg:.” If you enter an invalid value, the system displays, “Problem with seriesName BFormat,” and logs a message in the station console. The name you enter here displays as the legend and tool tip in the Web chart. If left blank, no legend displays for the tool tip.
Color	color chooser	Configures the color to use on the chart.
totalize	`true` (true) or `false` or hisTotEnabled=option (ORD scheme parameter)	Turns on (`true`) and off (`false`) value accumulation. By default, the framework totalizes (accumulates) all consumption history values in charts, tables and reports. To prevent cumulative values, disable this property (set it to `false`).
Missing Data Strategy, Use This Value	check box	Enables and disables missing data interpolation for the current value. When enabled, the framework applies this strategy to all requests. When enabled, the framework applies this strategy to all requests.
missingDataStrategy, Aggregation Strategy	drop-down list; aggStrategy=option (ORD scheme parameter)	Configures how the framework handles missing trend data (data in a series) when processing analytic requests and one or more records are missing for an interval. It applies when even a single record for an interval is missing. It does not apply to value requests. NOTE: If the analytic trend request specifies `Interval` = `none`, the framework ignores the Missing Data Strategy. `Ignore Series` ignores the entire series if any record even one interval is missing. `Ignore Point` ignores any missing records and aggregates the values in the existing records.
Missing Data Strategy, Interpolation Algorithm	drop-down list	Defines the algorithm used to interpolate values for missing values (missing records). `None` does not interpolate values for missing records. `Linear Interpolation` replaces a missing record by linearly interpolating the missing value using the prior and next records on either side of the missing record. `K-Nearest Neighbor` is for numeric, enum and Boolean records. This strategy replaces a missing value by calculating the majority value recorded for the item’s nearest K number of neighbors.
Missing Data Strategy, K Value	numeric field editor (defaults to =1, min = 1, max = 30	Defines the number of records used by the configured interpolation algorithm when a record is missing to calculate the interpolated value.
Chart Type	drop-down list	Selects the type of AnalyticWebChart: bar, line, spline, area, area step, scatter, etc. Choosing a type changes the chart rendering.
Show on Y2	`true` or `false` (default)	Displays the data for the selected series using the y2–axis (right hand side of chart).

interval

optional drop-down list (defaults to the optimal number of records on reports); interval=option

Refers to the BInterval component, which the framework uses to identify the time between values in a trend (time series). When specified, a rollup is required, which causes the system to combine all values that fall into a single interval.

Options range from None to a Year.

Above the drop-down list, the Use This Value check box turns on and off the check box next to Interval in the Settings window (you access this window by clicking the Edit button (), followed by clicking the Settings button () on the chart). The availability of this check box provides an easy way for a user to enable and disable the use of intervals in chart calculations.

rollup

Check box (if optional, and) drop-down list or ORD parameter (when configured in the data definition, defaults to First, when configured elsewhere, defaults to the value as defined in the Data Definition); rollup=option

Configures the default function to apply when the analytic request needs to rollup records from a single data source into less granular records. This typically only applies to trend request, but may also apply to value requests where the Id is an algorithm that contains a block like Runtime or Sliding Window, which processes a trend request.

If rollup is not enabled in the binding/settings window, the rollup value configured in the Data Definition applies to all chart bindings, reports and tables.

And returns the logical “and” of Boolean values.

Avg returns the statistical mean, which is determined by calculating the sum of all values and dividing by the number of values.

Count returns the total number or quantity of values in a combination. If you request this value on a binding in a PX view, the system counts the number of values based on the properties defined by the data source block and the algorithm’s Property Sheet.

First returns the first value in the combination.

Last returns the last value in the combination.

Max returns the highest value in the combination.

Median returns the value in the middle of a sorted combination—the number that separates the higher half from the lower half.

Min returns the lowest value in the combination.

Mode returns the statistically most frequently occurring number in the combination.

Or returns the logical “or” of Boolean values.

Range returns the statistical difference between the largest and smallest values in the combination.

Sum adds together all values in the combination resulting in a single value.

Std Dev calculates the standard deviation of the values in the combination.

Load Factor calculates the average divided by peak (Max) value.

aggregation

check box (if optional, and) drop-down list (property, defaults to First) or ORD parameter (aggregation=option)

Configures the default function to apply when the analytic request needs to combine values from multiple data sources into a single value. This applies to both value and trend requests.

If aggregation is not enabled in the binding/settings window, the aggregation value defined in the Data Definition applies to all chart bindings, reports and tables.

And returns the logical “and” of Boolean values.

Avg returns the statistical mean, which is determined by calculating the sum of all values and dividing by the number of values.

Count returns the total number or quantity of values in a combination. If you request this value on a binding in a PX view, the system counts the number of values based on the properties defined by the data source block and the algorithm’s Property Sheet.

First returns the first value in the combination.

Last returns the last value in the combination.

Max returns the highest value in the combination.

Median returns the value in the middle of a sorted combination—the number that separates the higher half from the lower half.

Min returns the lowest value in the combination.

Mode returns the statistically most frequently occurring number in the combination.

Or returns the logical “or” of Boolean values.

Range returns the statistical difference between the largest and smallest values in the combination.

Sum adds together all values in the combination resulting in a single value.

Load Factor returns the average value divided by peak value.

Std Dev returns the standard deviation of the values in the combination.

unit

unit=option (unit of measure)

Selects the unit name and display symbol to associate with a data source.

data

algorithm (or tag) name; data=algorithm or tag name

Specifies the an algorithm (or tag) used to retrieve data.

The purpose of an alert is to detect a fault condition (Boolean value result). In most cases, you would pick an algorithm that has a Boolean result when configuring this property for an alert. Algorithms with a numeric or enum value greater than zero are considered true and less than zero are considered false.

This is how output from one algorithm becomes the input data source to another algorithm. The prefix for algorithms is alg:.

dataFilter

optional NEQL query (property) or ORD parameter (dataFilter=query)

Identifies data sources in the subtree of the request node. When a predicate accepts a node that contains the desired data, the system does not search the node’s subtree for additional values (including the root node).

Days to Include

graphic with the days

Selects which days of the week to include.

seriesName

BFormat (defaults to %node.navDisplayName-data.name%)

Defines the node and tag name configured by the Data property.

The BFormat value may contain static text or scripts that use the percentage symbol delimiter, such as %node.navDisplayName%. The default value is %node.navDisplayName%-%data.name%, which resolves to the navDisplayName of the node and the name of the tag configured by the Data property, such as ”Building1-Power.”

The %data.name% script drops the tags namespace, such as “hs:” or the algorithm reference, such as “alg:.”

If you enter an invalid value, the system displays, “Problem with seriesName BFormat,” and logs a message in the station console.

The name you enter here displays as the legend and tool tip in the Web chart. If left blank, no legend displays for the tool tip.

Color

color chooser

Configures the color to use on the chart.

totalize

true (true) or false or hisTotEnabled=option (ORD scheme parameter)

Turns on (true) and off (false) value accumulation.

By default, the framework totalizes (accumulates) all consumption history values in charts, tables and reports. To prevent cumulative values, disable this property (set it to false).

Missing Data Strategy, Use This Value

check box

Enables and disables missing data interpolation for the current value.

When enabled, the framework applies this strategy to all requests.

missingDataStrategy, Aggregation Strategy

drop-down list; aggStrategy=option (ORD scheme parameter)

Configures how the framework handles missing trend data (data in a series) when processing analytic requests and one or more records are missing for an interval. It applies when even a single record for an interval is missing. It does not apply to value requests.

NOTE: If the analytic trend request specifies Interval = none, the framework ignores the Missing Data Strategy.

Ignore Series ignores the entire series if any record even one interval is missing.

Ignore Point ignores any missing records and aggregates the values in the existing records.

Missing Data Strategy, Interpolation Algorithm

drop-down list

Defines the algorithm used to interpolate values for missing values (missing records).

None does not interpolate values for missing records.

Linear Interpolation replaces a missing record by linearly interpolating the missing value using the prior and next records on either side of the missing record.

K-Nearest Neighbor is for numeric, enum and Boolean records. This strategy replaces a missing value by calculating the majority value recorded for the item’s nearest K number of neighbors.

Missing Data Strategy, K Value

numeric field editor (defaults to =1, min = 1, max = 30

Defines the number of records used by the configured interpolation algorithm when a record is missing to calculate the interpolated value.

Chart Type

drop-down list

Selects the type of AnalyticWebChart: bar, line, spline, area, area step, scatter, etc. Choosing a type changes the chart rendering.

Show on Y2

true or false (default)

Displays the data for the selected series using the y2–axis (right hand side of chart).

Web chart Ux settings window

Related Links