DisplayOrder Property

General info

Label

Display Order

Description

Numeric value that overrides the default alphanumeric order of KPIs. KPIs without explicit display order will be sorted alphanumerically and displayed below KPIs with display order values explicitly set.

Data type

Int32

Type

Regular

Code

921

Symbolic name

MODEL_PROP_DISPLAYORDER

Lua access code

syslib.model.properties.DisplayOrder

Available since

1.0

Parent properties

KPIGroupSettings

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_NULLABLE This Property can have no value.

Examples

Read from or write to the DisplayOrder property.

  • Lua

  • C#

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

-- Write to the DisplayOrder
syslib.setvalue("<OBJECT FULL PATH>.KPIGroupSettings.DisplayOrder", 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 DisplayOrder
Result result = sli.ReadValue(sc, new ReadItem("<OBJECT FULL PATH>.KPIGroupSettings.DisplayOrder"));
// Write to the DisplayOrder
Result result = sli.WriteValue(sc, new WriteItem(VALUE, "<OBJECT FULL PATH>.KPIGroupSettings.DisplayOrder"));