String color value

#FFFFFF

Reference to a dataprovider, either a record or scope/form variable.

Can become a complex definition if it needs to support onDataChange, it needs to be able to send changes to server or display tags.

The ondatachange handler will receive as parameter the old datarovider value, the new dataprovider value and a JSEvent.

Starting with 2021.06 release the JSEvent.data will contain an object: {dataprovider : dataProviderID, scope : dataproviderScope, scopeid : variable_scope_or_datasource}.

{ 
    "type": "dataprovider",
    "pushToServer": "allow", // optional: needed if you want this component
        // to be able to change the dataprovider's value on the server 
    "ondatachange": { // optional
        "onchange": "onDataChangeMethodID", // the name of a handler
            // defined in spec
        "callback": "onDataChangeCallback" // the name of an API func
            // defined by the webcomponent that will get called when
            // pushed data change is successfully applied on server
    },
    "forFoundset" : "myFoundsetPropertyName", // optional; if specified
        // then on the client instead of one value you will get an
        // array of values one for each record in the viewport of given
        // foundset property (see also 'foundset' property type)
    "displayTagsPropertyName" : "myDisplaysTagsProp", // default is null.
        // If specified then the property will initially read the
        // boolean value of the property with given name; If that
        // property is true, tags (%%x%%) will be replaced, otherwise
        // they will be ignored (in which case it will just replace i18n
        // and html); if null, tags will be replaced or not based on
        // config option "displayTags"
    "displayTags" : false, // default is false. If displayTagsPropertyName
        // is non-null it will be ignored. Otherwise, only if it's value
        // is true, this property will parse tags (%%x%%)
	"resolveValuelist" : false // optional, default value is false
		// this is an optimization for read-only dataproviders
		// if true, the dataprovider will send directly the display value 
		// from linked valuelist instead of real value; valuelist will 
		// have no values sent to client; this way client doesn't need
		// to resolve the valuelist value anymore
}

Starting with 8.4, if 'forFoundset' above is used, then the client-side (in browser) value also provides two methods: addChangeListener / removeChangeListener. So you can add a listener that will receive updates (row insert/delete/change or full viewport update) similar to how the change listener in foundset property type works. Remember to always remove any added change listeners when the component's $scope is destroyed - similar to what is described in the link for the foundset property type listener.

In order for dataprovider typed properties to 'push' their value changes to the server (so changes in the browser to end up in records or scope/form variables) you must either use autoApply or directly apply / startEdit. If you do not 'apply' (auto or manually) the change, the updates will not be sent to server.

Simple example of read-only dataprovider:

{
    "name": "my-component",
    "displayName": ...,
    (...)
    "model":
    {
            "myDataProvider" : "dataprovider",
            (...)
    }, 
    (...)
}

<span ng-bind-html='model.myDataProvider'/>

Simple example of read-write dataprovider (with auto-apply):

{
    "name": "my-component",
    "displayName": ...,
    (...)
    "model":
    {
            "myDataProvider" : {
                   "type" : "dataprovider",
                   "pushToServer" : "allow"
            },
            (...)
    }, 
    (...)
}

<input (...) ng-model="model.myDataProvider" svy-autoapply />

In server-side (solution) scripting, accessing a dataprovider property - for example "elements.myField.myDataprovider" - will yield a string: the dataprovider id (name of variable/column). You can also assign a dataprovider id (string) to that property.

Client side, the value of a dataprovider property depends on the actual value of the dataprovider (column/variable/...) as well as the type of the dataprovider (is it a number in the database, or a blob / string / date etc.).

For primitives dataprovider types, it will be the primitive value. For date dataprovider types, it will be a Date object on client.

For MEDIA typed dataproviders the client-side value depends on the server side value's content:

• if the value is a BLOB / byte array then client-side you will get an object with two keys: { url: ... , contentType: ... } that can be used to load that content in the browser
• if the value is a date, you will get a Date on client
• if the value is a string:
  • if it starts with "media:///" it will be an URL string on the client that points to that server side media resource from the solution
  • other strings will be treated as strings
• primitive types will just be sent 'as-is' to client

JSDataSet type equivalent. Currently can be used only for runtime api or model (to send a dataset to client).

"jsDataSet":{"type" :"dataset", "includeColumnNames": true, 
                                 "columnTypes":{ "icon" : "media" }}

The type can have two configuration properties:

1. includeColumnNames , default false, will also send the column names as a separate array to client as the first row

2. columnTypes can specify some column types which will be used for converting the value to send client side, this is needed for non basic columns/types

Dimension representation

{
	width: 100, 
	height: 20
}

Format string.

