RegionParameter

RegionParameter

new RegionParameter(optionsopt)

Source:

A parameter that specifies a particular region.

Parameters:
Name Type Attributes Description
options Object <optional>

Object with the following properties:

Properties
Name Type Attributes Description
terria Terria

The Terria instance.
id String

The unique ID of this parameter.
name String <optional>

The name of this parameter. If not specified, the ID is used as the name.
description String <optional>

The description of the parameter.
regionProvider RegionProvider | RegionTypeParameter

The RegionProvider from which a region may be selected. This may also be a RegionTypeParameter that specifies the type of region.

Extends

Members

_defaultValue

Source:
Inherited From:

Gets the default value for this parameter, or undefined if there is no default value.

availableFormatters

Source:
Inherited From:

Gets the formatters that are available to format the parameter's value.

catalogFunction :CatalogFunction

Source:
Inherited From:

Gets the function to which this is a parameter.

Type:

converter :Any

Source:
Inherited From:

A converter that can be used to convert this parameter for use with a CatalogFunction. The actual type and content of this property is defined by the catalog function.

Type:
  • Any

defaultValue :*

Source:
Inherited From:

Gets the default value for this parameter, or undefined if there is no default value.

Type:
  • *

description :String

Source:
Inherited From:

Gets or sets the description of the parameter.

Type:
  • String

formatter :String

Source:
Inherited From:

Gets or sets the formatter (from the set defined by FunctionParameter#availableFormatters) to use to format this parameter to pass to the CatalogFunction.

Type:
  • String

id :String

Source:
Inherited From:

Gets the ID of the parameter.

Type:
  • String

isLoading :Boolean

Source:
Inherited From:

Gets or sets a value indicating whether the parameter is currently loading. This property is observable.

Type:
  • Boolean

isRequired :Boolean

Source:
Inherited From:
Default Value:
  • false

Gets or sets a value indicating whether this parameter is required.

Type:
  • Boolean

name :String

Source:
Inherited From:

Gets or sets the name of the parameter.

Type:
  • String

regionProvider :RegionProvider

Source:

Gets the region provider indicating the type of region that this property holds data for.

Type:

regionTypeParameter :RegionTypeParameter

Source:

Gets the RegionTypeParameter that specifies the type of region, if it exists.

Type:

terria :Terria

Source:
Inherited From:

Gets the Terria instance associated with this parameter.

Type:

type :String

Source:
Overrides:

Gets the type of this parameter.

Type:
  • String

value :Object

Source:
Overrides:

Gets or sets the value of this parameter. The value is an actual region, i.e. from RegionProvider#regions. However, it may be set as a string, in which case a string is treated as the ID of a region and the actual region object is looked up with the region provider.

Type:
  • Object

Methods

findRegionByID(regionID) → {Region}

Source:

Finds a region with a given region ID.

Parameters:
Name Type Description
regionID String

The ID of the region to find.
Returns:

The region, or undefined if no region matching the ID was found.

Type
Region

formatForService(valueopt) → {Any}

Source:
Inherited From:

Formats this value to pass to a service. The format is controlled by the FunctionParameter#formatter property.

Parameters:
Name Type Attributes Description
value Object <optional>

Value to format as string. If not specified, FunctionParameter#value is used.
Returns:

The formatted value.

Type
Any

formatValueAsString(valueopt) → {String}

Source:
Inherited From:

Represents value as string.

Parameters:
Name Type Attributes Description
value Object <optional>

Value to format as string. If not specified, FunctionParameter#value is used.
Returns:

String representation of the value.

Type
String

serializeToJson() → {Object}

Source:
Inherited From:

Serializes the data item to JSON.

Returns:

The serialized JSON object-literal.

Type
Object

updateFromJson(json) → {Promise}

Source:
Inherited From:

Updates the function parameter from a JSON object-literal description of it.

Parameters:
Name Type Description
json Object

The JSON description. The JSON should be in the form of an object literal, not a string.
Returns:

A promise that resolves when the update is complete.

Type
Promise