BooleanParameterGroup

BooleanParameterGroup

new BooleanParameterGroup(optionsopt)

Source:

A catalog input type that groups Boolean Parameters for a category.

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.
allValue Boolean <optional>

Whether or not to have {id: OneForAll.id, value: OneForAll.value} in this.value
allCascade Boolean <optional>

Whether OneForAll being true passes all {id: ParameterList.id, value: true} values through to this.value
OneForAll BooleanParameter <optional>

A Boolean Parameter that checks and disables the BooleanParameters in the ParameterList when checked, and unchecks and enables them when unchecked. Used to send one option for the entire category/have one option click/reset all options in the category
ParameterList Array.<BooleanParameter> <optional>

An array of Boolean Parameters that belong to a category

Members

type :String

Source:

Gets the type of this parameter.

Type:
  • String