Given an object in the .spec file - to be able to specify which dataprovider and/or valuelist property to map this format property on. The 'for' value can be one property name (pointing to a dataprovider-type property or a valuelist property), but it can also contain an array of 2 properties (one being a dataprovider-type property and the other a valuelist property).

It needs the 'for' clause to be able to deduct the type of the format (format depends on DP type, whether or not the valuelist has real/display values or not, ...). If you put a valuelist property in the "for" and that valuelist property has itself a "for" that points to a dataprovider property (that might be linked to a foundset or not) then you must add that same dataprovider property to the "for" clause of the format property as well.

myFormatProp : { type: 'format', for: 'myDataProviderProp' }

myFormatProp : { type: 'format', for: ["myValuelistProp", "myDataProviderProp"] }

Format property access from solution scripting will give the string value of the parsed format .Assignment to a 'format' typed property allows you to set a new format string .

Callback function information that can be called on server from client.
A callback function set for this type of property will be represented in the component model as a pair of "formname" and "script" that can be used as parameters for "$window.executeInlineScript" to execute it.
Example:

in the component spec

	"model": {
		"myFunction" : { "type": "function"}
	},

in the component js implementation we use that executeInlineScript function that is exposed on the window object

$window.executeInlineScript($scope.model.myFunction.formname,
                            $scope.model.myFunction.script, [arg1, arg2]); 

Note that the component need to have reference to the "$window" service, and the "formname" and ''script" values are already encrypted in the model, and you need to use those values, and not plain text values for formname and script. Arguments for the callback can be set using the last parameter of "$window.executeInlineScript"

Padding insets representation

{
	paddingTop: 10px, 
	paddingLeft: 20px,
	paddingBottom : 10px,
	paddingRight: 10px
}

Reference to a Record. You can use this type:

• to send a Record identifier to browser/client code from server that can then be sent back to server later using the same type to become/be translated to the initial Record on server.

• (starting with Servoy 8.3) to send a client/browser 'foundset' property type's row directly to server (using "record" property type for that); it will be translated to the actual Record on server. E.g.:

  $scope.handlers.recordClicked($scope.model .myFoundset.viewPort.rows[idx]);

  
  

• (starting with Servoy 8.3) to send a client/browser 'foundset' property type's row to server using "foundsetProp.getRecordRefByRowID(id)". E.g:

  // if the component uses the rowId internally to identify rows var rowId = $scope.model.myFoundset.viewPort .rows[idx][$foundsetTypeConstants.ROW_ID_COL_KEY]; // (...) // then it can just send a Record ref. to server using that // ID directly without the need to get the actual row $scope.handlers.recordClicked($scope.model.myFoundset .getRecordRefByRowID(rowId));

  See also Foundset property type - Combining Foundset Property Type, Foundset Reference Type, Record type and client-to-server scripting calls if you you are curious about how 'record' type can be used in combination with other types to create complex components.

boolean security property, can be used to protect the entire component or specific properties or handlers in the component. For more information about 'protected' property type see this page.

Configuration:

 "enabled" : { "type": "protected", "blockingOn": false, "default": true }

Point representation

{
	x: 10, 
	y: 20
}

String with space separated CSS classnames.Possible values supported by the component can be specified as hint for the developer

{
	type:'styleclass', 
	values:[
		'btn',
		'btn-default',
		'btn-lg',
		'btn-sm',
		'btn-xs'
	]
}

In Servoy version below 8.3 if you name the property "styleClass" that has the "styleclass" type also element.addStyleClass and element.removeStyleClass will work and will add or remove style classes from that property. With 8.3 this still works but you can mark any styleclass property type to be the "mainStyleClass" by adding the tag 'mainStyleClass' and set the value to true for this property:

{
	"type": "styleclass", 
    "tags": { "mainStyleClass":true}
}

String property that can contain %%tags%%, be an i18n key or <html>. It can also be a simple static string.
Will be pre-processed before being provided to web component depending on configuration options below.

Examples:

Hello %%name%%, welcome to %%i18n:com.mycompany.mykey%% ...
    or
i18n:com.mycompany.mykey
    or
<html>...some html that can also contain JS callbacks and media...</html>
    or
just some static string

Here is how this type of property can be configured in the component's .spec file:

