Page Comparison

Name

Type

Required

Default

Description

id

string

yes

A unique identifier for the parameter

label

string

yes

The prompt text displayed when user input the parameter value

column

string

yes

The name of the column within the layer that this parameter references.

controlType

‘list' ‘checkboxtext', 'radiobutton‘list', 'textbox'radio', ‘check', ‘multicheck’, 'silder’, 'multislider’

no

'textboxtext'

The UI control to use when displaying the parameter

dataType

'boolean', 'float', 'integer', 'string'

no

'string'

The data type for the parameter

allowBlank

boolean

no

true

Give the user the choice of an empty value in the listbox (as opposed to a null value)

value

any

no

The default value of the parameter (except multislider fields)

dataSet

ref urn:com.cohga.server.data.database#1.0:datadefinition

no

Where to get the values for a listbox

labelColumn

string

no

Column in the datadefinition that supplies the label of the value to show the user

valueColumn

string

no

Column in the datadefinition that supplies the value of the value to use in the SQL

scalarparametertype

string

no

'simple'

'simple' or 'multi-value' to determine of more than one value can be selected from a list.

width

integer

no

Set the width of the field

minValue

number

yes - for slider and multislider

The minimum value allowed for a numeric field.

maxValue

number

yes - for slider and multislider

The maximum value allowed for a numeric field.

leftValue

number

no

The initial minimum value for a multislider

rightValue

number

no

The initial maximum value for a multislider

increment

number

no

The increment to use for fields that support it, the units are dependant upon the field type.

trueValue

any

no

The value that equates to "true" in the underlying table, only suitable for checkboxes

falseValue

any

no

The value that equates to "false" in the underlying table, only suitable for checkboxes

decimalPrecision

number

no

The precision of any numeric fields