Class Location

A geographic location.

Hierarchy (View Summary)

PropMap
- Location

Implements

LocationProperties

Index

Constructors

constructor

new Location(loc?: object | Location): Location
Constructor.
Parameters
- Optionalloc: object | Location
  the location to copy properties from
Returns Location
Overrides PropMap.constructor
- Defined in src/main/domain/location.ts:39

Properties

`Readonly`props

props: Map<string, any>

The object that all properties are stored on.

Accessors

country

get country(): undefined | string
An ISO 3166-1 alpha-2 character country code.

Returns undefined | string
Implementation of LocationProperties.country
- Defined in src/main/domain/location.ts:68
set country(val: null | string): void
Parameters
- val: null | string
Returns void
Implementation of LocationProperties.country
- Defined in src/main/domain/location.ts:72

elevation

get elevation(): undefined | number
The elevation above sea level, in meters.

Returns undefined | number
Implementation of LocationProperties.elevation
- Defined in src/main/domain/location.ts:156
set elevation(val: null | number): void
Parameters
- val: null | number
Returns void
Implementation of LocationProperties.elevation
- Defined in src/main/domain/location.ts:160

id

get id(): undefined | number
A SolarNetwork assigned unique identifier.

Returns undefined | number
Implementation of LocationProperties.id
- Defined in src/main/domain/location.ts:46
set id(val: null | number): void
Parameters
- val: null | number
Returns void
Implementation of LocationProperties.id
- Defined in src/main/domain/location.ts:50

latitude

get latitude(): undefined | number
The decimal world latitude.

Returns undefined | number
Implementation of LocationProperties.latitude
- Defined in src/main/domain/location.ts:134
set latitude(val: null | number): void
Parameters
- val: null | number
Returns void
Implementation of LocationProperties.latitude
- Defined in src/main/domain/location.ts:138

locality

get locality(): undefined | string
Get the locality (city, town).

Returns undefined | string
Implementation of LocationProperties.locality
- Defined in src/main/domain/location.ts:101
set locality(val: null | string): void
Parameters
- val: null | string
Returns void
Implementation of LocationProperties.locality
- Defined in src/main/domain/location.ts:105

longitude

get longitude(): undefined | number
The decimal world longitude.

Returns undefined | number
Implementation of LocationProperties.longitude
- Defined in src/main/domain/location.ts:145
set longitude(val: null | number): void
Parameters
- val: null | number
Returns void
Implementation of LocationProperties.longitude
- Defined in src/main/domain/location.ts:149

name

get name(): undefined | string
A generalized name, can be used for "virtual" locations.

Returns undefined | string
Implementation of LocationProperties.name
- Defined in src/main/domain/location.ts:57
set name(val: null | string): void
Parameters
- val: null | string
Returns void
Implementation of LocationProperties.name
- Defined in src/main/domain/location.ts:61

postalCode

get postalCode(): undefined | string
A country-specific postal code.

Returns undefined | string
Implementation of LocationProperties.postalCode
- Defined in src/main/domain/location.ts:112
set postalCode(val: null | string): void
Parameters
- val: null | string
Returns void
Implementation of LocationProperties.postalCode
- Defined in src/main/domain/location.ts:116

region

get region(): undefined | string
A country-specific regional identifier.

Returns undefined | string
Implementation of LocationProperties.region
- Defined in src/main/domain/location.ts:79
set region(val: null | string): void
Parameters
- val: null | string
Returns void
Implementation of LocationProperties.region
- Defined in src/main/domain/location.ts:83

size

get size(): number
Get the number of properties configured.

Returns number
Inherited from PropMap.size
- Defined in src/main/util/propMap.ts:58

stateOrProvince

get stateOrProvince(): undefined | string
A country-specific state or province identifier.

Returns undefined | string
Implementation of LocationProperties.stateOrProvince
- Defined in src/main/domain/location.ts:90
set stateOrProvince(val: null | string): void
Parameters
- val: null | string
Returns void
Implementation of LocationProperties.stateOrProvince
- Defined in src/main/domain/location.ts:94

street

get street(): undefined | string
The street address.

Returns undefined | string
Implementation of LocationProperties.street
- Defined in src/main/domain/location.ts:123
set street(val: null | string): void
Parameters
- val: null | string
Returns void
Implementation of LocationProperties.street
- Defined in src/main/domain/location.ts:127

timeZoneId

get timeZoneId(): undefined | string
A time zone ID, for example Pacific/Auckland.

