Page History

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: {
        startIndex: 15,
        size: 5,
        rows: [ { _svyRowId: 'someRowIdHASH1', name: "Bubu", type: 2 },
                { _svyRowId: 'someRowIdHASH2', name: "Ranger", type: 1 },
                { _svyRowId: 'someRowIdHASH3', name: "Yogy", type: 2 },
                { _svyRowId: 'someRowIdHASH4', name: "Birdy", type: 3 },
                { _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 the beginning of the 'viewPort' - asynchronously.
          * @param negativeOrPositiveCount the number of records to extend the viewPort.rows with before or after the current loaded records.
          */
        loadExtraRecordsAsync: function(negativeOrPositiveCount),
 
		/**
          * Sort the foundset by the dataproviders contained in sortColumns. The name property can be filled with the dataprovider name the foundset provides or specifies, or if the foundset is used with a component type (like a portal) then the name is the name of the component name on which the sort should happen on.
          * @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) 
    },

    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
}

"myFoundset": { "type": "foundset", "dynamicDataproviders": true }

myFoundset: {
    (...)
    viewPort: {
        startIndex: 15,
        size: 2,
        rows: [ { _svyRowId: 'someRowIdHASH1', dp1: (...), dp2: (...), dp3: (...) },
                { _svyRowId: 'someRowIdHASH2', dp1: (...), dp2: (...), dp3: (...) } ],
        (...)
    },
    (...)
}

"myFoundset": { "type": "foundset", "dataproviders": ["firstName", "lastName"] }

myFoundset: {
    (...)
    viewPort: {
        startIndex: 15,
        size: 2,
        rows: [ { _svyRowId: 'someRowIdHASH1', firstName: (...), lastName: (...) },
                { _svyRowId: 'someRowIdHASH2', firstName: (...), lastName: (...) } ],
        (...)
    },
    (...)
}

"myFoundset": { "type": "foundset", "dataproviders": ["image", "age"], "provideColumnFormats": true }

myFoundset: {
    (...)
    viewPort: {
        startIndex: 15,
        size: 2,
        rows: [ { _svyRowId: 'someRowIdHASH1', image: (...), age: (...) },
                { _svyRowId: 'someRowIdHASH2', image: (...), age: (...) } ],
        (...)
    },
    columnFormats: {
        image: {
            placeHolder: null,
            maxLength: 2147483647,
            isNumberValidator: false,
            edit: null,
            isMask: false,
            display: null,
            type: "MEDIA",
            allowedCharacters: null
        },

        age: {
            placeHolder: null,
            percent: "%",
            isNumberValidator: false,
            edit: null,
            isMask: false,
            display: "#,#00.###",
            type: "NUMBER",
            allowedCharacters: null
        }
    }
}

"myFoundset": "foundset",
"childElement" : { "type" : "component", "forFoundset": "myFoundset" }

"myFoundset": "foundset",
"childElements" : { "type" : "component[]", "elementConfig" : {"forFoundset": "myFoundset"} }