Ignite UI API Reference

If set to true, the following behavior will take place:
if a new row is added, and then deleted, there will be no transaction added to the log
if an edit is made to a row or cell, then the value is brought back to its original value, the transaction should be removed
Note: This option takes effect only when autoCommit is set to false.

If auto commit is true, data will be automatically commited to the data source, once a value or a batch of values are updated via saveChanges().

Callback function to call when data binding is complete.

Object on which to invoke the callback function.

This is the normalized (transformed) resulting data, after it's fetched from the data source.

Client-side dataBinding event. Can be a string pointing to a function name, or an object pointing to a function.

Client-side dataBound event. Can be a string pointing to a function name, or an object pointing to a function.

This is the source of data - non normalized. Can be an array, can be reference to some JSON object, can be a DOM element for a HTML TABLE, or a function.

A list of field definitions specifying the schema of the data source.
Field objects description: {fieldName, [fieldDataType], [fieldXPath]}.

Settings related to built-in filtering functionality.

• applyToAllData

  Type:

  bool

  Default:

  true

  If the type of paging/sorting/filtering is local and applyToAllData is true, filtering will be performed on the whole data source that's present locally, otherwise only on the current dataView. if type is remote, this setting doesn't have any effect.

• caseSensitive

  Type:

  bool

  Default:

  false

  Enables or disables case sensitive filtering on the data. Works only for local filtering.

• customFunc

  Type:

  object

  Default:

  null

  Can point to either a string or a function object. The parameters that are passed are 1) the data array to be filtered, 2) the filtering expression definitions. Should return an array of the filtered data.

• defaultFields

  Type:

  array

  Default:

  []

  Elements Type:

  object

  Data will be initially filtered accordingly, directly after dataBind().

• expressions

  Type:

  array

  Default:

  []

  Elements Type:

  object

  A list of expression objects, containing the following key-value pairs: fieldName, expression (search string), condition , and logic (AND/OR).

• exprString

  Type:

  string

  Default:

  ""

  An "SQL-like' encoded expressions string. Takes precedence over "expressions". Example: col2 > 100; col2 LIKE %test%.

• filterExprUrlKey

  Type:

  string

  Default:

  null

  Url key that will be encoded in the request if remote filtering is performed. Default value of null implies OData-style URL encoding. Please see http://www.odata.org/developers/protocols/uri-conventions for details.

• filterLogicUrlKey

  Type:

  string

  Default:

  filterlogic

  Url key that will be encoded in the request, specifying if the filtering logic will be AND or OR.

• type

  Type:

  enumeration

  Default:

  remote

  Filtering type.

  Members

  • remote
  • Type:string
  • Parameters will be encoded and it's up to the backend to interpred them from the response.
  • local
  • Type:string
  • The data will be filtered automatically client-side.

Setting this is only necessary when the data source is set to a table in string format. we need to create an invisible dummy data container in the body and append the table data to it.

Override the callback function name in a jsonp request. Sets option jsonp in $.ajax function .

                $(window).load(function () {
				var ds = new $.ig.JSONPDataSource({
                    type: "json",
						dataSource: "http://services.odata.org/OData/OData.svc/Products?$format=json", 
					responseDataKey: "Records",
                        jsonp: "onJSONPLoad=?"
                });
				ds.dataBind();
                     });
              

Specify the callback function name for a JSONP request. Sets option jsonpCallback in $.ajax function .

 
            $(window).load(function () {
                var ds = new $.ig.JSONPDataSource({
                    type: "json",
						dataSource: "http://services.odata.org/OData/OData.svc/Products?$format=json", 
 	                responseDataKey: "Records",
                        jsonpCallback: "myCustomFunction"
	            });
	                ds.dataBind();
                });
          

If set to false will disable transformations on schema, even if it is defined locally in the javascript code.

This is the property in the dataView where actual resulting records will be put. (So the dataView will not be array but an object if this is defined), after the potential data source transformation.

Settings related to built-in paging functionality.

• appendPage

  Type:

  bool

  Default:

  false

  Whether when a new page of data is requested we should append the new data to the existing data.

• enabled

  Type:

  bool

  Default:

  false

  Paging is not enabled by default.

• pageIndex

  Type:

  number

  Default:

  0

  Current page index.

• pageIndexUrlKey

  Type:

  string

  Default:

  null

  Denotes the name of the encoded URL parameter that will state what is the currently requested page index.

• pageSize

  Type:

  number

  Default:

  5

  Number of records on each page.

• pageSizeUrlKey

  Type:

  string

  Default:

  null

  Denotes the name of the encoded URL parameter that will state what is the currently requested page size.

• type

  Type:

  enumeration

  Default:

  remote

  Type for the paging operation .

  Members

  • local
  • Type:string
  • Data is paged client-side.
  • remote
  • Type:string
  • A remote request is done and URL params encoded.

The unique field identifier.

Specifies the HTTP verb to be used to issue the request.

Content type of the response. See http://api.jquery.com/jQuery.ajax/ => contentType.

Property in the response which specifies where the data records array will be held (if the response is wrapped).

