RealGrid2 API
Interface
DataFillOptions

DataFillOptions

Configuration model for data retrieval

Signature:

export interface DataFillOptions

Remarks

Used in fill-related methods such as LocalDataProvider.fillJsonData(), LocalTreeDataProvider.fillJsonData().

Just input the desired information and set it up.

Properties

PropertyTypeDescription
childrenFieldstringOnly TreeProvider can be used, children field
countnumberdata rows to import
delimiterstringseparator
fillModeDataFillModeHow to fill data
fillPosnumberLine starting when fillMode is 'insert' or 'update'
iconFieldstringIcon field name
needSortingbooleanSort or not
noStatesbooleanWhether to not set state on generated data rows
parentIdnumberUnique number of parent row
quotedbooleanWhether each cell data is surrounded by a double-quotation mark("")
rootArraybooleanWhether the top level of the data source is Array
rowsstring

Row data type

The name of the row element or array element among the data. Can only be used in json and xml.

startnumberActual data starting row excluding headers, etc. from data
treeFieldstringtree field name

Properties Desc

childrenField

Only TreeProvider can be used, children field

Type - string


count

rows of data to import

Type - number

Remarks:

If -1, the whole is retrieved.


limiter

Separator

Type - string

Remarks:

Used only in CSV cases


fillMode

Data Population Method

Type - DataFillMode


fillPos

Line that starts when fillMode is 'insert' or 'update'

Type - number


iconField

Icon Field Name

Type - string

Remarks:

Only TreeProvider can be used.

It can also be specified as an attribute called icon.


needSorting

Sort or not

Type - boolean

Remarks:

Only TreeProvider can be used.

It can also be specified as a property called sorting.


noStates

Whether to not set state on generated data rows

Type - boolean


parentId

Unique number of parent row

Type - number

Remarks:

Only TreeProvider can be used.

It can also be specified as a property called parent.


quoted

Whether each cell data is wrapped with a double-quotation mark("")

Type - boolean

Remarks:

Used only in CSV cases


rootArray

Whether the top level of the data source is Array

Type - boolean

Remarks:

Used only for json


rows

data type of row

The name of a row element or array element among data. Can only be used in json and xml.

Type - string


start

Actual data starting row excluding headers, etc.

Type - number

Remarks:


treeField

tree field name

Type - string

Remarks:

Only TreeProvider can be used.

It can also be specified as an attribute called tree.