Page Comparison

Create

Insert a new entity.
Will be disabled if editing is in progress.

Update

Change the currently selected entity.
Will be disabled if no entity is selected or if there is more than one entity selected or editing is in progress.

Delete

Remove the currently selected entity.
Will be disabled if no entity is selected or if there is more than one entity selected or editing is in progress.

Reset

Reset the form fields back to their original values.
Will be disabled if editing is not in progress.

Submit

Complete the edit process and save the current changes.
Will be disabled when editing isn't in process or if the current state isn't value, for example if a polygon geometry is required but hasn't been added yet.

Cancel

Abort the edit process and abandon the current changes.
Will be disabled when editing isn't in process.

Modify

Modify an existing geometry.
Will be disabled if there is no geometry attached to the entity.

Point

Create a new point.
Will be disabled if the entity doesn't support point geometry or if it only supports a single point and there already is a point attached to the entity.

Line

Create a new line.
Will be disabled if the entity doesn't support line geometry or if it only supports a single point and there already is a line attached to the entity.

Polygon

Create a new polygon.
Will be disabled if the entity doesn't support polygon geometry or if it only supports a single polygon and there already is a polygon attached to the entity.

Remove

Remove the currently selected geometry.
Will be disabled if there is a) no geometry enabled or, b) if the entity requires some geometry and this is the last piece of geometry related to the entity.

Snap

Toggle the snapping function on and off.

Settings

Changes the snapping settings.

Import

The import button allows the user to import geometry from another entity.

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

no

The name of the column within the table that this parameter references

helptext

string

no

Additional text to display for the parameter to explain how to use the parameter

hidden

boolean

no

false

Hides the parameter from the parameter UI

alignment

'left', 'center', 'right', 'auto'

no

'auto'

How the items should appear in the UI

controltype

'listbox', 'checkbox', 'radiobutton', 'textbox' or 'textarea'

no

'textbox'

The suggested type of UI control to use when displaying the parameter
(Note that 'list-box' appears to be a synonym for 'listbox')

datatype

'any', 'date', 'time', 'datetime', 'integer', 'string'

no

'string'

The data type for the parameter

allownull

boolean

no

false

Whether a null value is allowed for this parameter

allowblank

boolean

no

true

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

allownewvalues

boolean

no

false

Allow the user to enter values not in the listbox already

defaultvalue

any

no

The default value of the parameter

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

uppercase

boolean

no

false

Should the value be converted to upper case in the generated SQL

readonly

boolean

no

false

Can the user change the value

readonlyoninsert

boolean

no

false

Can the user change the value when a new entity is being created

readonlyonupdate

boolean

no

false

Can the user change the value when an entity is being edited

updatable

boolean

no

true

Can the underlying value ever be changed once set (implied readonlyonupdate if set to true)

value

any

formula or any

A value to insert into the database, provides a means of creating values beyond what the user enters (implied readonly if set