Interface VirtualLocationLevel

Export

VirtualLocationLevel

interface VirtualLocationLevel {
    aliases?: Alias[];
    attributeComment?: string;
    attributeDurationId?: string;
    attributeParameterId?: string;
    attributeParameterTypeId?: string;
    attributeUnitsId?: string;
    attributeValue?: number;
    constituentConnections?: string;
    constituents?: RATING[];
    durationId?: string;
    expirationDate?: Date;
    interpolateString?: VirtualLocationLevelInterpolateStringEnum;
    levelComment?: string;
    levelDate?: Date;
    levelUnitsId?: string;
    locationLevelId: string;
    officeId: string;
    parameterId?: string;
    parameterTypeId?: VirtualLocationLevelParameterTypeIdEnum;
    specifiedLevelId?: string;
}

Properties

aliases? attributeComment? attributeDurationId? attributeParameterId? attributeParameterTypeId? attributeUnitsId? attributeValue? constituentConnections? constituents? durationId? expirationDate? interpolateString? levelComment? levelDate? levelUnitsId? locationLevelId officeId parameterId? parameterTypeId? specifiedLevelId?

Properties

Optional aliases

aliases?: Alias[]

Memberof

VirtualLocationLevel

Optional attributeComment

attributeComment?: string

Memberof

VirtualLocationLevel

Optional attributeDurationId

attributeDurationId?: string

Memberof

VirtualLocationLevel

Optional attributeParameterId

attributeParameterId?: string

Memberof

VirtualLocationLevel

Optional attributeParameterTypeId

attributeParameterTypeId?: string

Memberof

VirtualLocationLevel

Optional attributeUnitsId

attributeUnitsId?: string

Memberof

VirtualLocationLevel

Optional attributeValue

attributeValue?: number

Memberof

VirtualLocationLevel

Optional constituentConnections

constituentConnections?: string

Memberof

VirtualLocationLevel

Optional constituents

constituents?: RATING[]

Memberof

VirtualLocationLevel

Optional durationId

durationId?: string

0 if parameterTypeId is Inst. Otherwise duration indicating the time window of the aggregate value.

Memberof

VirtualLocationLevel

Optional expirationDate

expirationDate?: Date

The expiration date of the location level.

Memberof

VirtualLocationLevel

Optional interpolateString

interpolateString?: VirtualLocationLevelInterpolateStringEnum

Indicating whether or not to interpolate between seasonal values.

Memberof

VirtualLocationLevel

Optional levelComment

levelComment?: string

Memberof

VirtualLocationLevel

Optional levelDate

levelDate?: Date

The date/time at which this location level configuration takes effect.

Memberof

VirtualLocationLevel

Optional levelUnitsId

levelUnitsId?: string

Units the provided levels are in

Memberof

VirtualLocationLevel

locationLevelId

locationLevelId: string

Name of the location level

Memberof

VirtualLocationLevel

officeId

officeId: string

Owning office of object.

Memberof

VirtualLocationLevel

Optional parameterId

parameterId?: string

Data Type such as Stage, Elevation, or others.

Memberof

VirtualLocationLevel

Optional parameterTypeId

parameterTypeId?: VirtualLocationLevelParameterTypeIdEnum

To indicate if single or aggregate value

Memberof

VirtualLocationLevel

Optional specifiedLevelId

specifiedLevelId?: string

TimeSeries ID (e.g. from the times series catalog) to use as the location level. Mutually exclusive with seasonalValues and siParameterUnitsConstantValue

Memberof

VirtualLocationLevel

Settings

Member Visibility

Theme

On This Page

aliasesattributeCommentattributeDurationIdattributeParameterIdattributeParameterTypeIdattributeUnitsIdattributeValueconstituentConnectionsconstituentsdurationIdexpirationDateinterpolateStringlevelCommentlevelDatelevelUnitsIdlocationLevelIdofficeIdparameterIdparameterTypeIdspecifiedLevelId