leylinesjs-Documentation

RegionTypeParameter

new RegionTypeParameter(optionsopt)

Source:

Models/RegionTypeParameter.js, line 29

A parameter that specifies a type of region.

Parameters:

Name Type Attributes Description

options

Object

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.
`validRegionTypes`	Array.<String>	<optional>	The region types from which this RegionTypeParameter selects. If this parameter is not specified, all region types known to `Terria` may be selected.

Extends

FunctionParameter

Members

_defaultValue

Source:

Models/FunctionParameter.js, line 96

Inherited From:

FunctionParameter#_defaultValue

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

availableFormatters

Source:

Models/FunctionParameter.js, line 192

Inherited From:

FunctionParameter#availableFormatters

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

catalogFunction :CatalogFunction

Source:

Models/FunctionParameter.js, line 171

Inherited From:

FunctionParameter#catalogFunction

Gets the function to which this is a parameter.

Type:

CatalogFunction

converter :Any

Source:

Models/FunctionParameter.js, line 84

Inherited From:

FunctionParameter#converter

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:

defaultValue :*

Source:

Models/FunctionParameter.js, line 115

Inherited From:

FunctionParameter#defaultValue

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

Type:

description :String

Source:

Models/FunctionParameter.js, line 70

Inherited From:

FunctionParameter#description

Gets or sets the description of the parameter.

Type:

String

formatter :String

Source:

Models/FunctionParameter.js, line 91

Inherited From:

FunctionParameter#formatter

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:

Models/FunctionParameter.js, line 182

Inherited From:

FunctionParameter#id

Gets the ID of the parameter.

Type:

String

isLoading :Boolean

Source:

Models/FunctionParameter.js, line 58

Inherited From:

FunctionParameter#isLoading

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

Type:

Boolean

isRequired :Boolean

Source:

Models/FunctionParameter.js, line 77

Inherited From:

FunctionParameter#isRequired

Default Value:

false

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

Type:

Boolean

name :String

Source:

Models/FunctionParameter.js, line 64

Inherited From:

FunctionParameter#name

Gets or sets the name of the parameter.

Type:

String

terria :Terria

Source:

Models/FunctionParameter.js, line 160

Inherited From:

FunctionParameter#terria

Gets the Terria instance associated with this parameter.

Type:

Terria

type :String

Source:

Models/RegionTypeParameter.js, line 110

Overrides:

FunctionParameter#type

Gets the type of this parameter.

Type:

String

value

Source:

Models/FunctionParameter.js, line 101

Overrides:

FunctionParameter#value

Gets or sets the current value of this parameter.

Methods

(static) resolveRegionProvider(regionProviderOrParameter) → {RegionProvider}

Source:

Models/RegionTypeParameter.js, line 90

Resolves value that may be either a RegionProvider or a RegionTypeParameter to a RegionProvider.

Parameters:

Name	Type	Description
`regionProviderOrParameter`	RegionProvider \| RegionTypeParameter	The region provider or parameter.

Returns:

If regionProviderOrParameter is a RegionProvider, that value is returned. If it is a RegionTypeParameter, the value of the parameter is returned. The return value may be undefined if regionProviderOrParameter is undefined, or if the value of the region type parameter is undefined.

Type: RegionProvider

formatForService(valueopt) → {Any}

Source:

Models/FunctionParameter.js, line 268

Inherited From:

FunctionParameter#formatForService

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:

Models/FunctionParameter.js, line 256

Inherited From:

FunctionParameter#formatValueAsString

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

getAllRegionTypes() → {Promise.<Array.<RegionProvider>>}

Source:

Models/RegionTypeParameter.js, line 133

Gets all list of region types that may be selected for this parameter. Also caches the promise in this._regionProviderPromise, and the promise result in this._regionProviderList.