FunctionParameter

FunctionParameter

(abstract) new FunctionParameter(optionsopt)

Source:

A parameter to a CatalogFunction.

Parameters:
Name Type Attributes Description
options Object <optional>

Object with the following properties:

Properties
Name Type Attributes Description
terria Terria

The Terria instance.
catalogFunction CatalogFunction

The function that this is a parameter to.
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.
isRequired Boolean <optional>

True if this parameter is required, false if it is optional.
value Object <optional>

The initial value of the parameter.

Members

_defaultValue

Source:

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

availableFormatters

Source:

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

catalogFunction :CatalogFunction

Source:

Gets the function to which this is a parameter.

Type:

converter :Any

Source:

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:

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

Type:
  • *

description :String

Source:

Gets or sets the description of the parameter.

Type:
  • String

formatter :String

Source:

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:

Gets the ID of the parameter.

Type:
  • String

isLoading :Boolean

Source:

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

Type:
  • Boolean

isRequired :Boolean

Source:
Default Value:
  • false

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

Type:
  • Boolean

name :String

Source:

Gets or sets the name of the parameter.

Type:
  • String

terria :Terria

Source:

Gets the Terria instance associated with this parameter.

Type:

type :String

Source:

Gets the type of this parameter.

Type:
  • String

value

Source:

Gets or sets the current value of this parameter.

value :*

Source:

Gets or sets the current value of this parameter.

Type:
  • *

Methods

formatForService(valueopt) → {Any}

Source:

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:

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:

Serializes the data item to JSON.

Returns:

The serialized JSON object-literal.

Type
Object

updateFromJson(json) → {Promise}

Source:

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