myTextProperty : {
	"type" : "tagstring",
	"displayTagsPropertyName" : "myDisplaysTagsProp", // default is null.
        // If specified then the property will initially read the
        // boolean value of the property with given name; If that
        // property is true, tags (%%x%%) will be replaced, otherwise
        // they will be ignored (in which case it will just replace i18n
        // and html); if null, tags will be replaced or not based on
        // config option "displayTags"
    "displayTags" : false, // default is true. If displayTagsPropertyName
        // is non-null it will be ignored. Otherwise, only if true this
        // property will parse tags (%%x%%)
    "useParsedValueInRhino" : true, // default is false. Server side
        // scripting read/modify will work with: if false the parsed
        // (with tags/i18n already replaced, so static) value, if true
        // the non-parsed (value containing %%x%% or i18n:..., which
        // will be after modify parsed) value
    "forFoundset" : "myFoundsetPropertyName" // optional; if specified
        // then on the client instead of one value you will get an array
        // of values one for each record in the viewport of given
        // foundset property (see also 'foundset' property type)
},
displaysTags : { "type" : "boolean", "scope" : "design" } // needed only
        // if "displayTagsPropertyName" is used as above

or simply (to use default config values):

myTextProperty: "tagstring"

Starting with 8.4, if 'forFoundset' above is used, then the client-side (in browser) value also provides two methods: addChangeListener / removeChangeListener. So you can add a listener that will receive updates (row insert/delete/change or full viewport update) similar to how the change listener in foundset property type works. Remember to always remove any added change listeners when the component's $scope is destroyed - similar to what is described in the link for the foundset property type listener.

clientfunction

String property similar to tagstring, but with support to use as default value the title string form a table column. It has a setting key: "for", that contains the dataprovider property from where the table column would be determined.

Configuration:

 "headerTitle": {"type" : "titlestring", "for": "dp"},
 "dp": { "type": "dataprovider", "forFoundset": "myFoundset", "resolveValuelist" : true}

Reference to a ValueList.

Supported configuration (in .spec file, next to the type of the property)

"lazyLoading": true

"max": 500

"for": "myDPProperty"

forFoundset

"forFoundset": "myFoundset"

Valuelist property access from solution scripting will give the valuelist name. Assignment to a 'valuelist' typed property allows two types of values:

• if you assign a String to it that will be interpreted as a valuelist name - and the valuelist with the given name is put in that property
• if that property already contains a custom valuelist and you assign a Dataset to it then it will alter the items of the custom valuelist for that property of that element only.

For example:

// will output the name of the valuelist that is currently in "myValuelistProp"
application.output(elements.mycomponent.myValuelistProp);

// the following code would change the items of a custom valuelist inside one
// of the columns of a servoy-extra table component
elements.myExtraTable.columns[1].valuelist = databaseManager.convertToDataSet(
    new Array({ d: 'Item 1', r: 1}, { d: 'Item 2', r: 2},
              { d: 'Item 3', r: 3}, { d: 'Item 4', r: 4},
              { d: 'Item 5', r: 5}, { d: 'Item 6', r: 6}), ["d", "r"]);

NOTE: From 2022.09 on the valuelist property type at runtime did change a bit. Now it is more a complex object that has currently 2 properties:

name: to get the current name of the valuelist or to set it and then the valuelist of the given name is put in that property

dataset: this will return the dataset of the current values, or set the current values if it was a CustomValueList.

Client side, the valuelist will be an array of objects (items), each item will have two properties: "realValue" and "displayValue". If Valuelist is defined only having display values, realValue client side will be the same as display value:

$scope.$watch('model.valuelistID', function() {
    var valuelist = $scope.model.valuelistID;
    if (!valuelist || valuelist.length == 0) return;

    hasRealValues = false;
    for (var i = 0; i < .length; i++) {
        var item = valuelist[i];
        if (item.realValue != item.displayValue) {
            hasRealValues = true;
            break;
        }
    }
});

Client side, valuelist also has some API that can be used: filterList and getDisplayValue. Filter list api takes a filter parameter and applies it to valuelist server side, then filtered valuelist will be sent to client (in same property). This is used for typeahead component:

uib-typeahead="value.displayValue |
               formatFilter:model.format.display:model.format.type
               for value in model.valuelistID.filterList($viewValue)"

Get display value API is used to retrieve a display value taking real value as parameter from server. This is needed in cases where valuelist has many items and we don't send all items client side for performance reasons (see max property, also settings server side).

$scope.model.valuelistID.getDisplayValue($scope.model.dataProviderID)
.then(function(displayValue) {
	$scope.value = displayValue;
});

Both functions return a promise that will be resolved when response comes from server, will receive as parameter the new filtered valuelist (beware also valuelist from model will be filtered) respectively the display value.

Fixed values, can have real/display values.

[{"LEFT":2}, {"CENTER":0},{"RIGHT":4}]

[
    'btn',
    'btn-default',
    'btn-lg',
    'btn-sm',
    'btn-xs'
]