KPIBarOffset Property

General info

Label

Offset

Description

Relative time offset used to get values for the object. This allows the chart to show values at different times such as Profit Today and Profit Last Week. This value uses our standard offset format (e.g. *-1day).

Data type

String

Type

Regular

Code

2023

Symbolic name

MODEL_PROP_KPIBAROFFSET

Lua access code

syslib.model.properties.KPIBarOffset

Available since

1.20
Parent properties

KPIBarSettings

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

  • Lua

  • C#

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

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