Child pages
  • Foundset property type

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagejs
titleBrowser side provided property content in model
myFoundset: {
    serverSize: 44, // the size of the foundset on server (so not necessarily the total record count in case of large DB tables)
     // this is the data you need to have loaded on client (just request what you need via provided loadRecordsAsync or loadExtraRecordsAsync)
    viewPort: {
    serverSize    startIndex: 4415,
// the size of the foundset on server (so not necessarily the total record count in case of large DB tables)
    // this is the data you need to have loaded on client (just request what you need via provided loadRecordsAsync or loadExtraRecordsAsync)
    viewPort: {
        startIndex: 15,
  size: 5,
        rows: [ { _svyRowId: 'someRowIdHASH1', name: "Bubu", type: 2 },
                { _svyRowId: 'someRowIdHASH2', name: "Ranger", type: 1 },
     size: 5,         rows: [ { _svyRowId: 'someRowIdHASH1someRowIdHASH3', name: "BubuYogy", type: 2 },
                { _svyRowId: 'someRowIdHASH2someRowIdHASH4', name: "RangerBirdy", type: 13 },
                { _svyRowId: 'someRowIdHASH3someRowIdHASH5', name: "YogyWolfy", type: 24 }, ]
    },
    selectedRowIndexes: [16], // array of selected {records _svyRowId: 'someRowIdHASH4', name: "Birdy", type: 3 },
   in foundset; indexes can be out of current viewPort as well
    multiSelect: false, // the multiselect mode of the { _svyRowId: 'someRowIdHASH5', name: "Wolfy", type: 4 } ]
    },
	/** Request a change of viewport bounds from the server; the requested data will be loaded asynchronously in 'viewPort'
    * @param startIndex the index that you request the first record in "viewPort.rows" to have in the real foundset (so the beginning of the viewPort).
    * @param size the number of records to load in viewPort.
    */
    loadRecordsAsync: function(startIndex, size),
    /** Request more records for your viewPort; if the argument is positive more records will be loaded at the end of the 'viewPort', when negative more records will be loaded at server's foundset; if this is false, selectedRowIndexes can only have one item in it
    columnFormats: { name: (...), type: (...) }, // columnFormats is only present if you specify "provideColumnFormats": true inside the .spec file for this foundset property; it gives the default column formatting that Servoy would normally use for each column of the viewport - which you can then also use in the browser yourself

	/** Request a change of viewport bounds from the server; the requested data will be loaded asynchronously in 'viewPort'
    * @param startIndex the index that you request the first record in "viewPort.rows" to have in the real foundset (so the beginning of the 'viewPort' - asynchronously).
    * @param negativeOrPositiveCountsize the number of records to extendload thein viewPort.rows
with before or after the current loaded records.
    * */
    loadExtraRecordsAsyncloadRecordsAsync: function(negativeOrPositiveCountstartIndex, size),

 	   /** Request more records for *your SortviewPort; theif foundset by the dataprovidersargument containedis inpositive sortColumns.more Therecords name propertywill can be filledloaded withat the dataproviderend nameof the foundset provides or specifies, or if'viewPort', when negative more records will be loaded at the foundsetbeginning isof usedthe with'viewPort' a- componentasynchronously.
type (like a portal) then* the@param name isnegativeOrPositiveCount the namenumber of therecords componentto name onextend which the sortviewPort.rows shouldwith happenbefore on.or after the current loaded *records.
  @param {JSONArray} sortColumns*/
an array of JSONObjects {name:dataprovider, direction:sortDirection},loadExtraRecordsAsync: function(negativeOrPositiveCount),
 
	/**
    * Sort the foundset by the dataproviders contained in sortColumns. The name property can be filled with the dataprovider name where the sortDirectionfoundset canprovides be "asc"or specifies, or "desc".if the foundset is used */
	sort: function(sortColumns),
 
	/**
    * Request a selection change with a component type (like a portal) then the name is the name of the selectedcomponent rowname indexes.on Returnswhich athe promisesort thatshould ishappen resolvedon.
when the client receives the* updated selection from the server. If successful, the array selectedRowIndexes will also be updated. If the server does not allow the selection change, the reject function will get called with the 'old' selection as parameter. 
	* If requestSelectionUpdate is called a second time, before the first call is resolved, the first call will be rejected and the caller will receive the string 'canceled' as the value for the parameter serverRows.
	* E.g.: foundset.requestSelectionUpdate([2,3,4]).then(function(serverRows){},function(serverRows){});
	*/
	requestSelectionUpdate : function(selectedRowIdxs),
 
    /**
    * sets the preferred viewport size on the server for this foundset, so that the next (initial) load
    * will give back that viewport. Use this when the component resizes itself and doesn't know initially 
    * what it can show before hand.
    */
    setPreferredViewportSize: function(size),
    selectedRowIndexes: [16], // array of selected records in foundset; indexes can be out of current viewPort as well
    multiSelect: false, // the multiselect mode of the server's foundset; if this is false, selectedRowIndexes can only have one item in it
    columnFormats: { name: (...), type: (...) } // columnFormats is only present if you specify "provideColumnFormats": true inside the .spec file for this foundset property; it gives the default column formatting that Servoy would normally use for each column of the viewport - which you can then also use in the browser yourself@param {JSONArray} sortColumns an array of JSONObjects {name:dataprovider, direction:sortDirection},
    *                    where the sortDirection can be "asc" or "desc".
    */
	sort: function(sortColumns),
 
	/**
    * Request a selection change of the selected row indexes. Returns a promise that is resolved when the client receives the updated selection from the server. If successful, the array selectedRowIndexes will also be updated. If the server does not allow the selection change, the reject function will get called with the 'old' selection as parameter. 
	* If requestSelectionUpdate is called a second time, before the first call is resolved, the first call will be rejected and the caller will receive the string 'canceled' as the value for the parameter serverRows.
	* E.g.: foundset.requestSelectionUpdate([2,3,4]).then(function(serverRows){},function(serverRows){});
	*/
	requestSelectionUpdate : function(selectedRowIdxs),
 
    /**
    * sets the preferred viewport size on the server for this foundset, so that the next (initial) load
    * will give back that viewport. Use this when the component resizes itself and doesn't know initially 
    * what it can show before hand.
    */
    setPreferredViewportSize: function(size)

}

 

  • serverSize is controlled by the server; you should not change it

  • viewPort initially has size 0, and startIndex 0. When the component detects that records are available (serverSize > 0) it care request viewPort contents using one of the two load async methods
    • viewPort.startIndex and viewPort.size will have the values requested by the async load methods. But if for example you are using data at the end of the foundset and records are deleted from there then viewport.size will be corrected/decreased from server (as there aren't enough records). A similar thing can happen to viewPort.startIndex. Do not modify these directly as that will have no effect. Use the load async methods instead.
    • viewPort.rows contains the viewPort data. Each item of the array represents data from a server-side record. Each item will always contain a "_svyRowId" ($foundsetTypeConstants.ROW_ID_COL_KEY in angular world) entry that uniquely identifies the record on server. Then there's one entry for every dataprovider that the component needs to use (how those are selected is described below). You should never change the "_svyRowId" entry, but it is possible to change the values of any of the other entries - the new values will be pushed back into the server side record that they belong to.
  • selectedRowIndexes is an array of selected foundset record indexes. This can get updated by the server if foundset selection changes server side. You can change the contents of this array to change foundset selection (new selection will be pushed to server). However, the preferred way of changing the record selection is by using "requestSelectionUpdate".
  • multiselect represents the foundset multiselect state; do not change it as it will not be pushed to server.
  • columnFormats represents the default column formats for the columns given in the viewport; do not change this - only server pushes this information to the client if asked to do so by the .spec file. It is only present if you specify "provideColumnFormats": true inside the .spec file for this foundset property.

...