"curveValuesProperties"

The Attribute "curveValuesProperties" allows to set a list of properties for a specific curve value.

Synopsis

setValue(string shape, "curveValuesProperties", string curve, mapping valuesProperties);

getValue(string shape, "curveValuesProperties", string curve, mapping &valuesProperties);

shape.curveValuesProperties(string curve, mapping valauesProperties);

Parameters

Parameter Description
shape Name of the Trend object
curve Curve Name
valuesProperties Mapping which is used to set the properties for a specific value. The values are the key to address the mapping whereas the specific properties are the values for each key value.

Description

The function provides a mapping for the trend to set the following properties dynamically for specific curve values:

  • color

  • fillColor

  • lineType

  • fillType

  • text

All values for the properties must be set as string, see example below.

Example

mapping map;
map[1] = makeMapping("fillColor", "red"); // when value == 1, use red as fill color
map[2] = makeMapping("fillColor", "green");
TREND1.curveValuesProperties("curve1", map);
text

The property is used to set the same information that is set using the function "curveValuesTexts".

All other properties

All other available properties are used to change the design of the curve if a corresponding value is reached which is represented within the key values of the main mapping. Only the properties that are explicitly stated will be set. In the example above the properties "color", "fillType" and "lineType" are not stated and therefor the general settings of the curve are applied.

  • If config settings for the trendStatusPattern as well as settings within this functions were applied for a specific curve value than the settings of the config entry are applied.

  • If an empty mapping is stated all set properties for the curve values are removed. This also applies for the "text" property. If necessary, this property must be reapplied using either the function "curveValuesTexts" or this function.

  • Reapplying a mapping for a curve which has already defined properties will remove these properties and use the newly applied ones.

  • Setting the function "curveValuesTexts" only changes the "text" property. All other properties are not changed. Additionally setting an empty mapping for the function "curveValuesTexts"will only remove the "text" property.

Assignment

Trend