KPIPenName Property

General info

Label

Name

Description

The name of the pen in the chart that will appear to your users. Longer names may be truncated on small devices, so consider short names

Data type

String

Type

Regular

Code

2000

Symbolic name

MODEL_PROP_KPIPENNAME

Lua access code

inmation.model.properties.KPIPenName

Available since

1.18.10.2422

Parent properties

KPIPenSettings | KPIXYPlotPenSettings

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 KPIPenName property.

  • Lua

  • C#

-- Read from the KPIPenName
inmation.getvalue("<OBJECT FULL PATH>.TrendChart.KPIPenSettings.KPIPenName")

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

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