KPIActualTrendType Property

General info

Label

Actual Trend Type

Description

The trend line type for the actual pen on a KPI trend.

Data type

UInt32

Default value

1 (syslib.model.codes.KPIPenTrendType.INTERPOLATED)

Type

CodingGroup

Code

2036

Symbolic name

MODEL_PROP_KPIACTUALTRENDTYPE

Lua access code

syslib.model.properties.KPIActualTrendType

Available since

1.20

Parent properties: KPITrendSettings

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.

Codings

Coding group: KPIPenTrendType

Name	Code	Label	Tooltip
INTERPOLATED	1	Interpolated	Interpolated.
STEP	2	Step	Step.
SYMBOL	3	Symbol	Symbol.
INTERPOLATEDSYMBOL	4	Interpolated + Symbol	Interpolated + Symbol.
STEPSYMBOL	5	Step + Symbol	Step + Symbol.

Name

Code

Label

Tooltip

INTERPOLATED

1

Interpolated

Interpolated.

STEP

2

Step

Step.

SYMBOL

3

Symbol

Symbol.

INTERPOLATEDSYMBOL

4

Interpolated + Symbol

Interpolated + Symbol.

STEPSYMBOL

5

Step + Symbol

Step + Symbol.

Examples

Read from or write to the KPIActualTrendType property.

Lua
C#

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

-- Write to the KPIActualTrendType
syslib.setvalue("<OBJECT FULL PATH>.KPITrendSettings.KPIActualTrendType",
    syslib.model.codes.KPIPenTrendType.INTERPOLATED)

TcpConfig tcpcfg = new TcpConfig() { HostNameOrIp = "localhost", Port = 6512 };
SecurityCredentials sc = new SecurityCredentials() { ProfileName = "<username>", Password = "<password>" };
StatelessInterface sli = new StatelessInterface(tcpcfg);

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

A switch-like function of the codings.

function get_coding_name(code)
    local _kpiptt = syslib.model.codes.KPIPenTrendType
    if _kpiptt.INTERPOLATED==code then return 'INTERPOLATED'
    elseif _kpiptt.STEP==code then return 'STEP'
    elseif _kpiptt.SYMBOL==code then return 'SYMBOL'
    elseif _kpiptt.INTERPOLATEDSYMBOL==code then return 'INTERPOLATEDSYMBOL'
    elseif _kpiptt.STEPSYMBOL==code then return 'STEPSYMBOL'
    end
end
return get_coding_name(syslib.model.codes.KPIPenTrendType.INTERPOLATED)