Response type when a URL is set as the data source. See http://api.jquery.com/jQuery.ajax/ => dataType .

Property in the response which specifies the total number of records in the backend (this is needed for paging).

A function to call when row is added.
Function takes first argument item and second argument dataSource.
Use item.row to obtain reference to the added row.
Use item.rowId to get the row ID.
Use dataSource to obtain reference to $.ig.DataSource.

A function to call when row is deleted.
Use item.row to obtain reference to the deleted row.
Use item.rowId to get the row ID.
Use item.rowIndex to get the row index.
Use dataSource to obtain reference to $.ig.DataSource.

A function to call when row is inserted.
Function takes first argument item and second argument dataSource.
Use item.row to obtain reference to the inserted row.
Use item.rowId to get the row ID.
Use item.rowIndex to get the row index.
Use dataSource to obtain reference to $.ig.DataSource.

A function to call when row is updated (edited).
Function takes first argument item and second argument dataSource.
Use item.rowIndex to get the row index.
Use item.newRow to obtain reference to the updated row.
Use item.oldRow to obtain reference to the row that was updated.
Use dataSource to obtain reference to $.ig.DataSource.

A schema object that defines which fields from the data to bind to.

If true, will serialize the transaction log of updated values - if any - whenever commit is performed via a remote request.

Settings related to built-in sorting functionality.

• applyToAllData

  Type:

  bool

  Default:

  true

  If the sorting type is local and applyToAllData is true, sorting will be performed on the whole data source that's present locally, otherwise only on the current dataView. If sorting type is remote, this setting doesn't have any effect.

• caseSensitive

  Type:

  bool

  Default:

  false

  Specifies if sorting will be case sensitive or not. Works only for local sorting.

• compareFunc

  Type:

  object

  Default:

  null

  Custom comparison sorting function. Accepts two values and returns a value 0 indicating that values are equal, 1 indicating that val1 > val2 and -1 indicating that val1 < val2.

• customConvertFunc

  Type:

  object

  Default:

  null

  Custom data value conversion function. Accepts a value and should return the converted value.

• customFunc

  Type:

  object

  Default:

  null

  Custom sorting function that can point to either a string or a function object. When the function is called, the following arguments are passed: data array, fields (array of field definitions) , direction ("asc" or "desc"). The function should return a sorted data array.

• defaultDirection

  Type:

  enumeration

  Default:

  none

  Sorting direction .

  Members

  • none
  • Type:string
  • asc
  • Type:string
  • desc
  • Type:string

• defaultFields

  Type:

  array

  Default:

  []

  Elements Type:

  object

  When defaultDirection is different than "none", and defaultFields is specified, data will be initially sorted accordingly, directly after dataBind().

• expressions

  Type:

  array

  Default:

  []

  Elements Type:

  object

  A list of sorting expressions , consisting of the following keys (and their respective values): fieldName and direction.

• exprString

  Type:

  string

  Default:

  ""

  Takes precedence over experssions, an "SQL-like" encoded expressions string : see sort(). Example col2 > 100 ORDER BY asc.

• sortUrlAscValueKey

  Type:

  string

  Default:

  null

  URL param value for ascending type of sorting. Default is null and uses OData conventions.

• sortUrlDescValueKey

  Type:

  string

  Default:

  null

  URL param value for descending type of sorting. Default is null and uses OData conventions.

• sortUrlKey

  Type:

  string

  Default:

  null

  URL param name which specifies how sorting expressions will be encoded in the URL. Default is null and uses OData conventions.

• type

  Type:

  enumeration

  Default:

  remote

  Specifies whether sorting will be applied locally or remotely (via a remote request) .

  Members

  • remote
  • Type:string
  • local
  • Type:string

Settings related to built-in summaries functionality.

• columnSettings

  Type:

  array

  Default:

  []

  Elements Type:

  object

  A list of column settings that specifies custom summaries options per column basis.

• summariesResponseKey

  Type:

  string

  Default:

  summaries

  Key for retrieving data from the summaries response - used only when summaries are remote.

• summaryExecution

  Type:

  enumeration

  Default:

  afterfilteringandpaging

  Determines when the summary values are calculated .

  Members

  • priortofilteringandpaging
  • Type:string
  • afterfilteringbeforepaging
  • Type:string
  • afterfilteringandpaging
  • Type:string

• summaryExprUrlKey

  Type:

  string

  Default:

  summaries

  Url key for retrieving data from response - used only when summaries are remote.

• type

  Type:

  enumeration

  Default:

  remote

  Specifies whether summaries will be applied locally or remotely (via a remote request) .

  Members

  • remote
  • Type:string
  • A remote request is done and URL params encoded.
  • local
  • Type:string
  • Data is paged client-side.

Type of the data source .

Specifies an update remote URL, to which an AJAX request will be made as soon as saveChages() is called.

Event that is fired after URL parameters are encoded (When a remote request is done). Can point to a function name or the function object itself.

Event that is fired before URL parameters are encoded. Can point to a function name or the function object itself.