$k. GeoRange

new GeoRange()

Represents the value range of a geo position attribute

Extends

Methods

formats() → {Array.<string>}

Returns the names of the supported formats

Returns:
Type: 
Array.<string>

parse(string, languageopt)

Parse the string representation and returns the converted value

Parameters:
NameTypeAttributesDescription
stringstring

The string represantation of the value that should be set.

languagestring<optional>

Either an ISO 639-1 or ISO 639-2B language code (e.g. "en" or "eng"), or a locale name without encoding (e.g. "en_US"). Locale names and language codes are not interchangeable, e.g. the values for "de" and "de_DE" are separated. If not defined, the locale/language of the process will be used. Ignored if the attribute is not translated.

Inherited From
Throws:

If the string is not in the range of allowed values of the attribute

Type
$k.exception.InvalidValue
Returns:

The converted value

parseFormat(string, format) → {$k.GeoPosition}

Parse the geo position in the specified format and returns the converted value

Parameters:
NameTypeDescription
stringstring

The string represantation of the geo position

formatstring

The name of a supported format

Throws:

If the string is not in the range of allowed values of the attribute, or if the format is not supported

Type
$k.exception.InvalidValue
Returns:

The converted value

Type: 
$k.GeoPosition

valueToString(value, languageopt) → {string}

Returns the string representation of the value

Parameters:
NameTypeAttributesDescription
valuestring

The value that should be converted

languagestring<optional>

Either an ISO 639-1 or ISO 639-2B language code (e.g. "en" or "eng"), or a locale name without encoding (e.g. "en_US"). Locale names and language codes are not interchangeable, e.g. the values for "de" and "de_DE" are separated. If not defined, the locale/language of the process will be used. Ignored if the attribute is not translated.

Throws:

If the value is not in the range of allowed values of the attribute

Type
$k.exception.InvalidValue
Returns:
Type: 
string

valueType() → {string}

Returns a string describing the value type.

One of

  • blob
  • boolean
  • choice
  • color
  • container
  • date
  • dateAndTime
  • flexTime
  • float
  • geoPosition
  • integer
  • interval
  • password
  • registyEntry
  • string
  • time
  • translatedAttribute
  • translation
  • url
Returns:
Type: 
string