Type | Description |
---|
boolean | Boolean value, either true or false |
border | CSS border string representation |
byte | A number, 8 bit unsigned |
color | String color value |
dataprovider | 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. Code Block |
---|
| {
"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%%)
} |
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. Info |
---|
| In order to be able to change server-side dataprovider values using apply or svy-autoapply, the .spec file must declare that dataprovider property from the model as pushToServer: allow or higher. Otherwise the server will reject the dataprovider value updates and log a change denied warning. |
Simple example of read-only dataprovider: Code Block |
---|
| {
"name": "my-component",
"displayName": ...,
(...)
"model":
{
"myDataProvider" : "dataprovider",
(...)
},
(...)
} |
Code Block |
---|
| <span ng-bind-html='model.myDataProvider'/> |
Simple example of read-write dataprovider (with auto-apply): Code Block |
---|
| {
"name": "my-component",
"displayName": ...,
(...)
"model":
{
"myDataProvider" : {
"type" : "dataprovider",
"pushToServer" : "allow"
},
(...)
},
(...)
} |
Code Block |
---|
| <input (...) ng-model="model.myDataProvider" svy-autoapply /> |
|
dataset | JSDataSet type equivalent. Currently can be used only for runtime api or model (to send a dataset to client). Code Block |
---|
| "jsDataSet":{"type" :"dataset", "includeColumnNames": true,
"columnTypes":{ "icon" : "media" }} |
The type cam 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 |
date | Date value |
dimension | Dimension representation Code Block |
---|
| {
width: 100,
height: 20
} |
|
double | A floating point number |
float | A floating point number |
font | CSS font string |
form | URL string pointing to a form (like tab in tabpanel) |
format | 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. Code Block |
---|
| myFormatProp : { type: 'format', for: 'myDataProviderProp' } |
Code Block |
---|
| 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. |
function | 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 Code Block |
---|
"model": {
"myFunction" : { "type": "function"}
}, |
in the component js implementation Code Block |
---|
$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" |
int | An integer number |
insets | Padding insets representation Code Block |
---|
| {
paddingTop: 10px,
paddingLeft: 20px,
paddingBottom : 10px,
paddingRight: 10px
} |
|
labelfor | Type for labelfor property of the label. |
long | A number, size is twice an integer |
media | Reference to a Media entry. Media can be specified in different ways (media name, media uuid, media url - for example "media:///servoy.jpg" -, media id). |
relation | Reference to a Relation (this is a string, so if used as a api parameter, this would just mean the relation name) |
runtimecomponent | The type of component (so that components can be passed as parameters) |
protected | 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: setting | description | example |
---|
for | list of properties to protect, when not specified the entire component is protected | "for": ["streetname", "updateInfoFunc"] | blockingOn | when the property is set to this value, protection is active, default: true | "blockingOn": true |
Code Block |
---|
| "enabled" : { "type": "protected", "blockingOn": false, "default": true } |
|
point | Point representation Code Block |
---|
| {
x: 10,
y: 20
} |
|
object | Generic type. When using this type, you should pass primitive types or object of primitive types because conversions are not available for more complex types. You use the specific type whenever possible instead of this generic type. This relies on JSON to transfer, so for example Dates should be send as the number value (the times in milis) instead of trying to send the Date as a date object itself. |
scrollbars | An integer value which represents scrollbar definition. This type is used for designer to display special editor. |
short | A number, 16 bit |
string | Plain string property. I18n keys will be resolved by default. |
styleclass | String with space separated CSS classnames.Possible values supported by the component can be specified as hint for the developer Code Block |
---|
title | Example specifying special classnames supported by the component as hint for the developer |
---|
| {
type:'styleclass',
values:[
'btn',
'btn-default',
'btn-lg',
'btn-sm',
'btn-xs'
]
} |
|
tabseq | Tab sequence integer value. See sablo-tabseq |
tagstring | 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: Code Block |
---|
| 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: Code Block |
---|
| 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): Code Block |
---|
| myTextProperty: "tagstring" |
|
valuelist | Reference to a ValueList. Configuration (.spec file) setting | description | example |
---|
lazyLoading | Added in 8.2 : Setting for Global Method Valuelists only (does not affect any other type of valuelist); it helps not load values on initial display (if not needed), but only when they are really needed. "Lazy loading" must be set on the Valuelist - in the Valuelist Editor as well, otherwise it has no effect. Default and bootstrap typeahead components have this configuration set to true (default is false). | "lazyLoading" : true | max | Allows limiting the number of items the valuelist will send to the browser. | "max":500 | for | Allows you to provide a dataprovider-type property name (that this valuelist property will use to determine for example the type of the data - this is needed for some types of valuelist like custom valuelist) | for: "myDPProperty" |
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 only.
For example: Code Block |
---|
| // 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"]); |
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 Code Block |
---|
| $scope.$watch('model.valuelistID', function() {
if (!$scope.model.valuelistID || $scope.model.valuelistID.length == 0) return;
hasRealValues = false;
for (var i = 0; i < $scope.model.valuelistID.length; i++) {
var item = $scope.model.valuelistID[i];
if (item.realValue != item.displayValue) {
hasRealValues = true;
break;
}
}
}); |
|
visible | boolean security property, when set to false the component is protected from client data changes and function calls, data changes from the server are not sent to the client. For more information about 'visible' property type see this page. setting | description | example |
---|
for | list of properties to protect, when not specified the entire component is protected | "for": ["streetname", "updateInfoFunc"] |
|
foundset | Used to interact with server-side foundset from the browser. See Foundset property type. |
foundsetRef | Can be used to send a 'reference' to a server side foundset to the server. If server-side scripting returns/sets a foundset to such a type, browser side scripting will receive an unique id/reference to that foundset. Browser side scripting can then send that id back to server-side scripting and it will automatically be transformed into the original foundset object by this property type. See Foundset property type - Combining Foundset Property Type, Foundset Reference Type, Record Finder type and client-to-server scripting calls for and example of how it can be used. |
rowRef | Also known as "Record Finder type". Can be used to send a rowId (from a foundset type property's viewport) from browser scripting to server side scripting. The property type will return a 'finder' function. When you call that function with the foundset as an argument it will return the record that corresponds to that rowId from the client. See Foundset property type - Combining Foundset Property Type, Foundset Reference Type, Record Finder type and client-to-server scripting calls for and example of how it can be used. |