Child pages
  • ServoyApi

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Cache
indextrue
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListNGClient

servoy sSummary12%30%58%height: 30px;3Methods SummaryAdd a filter parameter that is permanent per user session to limit a specified foundset of records.Can be used to deep copy a custom value.Performs a sql query with a query builder object.This will generate a list of primary keys names for the given data source.This will generate a url from a byte array so that the client can get the bytes from that url.Get select query for dataSourceHide a form directly on the server for instance when a tab will change on the client, so it won't need to do a round trip for hiding the form through the browser's component.

functionservoy sDetail2100%height:30px2Methods DetailsaddFoundSetFilterParamname

addFoundSetFilterParam(foundset, query, filterName)

dessIndent
Add a filter parameter that is permanent per user session to limit a specified foundset of records.
This is similar as calling foundset.js_addFoundSetFilterParam, but the main difference is that this
works also on related foundsets.
prs

Parameters

sIndentfoundsetThe foundset to add the filter param/query toqueryThe query repesenting the filterfilterNamea name given to this foundset filter
ret

Returns

sIndent
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRowcopyObjectname

copyObject(value)

dessIndent
Can be used to deep copy a custom value.
prs

Parameters

sIndentvaluethe value to be copied
ret

Returns

sIndent a copy of the value object, the same as constructing the object in javascript from scratch
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
getDataSetByQueryname

getDataSetByQuery(query, max_returned_rows)

dessIndent
Performs a sql query with a query builder object.
Will throw an exception if anything did go wrong when executing the query.
Will use any data filter defined on table.
prs

Parameters

sIndentqueryQBSelect query.max_returned_rowsThe maximum number of rows returned by the query.
ret

Returns

sIndent The JSDataSet containing the results of the query.
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
getDatasourcePKsname

getDatasourcePKs(datasource)

dessIndent
This will generate a list of primary keys names for the given data source.
prs

Parameters

sIndentdatasourcethe data source
ret

Returns

sIndent a list of primary key names
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
getMediaUrlname

getMediaUrl(bytes)

dessIndent
This will generate a url from a byte array so that the client can get the bytes from that url.
prs

Parameters

sIndentbytesThe value where an url should be created for
ret

Returns

sIndent the url where the bytes can be downloaded from
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
getQuerySelectname

getQuerySelect(dataSource)

dessIndent
Get select query for dataSource
prs

Parameters

sIndentdataSourcethe dataSource
ret

Returns

sIndent QB select for the dataSource
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
getViewFoundSetname

getViewFoundSet(name, query)

dessIndentprs

Parameters

sIndentname ;query ;
ret

Returns

sIndent
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
hideFormname

hideForm(formName)

dessIndent
Hide a form directly on the server for instance when a tab will change on the client, so it won't need to do a round trip
for hiding the form through the browser's component.
prs

Parameters

sIndentformNamethe form to hide
ret

Returns

sIndent true if the form was hidden
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow