KPIPen Property

General info

Label

Value

Description

String property containing full instance path to the pen value for the chart.

Data type

String

Type

Regular

Code

1995

Symbolic name

MODEL_PROP_KPIPEN

Lua access code

syslib.model.properties.KPIPen

Available since

1.18
Parent properties

KPIPenSettings

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.
PROP_OBJECTPATH Property can receive object paths.

Examples

Read from or write to the KPIPen property.

  • Lua

  • C#

-- Read from the KPIPen
syslib.getvalue("<OBJECT FULL PATH>.KPIPenSettings.KPIPen")

-- Write to the KPIPen
syslib.setvalue("<OBJECT FULL PATH>.KPIPenSettings.KPIPen", "new value")
TcpConfig tcpcfg = new TcpConfig() { HostNameOrIp = "localhost", Port = 6512 };
SecurityCredentials sc = new SecurityCredentials() { ProfileName = "<username>", Password = "<password>" };
StatelessInterface sli = new StatelessInterface(tcpcfg);

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