KpiShow Property

General info

Label

Show

Description

Hide/show KPI. A setting of False will suppress the display of the object to the users in the VisualKPI web display.

Data type

Boolean

Default value

true

Type

Regular

Code

955

Symbolic name

MODEL_PROP_KPISHOW

Lua access code

syslib.model.properties.KpiShow

Available since

1.0
Parent classes

Chart | GenKPI | KPIEmbeddedContent | KPITable

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_HAS_DEFAULT The property has a default value as standard.

Examples

Read from or write to the KpiShow property.

  • Lua

  • C#

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

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

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