a!dataSubset() Function

Creates a value of type DataSubset for defining the source of service-backed records and for use with a!pickerFieldCustom, leaving the data as provided. To apply sorting and paging, use todatasubset().

Syntax

a!dataSubset( startIndex, batchSize, sort, totalCount, data, identifiers )

  • startIndex (Integer): The index of the first item to be returned in the subset.
  • batchSize (Integer): The number of items to be returned in the subset.
  • sort (SortInfo Array): Valid values include null, an empty array of SortInfo, or an array of SortInfo where <SortInfo>.field is the name of a field on the input array elements or "dot" notation for a nested field.
  • totalCount (Integer): The number of items in total.
  • data (Any Type Array): The data to be returned in the subset.
  • identifiers (Any Type Array): A parallel list of unique identifiers for each item in the subset.

Returns

DataSubset

Examples

You can copy and paste these examples into the Expression Rule Designer to see how this works.

1
2
3
4
5
6
7
8
9
10
11
	=a!dataSubset(
       startIndex: 1,
       batchSize: 4,
       sort: a!sortInfo(
         field: "name",
         ascending: true()
       ),
       totalCount: 10,
       data: {"a", "b", "c", "d"},
       identifiers: {1, 2, 3, 4}
    )

returns

	[startIndex=1,
	 batchSize=4,
	 sort=[field=name, ascending=true],
	 totalCount=10,
	 data=a; b; c; d,
	 identifiers=1; 2; 3; 4]

See Also

DataSubset: This is the type a!dataSubset returns.

FEEDBACK