KPIShowAverageTrendline Property

General info

Label

Show Average Trendline

Description

A boolean value used to set visibility of a line depicting the average of the actual trend data within the trend timeframe

Data type

Boolean

Type

Regular

Code

2073

Symbolic name

MODEL_PROP_KPISHOWAVERAGETRENDLINE

Lua access code

inmation.model.properties.KPIShowAverageTrendline

Available since

1.18.10.2422

Parent properties

KPITrendSettings

Attributes

Name Tooltip
PROP_CONFIGURABLE The property is configurable and can be changed with DataStudio and the various inmation APIs
PROP_VISIBLE The property is visible in DataStudio and can be read by the inmation APIs

Examples

Read from or write to the KPIShowAverageTrendline property.

  • Lua

  • C#

-- Read from the KPIShowAverageTrendline
inmation.getvalue("<OBJECT FULL PATH>.KPIShowAverageTrendline")

-- Write to the KPIShowAverageTrendline
inmation.setvalue("<OBJECT FULL PATH>.KPIShowAverageTrendline", true)
TcpConfig tcpcfg = new TcpConfig() { HostNameOrIp = "localhost", Port = 6512 };
SecurityCredentials sc = new SecurityCredentials() { ProfileName = "so", Password = "inmation" };
StatelessInterface sli = new StatelessInterface(tcpcfg);

// Read from the KPIShowAverageTrendline
Result result = sli.ReadValue(sc, new ReadItem("<OBJECT FULL PATH>.KPIShowAverageTrendline"));
// Write to the KPIShowAverageTrendline
Result result = sli.WriteValue(sc, new WriteItem(true, "<OBJECT FULL PATH>.KPIShowAverageTrendline"));