Global

Type Definitions

ColumnDefinitionobject

Properties:

Name	Type	Description
header	string	The header of the column
dataIndex	string	The property of the data object where the data for this column can be found,
minWidth	number	The minimal width of the column,
maxWidth	number	The maximum width of the column

dialogActionCallback(selectedIds, documentsContext)

Dialog action function

Name	Type	Description
selectedIds	Array.<string>	The date as string of the clicked item
documentsContext	documents.sdk.DocumentsContext	The DocumentsContext instance

doubleClickFunction(event, dateString, documentsContext)

Double click function

Name	Type	Description
event	object	Event
dateString	string	The date as string of the clicked item
documentsContext	documents.sdk.DocumentsContext	The DocumentsContext instance

DropzoneValueobject

Properties:

Name	Type	Description
fileName	string	filename of the uploaded file
accessToken	string	token to access the file in the portal script

failedValidationHandlerFunction(validationResult)

The failed validation handler function

Name	Type	Description
validationResult	object	the object containing all informations about executed validatorFunction Name Type Description resultObject object object containing one validation result for each field of the form formJqueryObject object the jquery object of the entire form documentsContext documents.sdk.DocumentsContext a reference to the documents.sdk.DocumentsContext

Fieldobject

The field object used by the validator function

Properties:

Name	Type	Description
id	string	input field id
type	string	type of the input field
value	string	value of the input field

FullCalendarEventsobject

See the fullcalendar documentation for details https://fullcalendar.io/docs/event_data/Event_Object/

Properties:

Name	Type	Argument	Description
id	string | number		A id for the event
start	string		The date/time an event begins (A Moment-ish input, like an ISO8601 string).
end	string	<optional>	The exclusive date/time an event ends (A Moment-ish input, like an ISO8601 string).
title	string		The text on an event's element

FullCalendarSourceobject

See the fullcalendar documentation for details https://fullcalendar.io/docs/event_data/Event_Source_Object/
The event property is filled by the defined eventLoader

Properties:

Name	Type	Description
id	string	A id for this event source
color	string	Sets every Event Object's color for this source.
textColor	string	Sets every Event Object's textColor for this source.

GadgetConfigobject

Properties:

Name	Type	Description
gadgetId	string	The unique id of the gadget
gadgetScript	string	The script where the gadgetAction is located in (must begin with "Gadget")
gadgetAction	string	The name of the gadgetAction to be executed
gadgetParams	object	The params to be sent to the gadget

GadgetSettingobject

Properties:

Name	Type	Argument	Description
name	string		The techincal name of the setting
def	string | number		The default value to be used if no value is specified. If a number is specified the default value will be the value from the enum array with the given index.
type	string		The type of the setting. (string | boolean | number)
enum	Array.<string> | array.<Array.<string>>		An Array of values i.e. ["A", "B"] that the user can choose from. Or an Array of key value pairs i.e. [[0, "A"], [1, "B"]]. The values must be of the type defined in type.
desc	string	<optional>	The description of this setting

TableDataColumnobject

Properties:

Name	Type	Default	Description
key	string		column key (must match a database column name)
label	string		column key
dataType	string	STRING	data type of this column (STRING, NUMBER, CUSTOM or CHECKBOX)
searchMode	string	default	define how the search on this colum is processed. Possible values: default (columnName LIKE '%EXPR%'), exact (columnName = 'EXPR'), start (columnName LIKE 'EXPR%'), end (columnName LIKE '%EXPR')
searchable	boolean	true	set to false to exclude this column from search
searchCaseSensitive	boolean	false	search this column case sensitive (database must support this)

TableDataMappingobject

Properties:

Name	Type	Description
columnName	string	database column containing the value for the field
fieldName	string	the technical name of the field to fill with the given value
valueCallback	function	optional callback function to manipulate the value from the database colum. function valueCallback(value, documentsContext, item, mappingConfig) {}

validationResultobject

The validation result

Properties:

Name	Type	Argument	Description
field	Field	<optional>	information of the validated field (not available if result of otris.gadget.gui.Form#setFormValidator)
successful	boolean		whether the validation was successful
errorMessage	string		the error message displayed on failed validation
options	object	<optional>	optional properties

validatorFunction(field, gadgetForm, options){validationResult}

The validator function
The field object contains a single field if this validator function is used by otris.gadget.gui.Element#setValidator
The field object contains multiple fields if this validator function is used by otris.gadget.gui.Form#setFormValidator

Name	Type	Description
field	Field | object	single input field information or object containing mutliple field informations
gadgetForm	GadgetForm	reference to the GadgetForm
options	object	options Name Type Description documentsContext documents.sdk.DocumentsContext reference to the documents.sdk.DocumentsContext

Returns:

Type	Description
validationResult	validation result should be generated via GadgetForm