Text

A widget that allows users to enter text and offers a mode for an enriched editor with syntax highlighting

Specification

key	type	required	default value	description
readOnly	boolean	no	`false`	If `true` field will not be editable.
editor	enum	no	`plaintext`	Specify which editor to use. Value affects syntax highlighting and validation in some cases (e.g. url).
trimWhitespace	boolean	no	`false`	If `true` whitespace will be trimmed from the beginning and end of the value.
showInlineEditor	boolean	no	`false`	If `true` the editor dialog will be shown in the dialog itself.
showEditButton	boolean	no	`true`	If `true` a button to open the editor will appear next to the line edit.
showArithmeticEditor	boolean	no	`false`	If `true` an option to show the arithmetic editor will be made available.
runnable	boolean	no	`false`	Internal only: If `true` the value is a valid executable script.
sqlSettings	dictionary	no	n/a	If `'editor'` is `sql`, can specify additional options to allow importing tables from a reader.
regexSettings	dictionary	conditional	n/a	A dictionary of settings applicable when `editor` is `regex`.
webSocketSettings	dictionary	conditional	n/a	A dictionary of keys only applicable when `editor` is `webSocket`.
xQuerySettings	dictionary	conditional	n/a	A dictionary of keys only applicable when `editor` is `xquery`.
urlSettings	dictionary	conditional	n/a	A dictionary of keys only applicable when `editor` is `url`.

deprecated

key	type	required	description
addAsAttribute	enum	no	The type of attribute to be added. To be deprecated.
isNewListAttribute	boolean	no	Internal only: `true` if the parameter was translated from a `NEW_LIST_ATTR` guitype. Used for determining mapping file output.

sqlSettings

key	type	required	default value	description
mode	enum: `sql`, `where`	yes	`sql`	If `sql` drag and drop produces SELECT statements by default.
format	string	yes	n/a	Format shortname.
dataset	string	yes	n/a	Dataset for a connection.
connectionParams	dictionary	yes	A dictionary of reader parameters.
startTableExpanded	boolean	yes	n/a	If set the editor starts with specified table expanded.

regexSettings

key	type	required	default value	description
contains	boolean	no	`false`	If `true` regex will be in contains mode; If `false` exact matches mode will be assumed.
caseSensitive	boolean ({parameter} ok)	no	`false`	If `true` regex will be in case-sensitive mode; If `false` case insensitive mode will be assumed.
testString	string	no	n/a	A parameter name to save the value of the test string to, which allows test strings to be preserved across dialog sessions.

webSocketSettings

key	type	required	default value	description
webSocketOpen	boolean	no	`false`	If `true` websocket preamble will be shown for open.
webSocketSend	boolean	no	`false`	If `true` websocket preamble will be shown for send.

xQuerySettings

key	type	required	default value	description
getFunctions	boolean	no	`false`	If `true` read-only (get, list, contains) functions on attributes and values are exposed.
processFunctions	boolean	no	`false`	If `true` process functions on features and templates are exposed.
setFunctions	boolean	no	`false`	If `true` write-only (set, append) functions on attributes are exposed.
sampleGeneration	boolean	no	`false`	If `true` the ability to generate an XML template is exposed.
noBraces	boolean	no	`false`	If `true` the exposed functions will not be wrapped in braces.
geometryFunctions	boolean	no	`false`	If `true` geometry related functions are exposed.
json	boolean	no	`false`	If `true` json related functions are exposed and replace the xml related functions.

urlSettings

key	type	required	default value	description
validSchemes	array\	no	[]	A string list of valid url schemes.

editor

plaintext
gquery
regex
html
java
javascript
pce
python
raster
rstats
sql
tcl
websocket
xml
xquery
url
json

addAsAttribute

char(width)
varchar(width)
buffer
xml
json
binary(width)
varbinary(width)
binarybuffer
datetime
time
date
real64
real32
int32
uint32
int64
uint64
logical
int16
int8
uint8
number(width,decimal)

({parameter} ok)

If a property is labelled with ({parameter} ok), the value can be either a constant (string) or a reference to another parameter, in the form of a dictionary mapping the key "parameter" to the name of the referenced parameter, e.g. { "parameter" : "MY_PARAM" }

Example

{
  "name": "sometext",
  "type": "text",
  "valueType": "string",
  "prompt": "New Attribute Name"
}