DefaultChartExpansion Property

General info

Label

Default Chart Expansion

Description

Default chart expansion

Data type

UInt32

Default value

0 (inmation.model.codes.KPIGroupDefaultExpansion.COLLAPSED)

Type

CodingGroup

Code

2115

Symbolic name

MODEL_PROP_DEFAULTCHARTEXPANSION

Lua access code

inmation.model.properties.DefaultChartExpansion

Available since

1.18.12.2422
Parent properties

DefaultGroupSettings

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: KPIGroupDefaultExpansion

Name Code Label Tooltip

COLLAPSED

0

Collapsed

Collapsed

EXPANDED

1

Expanded

Expanded

Examples

Read from or write to the DefaultChartExpansion property.

  • Lua

  • C#

-- Read from the DefaultChartExpansion
inmation.getvalue("<OBJECT FULL PATH>.DefaultGroupSettings.DefaultChartExpansion")

-- Write to the DefaultChartExpansion
inmation.setvalue("<OBJECT FULL PATH>.DefaultGroupSettings.DefaultChartExpansion",
    inmation.model.codes.KPIGroupDefaultExpansion.COLLAPSED)
TcpConfig tcpcfg = new TcpConfig() { HostNameOrIp = "localhost", Port = 6512 };
SecurityCredentials sc = new SecurityCredentials() { ProfileName = "so", Password = "inmation" };
StatelessInterface sli = new StatelessInterface(tcpcfg);

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

A switch-like function of the codings.

function get_coding_name(code)
    local kpigde = inmation.model.codes.KPIGroupDefaultExpansion
    if kpigde.COLLAPSED==code then return 'COLLAPSED'
    elseif kpigde.EXPANDED==code then return 'EXPANDED'
    end
end
return get_coding_name(inmation.model.codes.KPIGroupDefaultExpansion.COLLAPSED)