Interface SeasonalLocationLevel

Export

SeasonalLocationLevel

interface SeasonalLocationLevel {
    aliases?: Alias[];
    attributeComment?: string;
    attributeDurationId?: string;
    attributeParameterId?: string;
    attributeParameterTypeId?: string;
    attributeUnitsId?: string;
    attributeValue?: number;
    durationId?: string;
    expirationDate?: Date;
    interpolateString?: SeasonalLocationLevelInterpolateStringEnum;
    intervalMinutes?: number;
    intervalMonths?: number;
    intervalOrigin?: Date;
    levelComment?: string;
    levelDate?: Date;
    levelUnitsId?: string;
    locationLevelId: string;
    officeId: string;
    parameterId?: string;
    parameterTypeId?: SeasonalLocationLevelParameterTypeIdEnum;
    seasonalValues?: SeasonalValueBean[];
    specifiedLevelId?: string;
}

Properties

aliases? attributeComment? attributeDurationId? attributeParameterId? attributeParameterTypeId? attributeUnitsId? attributeValue? durationId? expirationDate? interpolateString? intervalMinutes? intervalMonths? intervalOrigin? levelComment? levelDate? levelUnitsId? locationLevelId officeId parameterId? parameterTypeId? seasonalValues? specifiedLevelId?

Properties

Optional aliases

aliases?: Alias[]

Memberof

SeasonalLocationLevel

Optional attributeComment

attributeComment?: string

Memberof

SeasonalLocationLevel

Optional attributeDurationId

attributeDurationId?: string

Memberof

SeasonalLocationLevel

Optional attributeParameterId

attributeParameterId?: string

Memberof

SeasonalLocationLevel

Optional attributeParameterTypeId

attributeParameterTypeId?: string

Memberof

SeasonalLocationLevel

Optional attributeUnitsId

attributeUnitsId?: string

Memberof

SeasonalLocationLevel

Optional attributeValue

attributeValue?: number

Memberof

SeasonalLocationLevel

Optional durationId

durationId?: string

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

Memberof

SeasonalLocationLevel

Optional expirationDate

expirationDate?: Date

The expiration date of the location level.

Memberof

SeasonalLocationLevel

Optional interpolateString

interpolateString?: SeasonalLocationLevelInterpolateStringEnum

Indicating whether or not to interpolate between seasonal values.

Memberof

SeasonalLocationLevel

Optional intervalMinutes

intervalMinutes?: number

Memberof

SeasonalLocationLevel

Optional intervalMonths

intervalMonths?: number

Memberof

SeasonalLocationLevel

Optional intervalOrigin

intervalOrigin?: Date

The start point of provided seasonal values

Memberof

SeasonalLocationLevel

Optional levelComment

levelComment?: string

Memberof

SeasonalLocationLevel

Optional levelDate

levelDate?: Date

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

Memberof

SeasonalLocationLevel

Optional levelUnitsId

levelUnitsId?: string

Units the provided levels are in

Memberof

SeasonalLocationLevel

locationLevelId

locationLevelId: string

Name of the location level

Memberof

SeasonalLocationLevel

officeId

officeId: string

Owning office of object.

Memberof

SeasonalLocationLevel

Optional parameterId

parameterId?: string

Data Type such as Stage, Elevation, or others.

Memberof

SeasonalLocationLevel

Optional parameterTypeId

parameterTypeId?: SeasonalLocationLevelParameterTypeIdEnum

To indicate if single or aggregate value

Memberof

SeasonalLocationLevel

Optional seasonalValues

seasonalValues?: SeasonalValueBean[]

List of Repeating seasonal values. The values repeat after the specified interval. A yearly interval seasonable could have 12 different values, one for each month for example. Mutually exclusive with seasonalTimeSeriesId and siParameterUnitsConstantValue

Memberof

SeasonalLocationLevel

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

SeasonalLocationLevel

Settings

Member Visibility

Theme

On This Page

aliasesattributeCommentattributeDurationIdattributeParameterIdattributeParameterTypeIdattributeUnitsIdattributeValuedurationIdexpirationDateinterpolateStringintervalMinutesintervalMonthsintervalOriginlevelCommentlevelDatelevelUnitsIdlocationLevelIdofficeIdparameterIdparameterTypeIdseasonalValuesspecifiedLevelId