Returns undefined | string
Implementation of LocationProperties.timeZoneId
- Defined in src/main/domain/location.ts:167
set timeZoneId(val: null | string): void
Parameters
- val: null | string
Returns void
Implementation of LocationProperties.timeZoneId
- Defined in src/main/domain/location.ts:171

Methods

[iterator]

"[iterator]"(): MapIterator<[string, any]>
Get an iterator over the property entries.

Returns MapIterator<[string, any]>
iterator over [k, v] values
Inherited from PropMap.[iterator]
- Defined in src/main/util/propMap.ts:51

prop

prop(key: string): any
Get a property value.
Parameters
- key: string
  the key to get
Returns any
the associated value for the given key
Inherited from PropMap.prop
- Defined in src/main/util/propMap.ts:68
prop(key: string, newValue: any): this
Set or remove a property value.
Parameters
- key: string
  the key to set the value for
- newValue: any
  the new value to set for the given key; if null then the key property will be removed
Returns this
this object
Inherited from PropMap.prop
- Defined in src/main/util/propMap.ts:77

properties

properties(): Record<string, any>
Get all properties.

Returns Record<string, any>
all properties of this object copied into a simple object
Inherited from PropMap.properties
- Defined in src/main/util/propMap.ts:95
properties(newProps: object | Map<string, any>): this
Set or remove multiple properties.
Parameters
- newProps: object | Map<string, any>
  the new values to set; if any value is null that property will be deleted
Returns this
this object
Inherited from PropMap.properties
- Defined in src/main/util/propMap.ts:103

toUriEncoding

toUriEncoding(
propertyName?: string,
callbackFn?: PropMapUriEncodingCallbackFn,
): string
Get this object as a standard URI encoded (query parameters) string value.

All enumerable properties of the props property will be added to the result. If any property value is an array, the values of the array will be joined by a comma. Any Util.Enum values will have their name property used.
Parameters
- OptionalpropertyName: string
  an optional object property prefix to add to all properties
- OptionalcallbackFn: PropMapUriEncodingCallbackFn
  An optional function that will be called for each property. The function will be passed property name and value arguments, and must return either undefined to skip the property, a 2 or 3-element array with the property name and value to use, and an optional boolean to force array values to use mutliple parameter keys. Any other return value causes the property to be used as-is.
Returns string
the URI encoded string
Inherited from PropMap.toUriEncoding
- Defined in src/main/util/propMap.ts:134

toUriEncodingWithSorting

toUriEncodingWithSorting(
    sorts?: SortDescriptor[],
    pagination?: Pagination,
    propertyName?: string,
    callbackFn?: PropMapUriEncodingCallbackFn,
): string
Get this object as a standard URI encoded (query parameters) string value with sorting and pagination parameters.

This calls Util.PropMap.toUriEncoding first, then encodes the sorts and pagination parameters, if provided.
Parameters
- Optionalsorts: SortDescriptor[]
  optional sort settings to use
- Optionalpagination: Pagination
  optional pagination settings to use
- OptionalpropertyName: string
  an optional object property prefix to add to all properties
- OptionalcallbackFn: PropMapUriEncodingCallbackFn
  An optional function that will be called for each property. The function will be passed property name and value arguments, and must return either undefined to skip the property, a 2-element array with the property name and value to use, or anything else to use the property as-is.
Returns string
the URI encoded string
Inherited from PropMap.toUriEncodingWithSorting
- Defined in src/main/util/propMap.ts:210

Class Location

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Location

Properties

Readonlyprops

Accessors

country

Returns undefined | string

Parameters

Returns void

elevation

Returns undefined | number

Parameters

Returns void

id

Returns undefined | number

Parameters

Returns void

latitude

Returns undefined | number

Parameters

Returns void

locality

Returns undefined | string

Parameters

Returns void

longitude

Returns undefined | number

Parameters

Returns void

name

Returns undefined | string

Parameters

Returns void

postalCode

Returns undefined | string

Parameters

Returns void

region

Returns undefined | string

Parameters

Returns void

size

Returns number

stateOrProvince

Returns undefined | string

Parameters

Returns void

street

Returns undefined | string

Parameters

Returns void

timeZoneId

Returns undefined | string

Parameters

Returns void

Methods

[iterator]

Returns MapIterator<[string, any]>

prop

Parameters

Returns any

Parameters

Returns this

properties

Returns Record<string, any>

Parameters

Returns this

toUriEncoding

Parameters

Returns string

`Readonly`props