From 53ec5bb80cd65c696a721937218e08dc93f0645e Mon Sep 17 00:00:00 2001 From: dkamburov Date: Wed, 27 Sep 2017 01:58:36 +0300 Subject: [PATCH] Update Ignite UI typings, adding some missing event properties (#19934) --- types/ignite-ui/index.d.ts | 5569 ++++++++++++++++++------------------ 1 file changed, 2781 insertions(+), 2788 deletions(-) diff --git a/types/ignite-ui/index.d.ts b/types/ignite-ui/index.d.ts index 97a84af16b..2341f1bd9f 100644 --- a/types/ignite-ui/index.d.ts +++ b/types/ignite-ui/index.d.ts @@ -577,7 +577,7 @@ class DataSource { /** * Sets a list of fields to the data source. If no parameter is specified, just returns the already existing list of fields * - * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } + * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } */ fields(fields?: Object): Object; @@ -614,36 +614,36 @@ class DataSource { /** * Gets/sets the schema definition. * - * @param s a schema object - * @param t type of the data source. See settings.type + * @param s a schema object + * @param t type of the data source. See settings.type */ schema(s?: Object, t?: string): void; /** * Gets/sets a list of paging settings * - * @param p object holding all paging settings. See settings.paging + * @param p object holding all paging settings. See settings.paging */ pagingSettings(p?: Object): Object; /** * Gets/sets a list of filtering settings * - * @param f object holding all filtering settings. See settings.filtering + * @param f object holding all filtering settings. See settings.filtering */ filterSettings(f?: Object): void; /** * Gets/sets a list of paging settings * - * @param s object holding all sorting settings. See settings.sorting + * @param s object holding all sorting settings. See settings.sorting */ sortSettings(s?: Object): Object; /** * Gets/sets a list of summaries settings. * - * @param s object holding all summaries settings. See settings.summaries + * @param s object holding all summaries settings. See settings.summaries */ summariesSettings(s?: Object): void; @@ -665,16 +665,16 @@ class DataSource { /** * Returns a record by a specified key (requires that primaryKey is set in the settings) * - * @param key Primary key of the record - * @param ds the data source in which to search for the record. When not set it will use the current data source. - * @param objPath Not used in $.ig.DataSource + * @param key Primary key of the record + * @param ds the data source in which to search for the record. When not set it will use the current data source. + * @param objPath Not used in $.ig.DataSource */ findRecordByKey(key: string, ds?: string, objPath?: string): Object; /** * Removes a specific record denoted by the primaryKey of the passed key parameter from the data source * - * @param key primary key of the record + * @param key primary key of the record * @param origDs */ removeRecordByKey(key: Object, origDs: Object): void; @@ -682,7 +682,7 @@ class DataSource { /** * Removes a record from the data source at specific index. * - * @param index index of record + * @param index index of record * @param origDs */ removeRecordByIndex(index: number, origDs: Object): void; @@ -690,82 +690,82 @@ class DataSource { /** * Sets a cell value for the cell denoted by rowId and colId. Creates a transaction for the update operation and returns it * - * @param rowId the rowId - row key (string) or index (number) - * @param colId the column id - column key (string) or index (number) - * @param val The new value - * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the rowId - row key (string) or index (number) + * @param colId the column id - column key (string) or index (number) + * @param val The new value + * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log */ setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; /** * Updates a record in the datasource. Creates a transaction that can be committed / rolled back * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log */ updateRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; /** * Adds a new row to the data source. Creates a transaction that can be committed / rolled back * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log */ addRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; /** * Adds a new row to the data source. Creates a transaction that can be committed / rolled back * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param rowIndex row index at which to insert the new row - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - * @param parentRowId Not used in $.ig.DataSource + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param rowIndex row index at which to insert the new row + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param parentRowId Not used in $.ig.DataSource */ insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: Object): Object; /** * Deletes a row from the data source. * - * @param rowId the record key - primaryKey (string) or index (number) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the record key - primaryKey (string) or index (number) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log */ deleteRow(rowId: Object, autoCommit: boolean): Object; /** * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back * - * @param data the transaction data + * @param data the transaction data */ addNode(data: Object): void; /** * Removes a node from the tree data source. Creates a transaction that can be committed / rolled back * - * @param data the transaction data + * @param data the transaction data */ removeNode(data: Object): void; /** * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source * - * @param t a transaction object + * @param t a transaction object */ getDetachedRecord(t: Object): Object; /** * Update the data source with every transaction from the log * - * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. + * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. */ commit(id?: number): void; /** * Clears the transaction log without updating anything in the data source * - * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. + * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. */ rollback(id?: Object): void; @@ -787,8 +787,8 @@ class DataSource { /** * Posts to the settings.updateUrl using $.ajax, by serializing the changes as url params * - * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) - * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) + * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) + * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) */ saveChanges(success: Function, error: Function): void; @@ -809,16 +809,16 @@ class DataSource { * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView * 6. fire the databound event * - * @param callback callback function - * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context + * @param callback callback function + * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context */ dataBind(callback?: string, callee?: Object): void; /** * Gets a cell value from the record by the specified fieldName. If there's a mapper defined for the field, the resolved by the mapper value will be returned. * - * @param fieldName the fieldName - name of the field - * @param record the record from which to get it + * @param fieldName the fieldName - name of the field + * @param record the record from which to get it */ getCellValue(fieldName: string, record: Object): Object; @@ -828,8 +828,8 @@ class DataSource { * If key or dsObj are not set then returns summaries data. * Takes summary data from passed argument dsObj(using argument key) * - * @param key response key to take summary data(for example "Metadata.Summaries") - * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) + * @param key response key to take summary data(for example "Metadata.Summaries") + * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) */ summariesResponse(key?: string, dsObj?: Object): Object; @@ -846,8 +846,8 @@ class DataSource { * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] * - * @param fields an array of fields object definitions - * @param direction asc / desc direction + * @param fields an array of fields object definitions + * @param direction asc / desc direction */ sort(fields: Object, direction: string): void; @@ -859,8 +859,8 @@ class DataSource { /** * Filters the data source locally by text. If "fields" parameter is set search is performed only in the listed fields otherwise all fields are searched. * - * @param expression a text to search for. Multiple search texts should be separated by space. When multiple search texts are provided all of them should be presented in the search fields (bool logic "and" is applied). - * @param fields an array of fields that will be searched. + * @param expression a text to search for. Multiple search texts should be separated by space. When multiple search texts are provided all of them should be presented in the search fields (bool logic "and" is applied). + * @param fields an array of fields that will be searched. */ filterByText(expression: string, fields?: any[]): void; @@ -874,26 +874,14 @@ class DataSource { * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain * if expr is detected to be a regular expression, the "cond" part is skipped * To [filter by text](ig.datasource#methods:filterByText) "fieldExpressions" should have only one object with the following schema: + * {filterAllFields: , expr: , fields: } * - * @param fieldExpressions {filterAllFields: , expr: , fields: } - * - * ``` - * ds = new $.%%WidgetName%%({ - * type: "json", - * dataSource: adventureWorks, - * schema: jsonSchema - * }); - * ds.dataBind(); - * ds.filter([{fieldName : "Color", expr: "Red", cond: "Equals"}], "AND", true); - * // Filter by text - * ds.filter([{filterAllFields: true, expr: "abc", fields: [name: "Description", type: "string"]}]); - * ``` - * - * @param boolLogic a list of field expression definitions - * @param keepFilterState boolean logic. Accepted values are AND and OR. - * @param fieldExpressionsOnStrings a list of field expression definitions (or a string with the conditions separated by AND/OR operator, example: "ID = 1 OR ID = 2"), which when applied will threat the related field as if it's string and can only apply conditions valid for string types. + * @param fieldExpressions a list of field expression definitions + * @param boolLogic boolean logic. Accepted values are AND and OR. + * @param keepFilterState if keepFilterState is set to true, it will not discard previous filtering expressions + * @param fieldExpressionsOnStrings a list of field expression definitions (or a string with the conditions separated by AND/OR operator, example: "ID = 1 OR ID = 2"), which when applied will threat the related field as if it's string and can only apply conditions valid for string types. */ - filter(fieldExpressions: any[], boolLogic: Object, keepFilterState: Object, fieldExpressionsOnStrings: Object): void; + filter(fieldExpressions: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; /** * This clears local filtering applied to the data view by resetting it to the original data and applying any paging @@ -907,7 +895,7 @@ class DataSource { * the actual total number of records may not * match the number of records that exists on the client * - * @param count the total number of records + * @param count the total number of records * @param key * @param dsObj * @param context @@ -917,14 +905,14 @@ class DataSource { /** * Gets / sets if the response from the server contains a property which specifies the total number of records in the server-side backend * - * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend + * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend */ hasTotalRecordsCount(hasCount: boolean): void; /** * Returns metadata object for the specified key * - * @param key Primary key of the record + * @param key Primary key of the record */ metadata(key: string): Object; @@ -941,14 +929,14 @@ class DataSource { /** * Gets /sets the current page index. If an index is passed as a parameter, the data source is re-bound. * - * @param index the page index. If none is specified, returns the current page index. + * @param index the page index. If none is specified, returns the current page index. */ pageIndex(index?: number): number; /** * Gets /sets the page index that should be persisted. For now ONLY when filtering is applied and call explicitly DataBind. * - * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. + * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. */ persistedPageIndex(value?: number): number; @@ -965,7 +953,7 @@ class DataSource { /** * Gets /sets the page size and rebinds the data source if a parameter is specified. If no parameter is passed, returns the current page size * - * @param s the page size. + * @param s the page size. */ pageSize(s?: number): number; @@ -979,28 +967,28 @@ class DataSource { /** * Returns a list of records for the specified page. Implies that paging is enabled. * - * @param p the page index for which records will be returned + * @param p the page index for which records will be returned */ recordsForPage(p: number): void; /** * Converts a HTML TABLE dom element to a JavaScript array of objects that contain the records data * - * @param tableDOM TABLE dom element to transform + * @param tableDOM TABLE dom element to transform */ tableToObject(tableDOM: Element): Object; /** * Parses the string and returns an evaluated JSON object * - * @param s the JSON as string. + * @param s the JSON as string. */ stringToJSONObject(s: string): void; /** * Parses a string and returns a XML Document * - * @param s the XML represented as a string + * @param s the XML represented as a string */ stringToXmlObject(s: string): void; @@ -1022,22 +1010,22 @@ class DataSource { /** * Toggle grouped record with the specified id and updates collections visible groupby data and data view * - * @param id data-id attribute of the respective group row in the DOM - * @param collapsed if true the record should be collapsed, otherwise expanded + * @param id data-id attribute of the respective group row in the DOM + * @param collapsed if true the record should be collapsed, otherwise expanded */ toggleGroupByRecord(id: string, collapsed: boolean): void; /** * Check whether the specified gorupby record is collapsed * - * @param gbRec id of the grouped record OR grouped record + * @param gbRec id of the grouped record OR grouped record */ isGroupByRecordCollapsed(gbRec: Object): boolean; /** * Check whether grouping is applied for the specified sorting expressions. * - * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings + * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings */ isGroupByApplied(exprs?: any[]): boolean; } @@ -1131,21 +1119,21 @@ class DataSchema { /** * Performs a transformation on the schema so that the resulting data matches the schema * - * @param data the data to transform + * @param data the data to transform */ transform(data: Object): Object; /** * Specifies if the object is null, undefined, or an empty string * - * @param o the object to check for being empty + * @param o the object to check for being empty */ isEmpty(o: Object): Object; /** * Specifies if the object has custom properties or not * - * @param obj the object to check for presence or lack of custom properties + * @param obj the object to check for presence or lack of custom properties */ isObjEmpty(obj: Object): Object; @@ -1167,7 +1155,7 @@ class RemoteDataSource { /** * Sets a list of fields to the data source. If no parameter is specified, just returns the already existing list of fields * - * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } + * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } */ fields(fields?: Object): Object; @@ -1204,36 +1192,36 @@ class RemoteDataSource { /** * Gets/sets the schema definition. * - * @param s a schema object - * @param t type of the data source. See settings.type + * @param s a schema object + * @param t type of the data source. See settings.type */ schema(s?: Object, t?: string): void; /** * Gets/sets a list of paging settings * - * @param p object holding all paging settings. See settings.paging + * @param p object holding all paging settings. See settings.paging */ pagingSettings(p?: Object): Object; /** * Gets/sets a list of filtering settings * - * @param f object holding all filtering settings. See settings.filtering + * @param f object holding all filtering settings. See settings.filtering */ filterSettings(f?: Object): void; /** * Gets/sets a list of paging settings * - * @param s object holding all sorting settings. See settings.sorting + * @param s object holding all sorting settings. See settings.sorting */ sortSettings(s?: Object): Object; /** * Gets/sets a list of summaries settings. * - * @param s object holding all summaries settings. See settings.summaries + * @param s object holding all summaries settings. See settings.summaries */ summariesSettings(s?: Object): void; @@ -1255,16 +1243,16 @@ class RemoteDataSource { /** * Returns a record by a specified key (requires that primaryKey is set in the settings) * - * @param key Primary key of the record - * @param ds the data source in which to search for the record. When not set it will use the current data source. - * @param objPath Not used in $.ig.DataSource + * @param key Primary key of the record + * @param ds the data source in which to search for the record. When not set it will use the current data source. + * @param objPath Not used in $.ig.DataSource */ findRecordByKey(key: string, ds?: string, objPath?: string): Object; /** * Removes a specific record denoted by the primaryKey of the passed key parameter from the data source * - * @param key primary key of the record + * @param key primary key of the record * @param origDs */ removeRecordByKey(key: Object, origDs: Object): void; @@ -1272,7 +1260,7 @@ class RemoteDataSource { /** * Removes a record from the data source at specific index. * - * @param index index of record + * @param index index of record * @param origDs */ removeRecordByIndex(index: number, origDs: Object): void; @@ -1280,82 +1268,82 @@ class RemoteDataSource { /** * Sets a cell value for the cell denoted by rowId and colId. Creates a transaction for the update operation and returns it * - * @param rowId the rowId - row key (string) or index (number) - * @param colId the column id - column key (string) or index (number) - * @param val The new value - * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the rowId - row key (string) or index (number) + * @param colId the column id - column key (string) or index (number) + * @param val The new value + * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log */ setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; /** * Updates a record in the datasource. Creates a transaction that can be committed / rolled back * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log */ updateRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; /** * Adds a new row to the data source. Creates a transaction that can be committed / rolled back * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log */ addRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; /** * Adds a new row to the data source. Creates a transaction that can be committed / rolled back * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param rowIndex row index at which to insert the new row - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - * @param parentRowId Not used in $.ig.DataSource + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param rowIndex row index at which to insert the new row + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param parentRowId Not used in $.ig.DataSource */ insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: Object): Object; /** * Deletes a row from the data source. * - * @param rowId the record key - primaryKey (string) or index (number) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the record key - primaryKey (string) or index (number) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log */ deleteRow(rowId: Object, autoCommit: boolean): Object; /** * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back * - * @param data the transaction data + * @param data the transaction data */ addNode(data: Object): void; /** * Removes a node from the tree data source. Creates a transaction that can be committed / rolled back * - * @param data the transaction data + * @param data the transaction data */ removeNode(data: Object): void; /** * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source * - * @param t a transaction object + * @param t a transaction object */ getDetachedRecord(t: Object): Object; /** * Update the data source with every transaction from the log * - * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. + * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. */ commit(id?: number): void; /** * Clears the transaction log without updating anything in the data source * - * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. + * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. */ rollback(id?: Object): void; @@ -1377,8 +1365,8 @@ class RemoteDataSource { /** * Posts to the settings.updateUrl using $.ajax, by serializing the changes as url params * - * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) - * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) + * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) + * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) */ saveChanges(success: Function, error: Function): void; @@ -1399,16 +1387,16 @@ class RemoteDataSource { * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView * 6. fire the databound event * - * @param callback callback function - * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context + * @param callback callback function + * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context */ dataBind(callback?: string, callee?: Object): void; /** * Gets a cell value from the record by the specified fieldName. If there's a mapper defined for the field, the resolved by the mapper value will be returned. * - * @param fieldName the fieldName - name of the field - * @param record the record from which to get it + * @param fieldName the fieldName - name of the field + * @param record the record from which to get it */ getCellValue(fieldName: string, record: Object): Object; @@ -1418,8 +1406,8 @@ class RemoteDataSource { * If key or dsObj are not set then returns summaries data. * Takes summary data from passed argument dsObj(using argument key) * - * @param key response key to take summary data(for example "Metadata.Summaries") - * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) + * @param key response key to take summary data(for example "Metadata.Summaries") + * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) */ summariesResponse(key?: string, dsObj?: Object): Object; @@ -1436,8 +1424,8 @@ class RemoteDataSource { * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] * - * @param fields an array of fields object definitions - * @param direction asc / desc direction + * @param fields an array of fields object definitions + * @param direction asc / desc direction */ sort(fields: Object, direction: string): void; @@ -1449,8 +1437,8 @@ class RemoteDataSource { /** * Filters the data source locally by text. If "fields" parameter is set search is performed only in the listed fields otherwise all fields are searched. * - * @param expression a text to search for. Multiple search texts should be separated by space. When multiple search texts are provided all of them should be presented in the search fields (bool logic "and" is applied). - * @param fields an array of fields that will be searched. + * @param expression a text to search for. Multiple search texts should be separated by space. When multiple search texts are provided all of them should be presented in the search fields (bool logic "and" is applied). + * @param fields an array of fields that will be searched. */ filterByText(expression: string, fields?: any[]): void; @@ -1464,28 +1452,14 @@ class RemoteDataSource { * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain * if expr is detected to be a regular expression, the "cond" part is skipped * To [filter by text](ig.datasource#methods:filterByText) "fieldExpressions" should have only one object with the following schema: + * {filterAllFields: , expr: , fields: } * - * @param fieldExpressions {filterAllFields: , expr: , fields: } - * - * ``` - * ds = new $.%%WidgetName%%({ - * type: "json", - * dataSource: adventureWorks, - * schema: jsonSchema - * }); - * ds.dataBind(); - * - * ds.filter([{fieldName : "Color", expr: "Red", cond: "Equals"}], "AND", true); - * - * // Filter by text - * ds.filter([{filterAllFields: true, expr: "abc", fields: [name: "Description", type: "string"]}]); - * ``` - * - * @param boolLogic a list of field expression definitions - * @param keepFilterState boolean logic. Accepted values are AND and OR. - * @param fieldExpressionsOnStrings a list of field expression definitions (or a string with the conditions separated by AND/OR operator, example: "ID = 1 OR ID = 2"), which when applied will threat the related field as if it's string and can only apply conditions valid for string types. + * @param fieldExpressions a list of field expression definitions + * @param boolLogic boolean logic. Accepted values are AND and OR. + * @param keepFilterState if keepFilterState is set to true, it will not discard previous filtering expressions + * @param fieldExpressionsOnStrings a list of field expression definitions (or a string with the conditions separated by AND/OR operator, example: "ID = 1 OR ID = 2"), which when applied will threat the related field as if it's string and can only apply conditions valid for string types. */ - filter(fieldExpressions: any[], boolLogic: Object, keepFilterState: Object, fieldExpressionsOnStrings: Object): void; + filter(fieldExpressions: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; /** * This clears local filtering applied to the data view by resetting it to the original data and applying any paging @@ -1499,7 +1473,7 @@ class RemoteDataSource { * the actual total number of records may not * match the number of records that exists on the client * - * @param count the total number of records + * @param count the total number of records * @param key * @param dsObj * @param context @@ -1509,14 +1483,14 @@ class RemoteDataSource { /** * Gets / sets if the response from the server contains a property which specifies the total number of records in the server-side backend * - * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend + * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend */ hasTotalRecordsCount(hasCount: boolean): void; /** * Returns metadata object for the specified key * - * @param key Primary key of the record + * @param key Primary key of the record */ metadata(key: string): Object; @@ -1533,14 +1507,14 @@ class RemoteDataSource { /** * Gets /sets the current page index. If an index is passed as a parameter, the data source is re-bound. * - * @param index the page index. If none is specified, returns the current page index. + * @param index the page index. If none is specified, returns the current page index. */ pageIndex(index?: number): number; /** * Gets /sets the page index that should be persisted. For now ONLY when filtering is applied and call explicitly DataBind. * - * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. + * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. */ persistedPageIndex(value?: number): number; @@ -1557,7 +1531,7 @@ class RemoteDataSource { /** * Gets /sets the page size and rebinds the data source if a parameter is specified. If no parameter is passed, returns the current page size * - * @param s the page size. + * @param s the page size. */ pageSize(s?: number): number; @@ -1571,28 +1545,28 @@ class RemoteDataSource { /** * Returns a list of records for the specified page. Implies that paging is enabled. * - * @param p the page index for which records will be returned + * @param p the page index for which records will be returned */ recordsForPage(p: number): void; /** * Converts a HTML TABLE dom element to a JavaScript array of objects that contain the records data * - * @param tableDOM TABLE dom element to transform + * @param tableDOM TABLE dom element to transform */ tableToObject(tableDOM: Element): Object; /** * Parses the string and returns an evaluated JSON object * - * @param s the JSON as string. + * @param s the JSON as string. */ stringToJSONObject(s: string): void; /** * Parses a string and returns a XML Document * - * @param s the XML represented as a string + * @param s the XML represented as a string */ stringToXmlObject(s: string): void; @@ -1614,22 +1588,22 @@ class RemoteDataSource { /** * Toggle grouped record with the specified id and updates collections visible groupby data and data view * - * @param id data-id attribute of the respective group row in the DOM - * @param collapsed if true the record should be collapsed, otherwise expanded + * @param id data-id attribute of the respective group row in the DOM + * @param collapsed if true the record should be collapsed, otherwise expanded */ toggleGroupByRecord(id: string, collapsed: boolean): void; /** * Check whether the specified gorupby record is collapsed * - * @param gbRec id of the grouped record OR grouped record + * @param gbRec id of the grouped record OR grouped record */ isGroupByRecordCollapsed(gbRec: Object): boolean; /** * Check whether grouping is applied for the specified sorting expressions. * - * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings + * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings */ isGroupByApplied(exprs?: any[]): boolean; } @@ -1657,7 +1631,7 @@ class JSONDataSource { /** * Sets a list of fields to the data source. If no parameter is specified, just returns the already existing list of fields * - * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } + * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } */ fields(fields?: Object): Object; @@ -1694,36 +1668,36 @@ class JSONDataSource { /** * Gets/sets the schema definition. * - * @param s a schema object - * @param t type of the data source. See settings.type + * @param s a schema object + * @param t type of the data source. See settings.type */ schema(s?: Object, t?: string): void; /** * Gets/sets a list of paging settings * - * @param p object holding all paging settings. See settings.paging + * @param p object holding all paging settings. See settings.paging */ pagingSettings(p?: Object): Object; /** * Gets/sets a list of filtering settings * - * @param f object holding all filtering settings. See settings.filtering + * @param f object holding all filtering settings. See settings.filtering */ filterSettings(f?: Object): void; /** * Gets/sets a list of paging settings * - * @param s object holding all sorting settings. See settings.sorting + * @param s object holding all sorting settings. See settings.sorting */ sortSettings(s?: Object): Object; /** * Gets/sets a list of summaries settings. * - * @param s object holding all summaries settings. See settings.summaries + * @param s object holding all summaries settings. See settings.summaries */ summariesSettings(s?: Object): void; @@ -1745,16 +1719,16 @@ class JSONDataSource { /** * Returns a record by a specified key (requires that primaryKey is set in the settings) * - * @param key Primary key of the record - * @param ds the data source in which to search for the record. When not set it will use the current data source. - * @param objPath Not used in $.ig.DataSource + * @param key Primary key of the record + * @param ds the data source in which to search for the record. When not set it will use the current data source. + * @param objPath Not used in $.ig.DataSource */ findRecordByKey(key: string, ds?: string, objPath?: string): Object; /** * Removes a specific record denoted by the primaryKey of the passed key parameter from the data source * - * @param key primary key of the record + * @param key primary key of the record * @param origDs */ removeRecordByKey(key: Object, origDs: Object): void; @@ -1762,7 +1736,7 @@ class JSONDataSource { /** * Removes a record from the data source at specific index. * - * @param index index of record + * @param index index of record * @param origDs */ removeRecordByIndex(index: number, origDs: Object): void; @@ -1770,82 +1744,82 @@ class JSONDataSource { /** * Sets a cell value for the cell denoted by rowId and colId. Creates a transaction for the update operation and returns it * - * @param rowId the rowId - row key (string) or index (number) - * @param colId the column id - column key (string) or index (number) - * @param val The new value - * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the rowId - row key (string) or index (number) + * @param colId the column id - column key (string) or index (number) + * @param val The new value + * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log */ setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; /** * Updates a record in the datasource. Creates a transaction that can be committed / rolled back * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log */ updateRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; /** * Adds a new row to the data source. Creates a transaction that can be committed / rolled back * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log */ addRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; /** * Adds a new row to the data source. Creates a transaction that can be committed / rolled back * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param rowIndex row index at which to insert the new row - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - * @param parentRowId Not used in $.ig.DataSource + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param rowIndex row index at which to insert the new row + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param parentRowId Not used in $.ig.DataSource */ insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: Object): Object; /** * Deletes a row from the data source. * - * @param rowId the record key - primaryKey (string) or index (number) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the record key - primaryKey (string) or index (number) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log */ deleteRow(rowId: Object, autoCommit: boolean): Object; /** * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back * - * @param data the transaction data + * @param data the transaction data */ addNode(data: Object): void; /** * Removes a node from the tree data source. Creates a transaction that can be committed / rolled back * - * @param data the transaction data + * @param data the transaction data */ removeNode(data: Object): void; /** * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source * - * @param t a transaction object + * @param t a transaction object */ getDetachedRecord(t: Object): Object; /** * Update the data source with every transaction from the log * - * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. + * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. */ commit(id?: number): void; /** * Clears the transaction log without updating anything in the data source * - * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. + * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. */ rollback(id?: Object): void; @@ -1867,8 +1841,8 @@ class JSONDataSource { /** * Posts to the settings.updateUrl using $.ajax, by serializing the changes as url params * - * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) - * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) + * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) + * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) */ saveChanges(success: Function, error: Function): void; @@ -1889,16 +1863,16 @@ class JSONDataSource { * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView * 6. fire the databound event * - * @param callback callback function - * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context + * @param callback callback function + * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context */ dataBind(callback?: string, callee?: Object): void; /** * Gets a cell value from the record by the specified fieldName. If there's a mapper defined for the field, the resolved by the mapper value will be returned. * - * @param fieldName the fieldName - name of the field - * @param record the record from which to get it + * @param fieldName the fieldName - name of the field + * @param record the record from which to get it */ getCellValue(fieldName: string, record: Object): Object; @@ -1908,8 +1882,8 @@ class JSONDataSource { * If key or dsObj are not set then returns summaries data. * Takes summary data from passed argument dsObj(using argument key) * - * @param key response key to take summary data(for example "Metadata.Summaries") - * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) + * @param key response key to take summary data(for example "Metadata.Summaries") + * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) */ summariesResponse(key?: string, dsObj?: Object): Object; @@ -1926,8 +1900,8 @@ class JSONDataSource { * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] * - * @param fields an array of fields object definitions - * @param direction asc / desc direction + * @param fields an array of fields object definitions + * @param direction asc / desc direction */ sort(fields: Object, direction: string): void; @@ -1939,8 +1913,8 @@ class JSONDataSource { /** * Filters the data source locally by text. If "fields" parameter is set search is performed only in the listed fields otherwise all fields are searched. * - * @param expression a text to search for. Multiple search texts should be separated by space. When multiple search texts are provided all of them should be presented in the search fields (bool logic "and" is applied). - * @param fields an array of fields that will be searched. + * @param expression a text to search for. Multiple search texts should be separated by space. When multiple search texts are provided all of them should be presented in the search fields (bool logic "and" is applied). + * @param fields an array of fields that will be searched. */ filterByText(expression: string, fields?: any[]): void; @@ -1954,28 +1928,14 @@ class JSONDataSource { * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain * if expr is detected to be a regular expression, the "cond" part is skipped * To [filter by text](ig.datasource#methods:filterByText) "fieldExpressions" should have only one object with the following schema: + * {filterAllFields: , expr: , fields: } * - * @param fieldExpressions {filterAllFields: , expr: , fields: } - * - * ``` - * ds = new $.%%WidgetName%%({ - * type: "json", - * dataSource: adventureWorks, - * schema: jsonSchema - * }); - * ds.dataBind(); - * - * ds.filter([{fieldName : "Color", expr: "Red", cond: "Equals"}], "AND", true); - * - * // Filter by text - * ds.filter([{filterAllFields: true, expr: "abc", fields: [name: "Description", type: "string"]}]); - * ``` - * - * @param boolLogic a list of field expression definitions - * @param keepFilterState boolean logic. Accepted values are AND and OR. - * @param fieldExpressionsOnStrings a list of field expression definitions (or a string with the conditions separated by AND/OR operator, example: "ID = 1 OR ID = 2"), which when applied will threat the related field as if it's string and can only apply conditions valid for string types. + * @param fieldExpressions a list of field expression definitions + * @param boolLogic boolean logic. Accepted values are AND and OR. + * @param keepFilterState if keepFilterState is set to true, it will not discard previous filtering expressions + * @param fieldExpressionsOnStrings a list of field expression definitions (or a string with the conditions separated by AND/OR operator, example: "ID = 1 OR ID = 2"), which when applied will threat the related field as if it's string and can only apply conditions valid for string types. */ - filter(fieldExpressions: any[], boolLogic: Object, keepFilterState: Object, fieldExpressionsOnStrings: Object): void; + filter(fieldExpressions: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; /** * This clears local filtering applied to the data view by resetting it to the original data and applying any paging @@ -1989,7 +1949,7 @@ class JSONDataSource { * the actual total number of records may not * match the number of records that exists on the client * - * @param count the total number of records + * @param count the total number of records * @param key * @param dsObj * @param context @@ -1999,14 +1959,14 @@ class JSONDataSource { /** * Gets / sets if the response from the server contains a property which specifies the total number of records in the server-side backend * - * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend + * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend */ hasTotalRecordsCount(hasCount: boolean): void; /** * Returns metadata object for the specified key * - * @param key Primary key of the record + * @param key Primary key of the record */ metadata(key: string): Object; @@ -2023,14 +1983,14 @@ class JSONDataSource { /** * Gets /sets the current page index. If an index is passed as a parameter, the data source is re-bound. * - * @param index the page index. If none is specified, returns the current page index. + * @param index the page index. If none is specified, returns the current page index. */ pageIndex(index?: number): number; /** * Gets /sets the page index that should be persisted. For now ONLY when filtering is applied and call explicitly DataBind. * - * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. + * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. */ persistedPageIndex(value?: number): number; @@ -2047,7 +2007,7 @@ class JSONDataSource { /** * Gets /sets the page size and rebinds the data source if a parameter is specified. If no parameter is passed, returns the current page size * - * @param s the page size. + * @param s the page size. */ pageSize(s?: number): number; @@ -2061,28 +2021,28 @@ class JSONDataSource { /** * Returns a list of records for the specified page. Implies that paging is enabled. * - * @param p the page index for which records will be returned + * @param p the page index for which records will be returned */ recordsForPage(p: number): void; /** * Converts a HTML TABLE dom element to a JavaScript array of objects that contain the records data * - * @param tableDOM TABLE dom element to transform + * @param tableDOM TABLE dom element to transform */ tableToObject(tableDOM: Element): Object; /** * Parses the string and returns an evaluated JSON object * - * @param s the JSON as string. + * @param s the JSON as string. */ stringToJSONObject(s: string): void; /** * Parses a string and returns a XML Document * - * @param s the XML represented as a string + * @param s the XML represented as a string */ stringToXmlObject(s: string): void; @@ -2104,22 +2064,22 @@ class JSONDataSource { /** * Toggle grouped record with the specified id and updates collections visible groupby data and data view * - * @param id data-id attribute of the respective group row in the DOM - * @param collapsed if true the record should be collapsed, otherwise expanded + * @param id data-id attribute of the respective group row in the DOM + * @param collapsed if true the record should be collapsed, otherwise expanded */ toggleGroupByRecord(id: string, collapsed: boolean): void; /** * Check whether the specified gorupby record is collapsed * - * @param gbRec id of the grouped record OR grouped record + * @param gbRec id of the grouped record OR grouped record */ isGroupByRecordCollapsed(gbRec: Object): boolean; /** * Check whether grouping is applied for the specified sorting expressions. * - * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings + * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings */ isGroupByApplied(exprs?: any[]): boolean; } @@ -2258,7 +2218,7 @@ class RESTDataSource { /** * Sets a list of fields to the data source. If no parameter is specified, just returns the already existing list of fields * - * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } + * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } */ fields(fields?: Object): Object; @@ -2295,36 +2255,36 @@ class RESTDataSource { /** * Gets/sets the schema definition. * - * @param s a schema object - * @param t type of the data source. See settings.type + * @param s a schema object + * @param t type of the data source. See settings.type */ schema(s?: Object, t?: string): void; /** * Gets/sets a list of paging settings * - * @param p object holding all paging settings. See settings.paging + * @param p object holding all paging settings. See settings.paging */ pagingSettings(p?: Object): Object; /** * Gets/sets a list of filtering settings * - * @param f object holding all filtering settings. See settings.filtering + * @param f object holding all filtering settings. See settings.filtering */ filterSettings(f?: Object): void; /** * Gets/sets a list of paging settings * - * @param s object holding all sorting settings. See settings.sorting + * @param s object holding all sorting settings. See settings.sorting */ sortSettings(s?: Object): Object; /** * Gets/sets a list of summaries settings. * - * @param s object holding all summaries settings. See settings.summaries + * @param s object holding all summaries settings. See settings.summaries */ summariesSettings(s?: Object): void; @@ -2346,16 +2306,16 @@ class RESTDataSource { /** * Returns a record by a specified key (requires that primaryKey is set in the settings) * - * @param key Primary key of the record - * @param ds the data source in which to search for the record. When not set it will use the current data source. - * @param objPath Not used in $.ig.DataSource + * @param key Primary key of the record + * @param ds the data source in which to search for the record. When not set it will use the current data source. + * @param objPath Not used in $.ig.DataSource */ findRecordByKey(key: string, ds?: string, objPath?: string): Object; /** * Removes a specific record denoted by the primaryKey of the passed key parameter from the data source * - * @param key primary key of the record + * @param key primary key of the record * @param origDs */ removeRecordByKey(key: Object, origDs: Object): void; @@ -2363,7 +2323,7 @@ class RESTDataSource { /** * Removes a record from the data source at specific index. * - * @param index index of record + * @param index index of record * @param origDs */ removeRecordByIndex(index: number, origDs: Object): void; @@ -2371,82 +2331,82 @@ class RESTDataSource { /** * Sets a cell value for the cell denoted by rowId and colId. Creates a transaction for the update operation and returns it * - * @param rowId the rowId - row key (string) or index (number) - * @param colId the column id - column key (string) or index (number) - * @param val The new value - * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the rowId - row key (string) or index (number) + * @param colId the column id - column key (string) or index (number) + * @param val The new value + * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log */ setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; /** * Updates a record in the datasource. Creates a transaction that can be committed / rolled back * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log */ updateRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; /** * Adds a new row to the data source. Creates a transaction that can be committed / rolled back * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log */ addRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; /** * Adds a new row to the data source. Creates a transaction that can be committed / rolled back * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param rowIndex row index at which to insert the new row - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - * @param parentRowId Not used in $.ig.DataSource + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param rowIndex row index at which to insert the new row + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param parentRowId Not used in $.ig.DataSource */ insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: Object): Object; /** * Deletes a row from the data source. * - * @param rowId the record key - primaryKey (string) or index (number) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the record key - primaryKey (string) or index (number) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log */ deleteRow(rowId: Object, autoCommit: boolean): Object; /** * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back * - * @param data the transaction data + * @param data the transaction data */ addNode(data: Object): void; /** * Removes a node from the tree data source. Creates a transaction that can be committed / rolled back * - * @param data the transaction data + * @param data the transaction data */ removeNode(data: Object): void; /** * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source * - * @param t a transaction object + * @param t a transaction object */ getDetachedRecord(t: Object): Object; /** * Update the data source with every transaction from the log * - * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. + * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. */ commit(id?: number): void; /** * Clears the transaction log without updating anything in the data source * - * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. + * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. */ rollback(id?: Object): void; @@ -2482,16 +2442,16 @@ class RESTDataSource { * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView * 6. fire the databound event * - * @param callback callback function - * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context + * @param callback callback function + * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context */ dataBind(callback?: string, callee?: Object): void; /** * Gets a cell value from the record by the specified fieldName. If there's a mapper defined for the field, the resolved by the mapper value will be returned. * - * @param fieldName the fieldName - name of the field - * @param record the record from which to get it + * @param fieldName the fieldName - name of the field + * @param record the record from which to get it */ getCellValue(fieldName: string, record: Object): Object; @@ -2501,8 +2461,8 @@ class RESTDataSource { * If key or dsObj are not set then returns summaries data. * Takes summary data from passed argument dsObj(using argument key) * - * @param key response key to take summary data(for example "Metadata.Summaries") - * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) + * @param key response key to take summary data(for example "Metadata.Summaries") + * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) */ summariesResponse(key?: string, dsObj?: Object): Object; @@ -2519,8 +2479,8 @@ class RESTDataSource { * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] * - * @param fields an array of fields object definitions - * @param direction asc / desc direction + * @param fields an array of fields object definitions + * @param direction asc / desc direction */ sort(fields: Object, direction: string): void; @@ -2532,8 +2492,8 @@ class RESTDataSource { /** * Filters the data source locally by text. If "fields" parameter is set search is performed only in the listed fields otherwise all fields are searched. * - * @param expression a text to search for. Multiple search texts should be separated by space. When multiple search texts are provided all of them should be presented in the search fields (bool logic "and" is applied). - * @param fields an array of fields that will be searched. + * @param expression a text to search for. Multiple search texts should be separated by space. When multiple search texts are provided all of them should be presented in the search fields (bool logic "and" is applied). + * @param fields an array of fields that will be searched. */ filterByText(expression: string, fields?: any[]): void; @@ -2547,28 +2507,14 @@ class RESTDataSource { * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain * if expr is detected to be a regular expression, the "cond" part is skipped * To [filter by text](ig.datasource#methods:filterByText) "fieldExpressions" should have only one object with the following schema: + * {filterAllFields: , expr: , fields: } * - * @param fieldExpressions {filterAllFields: , expr: , fields: } - * - * ``` - * ds = new $.%%WidgetName%%({ - * type: "json", - * dataSource: adventureWorks, - * schema: jsonSchema - * }); - * ds.dataBind(); - * - * ds.filter([{fieldName : "Color", expr: "Red", cond: "Equals"}], "AND", true); - * - * // Filter by text - * ds.filter([{filterAllFields: true, expr: "abc", fields: [name: "Description", type: "string"]}]); - * ``` - * - * @param boolLogic a list of field expression definitions - * @param keepFilterState boolean logic. Accepted values are AND and OR. - * @param fieldExpressionsOnStrings a list of field expression definitions (or a string with the conditions separated by AND/OR operator, example: "ID = 1 OR ID = 2"), which when applied will threat the related field as if it's string and can only apply conditions valid for string types. + * @param fieldExpressions a list of field expression definitions + * @param boolLogic boolean logic. Accepted values are AND and OR. + * @param keepFilterState if keepFilterState is set to true, it will not discard previous filtering expressions + * @param fieldExpressionsOnStrings a list of field expression definitions (or a string with the conditions separated by AND/OR operator, example: "ID = 1 OR ID = 2"), which when applied will threat the related field as if it's string and can only apply conditions valid for string types. */ - filter(fieldExpressions: any[], boolLogic: Object, keepFilterState: Object, fieldExpressionsOnStrings: Object): void; + filter(fieldExpressions: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; /** * This clears local filtering applied to the data view by resetting it to the original data and applying any paging @@ -2582,7 +2528,7 @@ class RESTDataSource { * the actual total number of records may not * match the number of records that exists on the client * - * @param count the total number of records + * @param count the total number of records * @param key * @param dsObj * @param context @@ -2592,14 +2538,14 @@ class RESTDataSource { /** * Gets / sets if the response from the server contains a property which specifies the total number of records in the server-side backend * - * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend + * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend */ hasTotalRecordsCount(hasCount: boolean): void; /** * Returns metadata object for the specified key * - * @param key Primary key of the record + * @param key Primary key of the record */ metadata(key: string): Object; @@ -2616,14 +2562,14 @@ class RESTDataSource { /** * Gets /sets the current page index. If an index is passed as a parameter, the data source is re-bound. * - * @param index the page index. If none is specified, returns the current page index. + * @param index the page index. If none is specified, returns the current page index. */ pageIndex(index?: number): number; /** * Gets /sets the page index that should be persisted. For now ONLY when filtering is applied and call explicitly DataBind. * - * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. + * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. */ persistedPageIndex(value?: number): number; @@ -2640,7 +2586,7 @@ class RESTDataSource { /** * Gets /sets the page size and rebinds the data source if a parameter is specified. If no parameter is passed, returns the current page size * - * @param s the page size. + * @param s the page size. */ pageSize(s?: number): number; @@ -2654,28 +2600,28 @@ class RESTDataSource { /** * Returns a list of records for the specified page. Implies that paging is enabled. * - * @param p the page index for which records will be returned + * @param p the page index for which records will be returned */ recordsForPage(p: number): void; /** * Converts a HTML TABLE dom element to a JavaScript array of objects that contain the records data * - * @param tableDOM TABLE dom element to transform + * @param tableDOM TABLE dom element to transform */ tableToObject(tableDOM: Element): Object; /** * Parses the string and returns an evaluated JSON object * - * @param s the JSON as string. + * @param s the JSON as string. */ stringToJSONObject(s: string): void; /** * Parses a string and returns a XML Document * - * @param s the XML represented as a string + * @param s the XML represented as a string */ stringToXmlObject(s: string): void; @@ -2697,22 +2643,22 @@ class RESTDataSource { /** * Toggle grouped record with the specified id and updates collections visible groupby data and data view * - * @param id data-id attribute of the respective group row in the DOM - * @param collapsed if true the record should be collapsed, otherwise expanded + * @param id data-id attribute of the respective group row in the DOM + * @param collapsed if true the record should be collapsed, otherwise expanded */ toggleGroupByRecord(id: string, collapsed: boolean): void; /** * Check whether the specified gorupby record is collapsed * - * @param gbRec id of the grouped record OR grouped record + * @param gbRec id of the grouped record OR grouped record */ isGroupByRecordCollapsed(gbRec: Object): boolean; /** * Check whether grouping is applied for the specified sorting expressions. * - * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings + * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings */ isGroupByApplied(exprs?: any[]): boolean; } @@ -2751,7 +2697,7 @@ class JSONPDataSource { /** * Sets a list of fields to the data source. If no parameter is specified, just returns the already existing list of fields * - * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } + * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } */ fields(fields?: Object): Object; @@ -2788,36 +2734,36 @@ class JSONPDataSource { /** * Gets/sets the schema definition. * - * @param s a schema object - * @param t type of the data source. See settings.type + * @param s a schema object + * @param t type of the data source. See settings.type */ schema(s?: Object, t?: string): void; /** * Gets/sets a list of paging settings * - * @param p object holding all paging settings. See settings.paging + * @param p object holding all paging settings. See settings.paging */ pagingSettings(p?: Object): Object; /** * Gets/sets a list of filtering settings * - * @param f object holding all filtering settings. See settings.filtering + * @param f object holding all filtering settings. See settings.filtering */ filterSettings(f?: Object): void; /** * Gets/sets a list of paging settings * - * @param s object holding all sorting settings. See settings.sorting + * @param s object holding all sorting settings. See settings.sorting */ sortSettings(s?: Object): Object; /** * Gets/sets a list of summaries settings. * - * @param s object holding all summaries settings. See settings.summaries + * @param s object holding all summaries settings. See settings.summaries */ summariesSettings(s?: Object): void; @@ -2839,16 +2785,16 @@ class JSONPDataSource { /** * Returns a record by a specified key (requires that primaryKey is set in the settings) * - * @param key Primary key of the record - * @param ds the data source in which to search for the record. When not set it will use the current data source. - * @param objPath Not used in $.ig.DataSource + * @param key Primary key of the record + * @param ds the data source in which to search for the record. When not set it will use the current data source. + * @param objPath Not used in $.ig.DataSource */ findRecordByKey(key: string, ds?: string, objPath?: string): Object; /** * Removes a specific record denoted by the primaryKey of the passed key parameter from the data source * - * @param key primary key of the record + * @param key primary key of the record * @param origDs */ removeRecordByKey(key: Object, origDs: Object): void; @@ -2856,7 +2802,7 @@ class JSONPDataSource { /** * Removes a record from the data source at specific index. * - * @param index index of record + * @param index index of record * @param origDs */ removeRecordByIndex(index: number, origDs: Object): void; @@ -2864,82 +2810,82 @@ class JSONPDataSource { /** * Sets a cell value for the cell denoted by rowId and colId. Creates a transaction for the update operation and returns it * - * @param rowId the rowId - row key (string) or index (number) - * @param colId the column id - column key (string) or index (number) - * @param val The new value - * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the rowId - row key (string) or index (number) + * @param colId the column id - column key (string) or index (number) + * @param val The new value + * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log */ setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; /** * Updates a record in the datasource. Creates a transaction that can be committed / rolled back * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log */ updateRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; /** * Adds a new row to the data source. Creates a transaction that can be committed / rolled back * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log */ addRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; /** * Adds a new row to the data source. Creates a transaction that can be committed / rolled back * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param rowIndex row index at which to insert the new row - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - * @param parentRowId Not used in $.ig.DataSource + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param rowIndex row index at which to insert the new row + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param parentRowId Not used in $.ig.DataSource */ insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: Object): Object; /** * Deletes a row from the data source. * - * @param rowId the record key - primaryKey (string) or index (number) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the record key - primaryKey (string) or index (number) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log */ deleteRow(rowId: Object, autoCommit: boolean): Object; /** * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back * - * @param data the transaction data + * @param data the transaction data */ addNode(data: Object): void; /** * Removes a node from the tree data source. Creates a transaction that can be committed / rolled back * - * @param data the transaction data + * @param data the transaction data */ removeNode(data: Object): void; /** * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source * - * @param t a transaction object + * @param t a transaction object */ getDetachedRecord(t: Object): Object; /** * Update the data source with every transaction from the log * - * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. + * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. */ commit(id?: number): void; /** * Clears the transaction log without updating anything in the data source * - * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. + * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. */ rollback(id?: Object): void; @@ -2961,8 +2907,8 @@ class JSONPDataSource { /** * Posts to the settings.updateUrl using $.ajax, by serializing the changes as url params * - * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) - * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) + * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) + * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) */ saveChanges(success: Function, error: Function): void; @@ -2983,16 +2929,16 @@ class JSONPDataSource { * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView * 6. fire the databound event * - * @param callback callback function - * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context + * @param callback callback function + * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context */ dataBind(callback?: string, callee?: Object): void; /** * Gets a cell value from the record by the specified fieldName. If there's a mapper defined for the field, the resolved by the mapper value will be returned. * - * @param fieldName the fieldName - name of the field - * @param record the record from which to get it + * @param fieldName the fieldName - name of the field + * @param record the record from which to get it */ getCellValue(fieldName: string, record: Object): Object; @@ -3002,8 +2948,8 @@ class JSONPDataSource { * If key or dsObj are not set then returns summaries data. * Takes summary data from passed argument dsObj(using argument key) * - * @param key response key to take summary data(for example "Metadata.Summaries") - * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) + * @param key response key to take summary data(for example "Metadata.Summaries") + * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) */ summariesResponse(key?: string, dsObj?: Object): Object; @@ -3020,8 +2966,8 @@ class JSONPDataSource { * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] * - * @param fields an array of fields object definitions - * @param direction asc / desc direction + * @param fields an array of fields object definitions + * @param direction asc / desc direction */ sort(fields: Object, direction: string): void; @@ -3033,8 +2979,8 @@ class JSONPDataSource { /** * Filters the data source locally by text. If "fields" parameter is set search is performed only in the listed fields otherwise all fields are searched. * - * @param expression a text to search for. Multiple search texts should be separated by space. When multiple search texts are provided all of them should be presented in the search fields (bool logic "and" is applied). - * @param fields an array of fields that will be searched. + * @param expression a text to search for. Multiple search texts should be separated by space. When multiple search texts are provided all of them should be presented in the search fields (bool logic "and" is applied). + * @param fields an array of fields that will be searched. */ filterByText(expression: string, fields?: any[]): void; @@ -3048,28 +2994,14 @@ class JSONPDataSource { * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain * if expr is detected to be a regular expression, the "cond" part is skipped * To [filter by text](ig.datasource#methods:filterByText) "fieldExpressions" should have only one object with the following schema: + * {filterAllFields: , expr: , fields: } * - * @param fieldExpressions {filterAllFields: , expr: , fields: } - * - * ``` - * ds = new $.%%WidgetName%%({ - * type: "json", - * dataSource: adventureWorks, - * schema: jsonSchema - * }); - * ds.dataBind(); - * - * ds.filter([{fieldName : "Color", expr: "Red", cond: "Equals"}], "AND", true); - * - * // Filter by text - * ds.filter([{filterAllFields: true, expr: "abc", fields: [name: "Description", type: "string"]}]); - * ``` - * - * @param boolLogic a list of field expression definitions - * @param keepFilterState boolean logic. Accepted values are AND and OR. - * @param fieldExpressionsOnStrings a list of field expression definitions (or a string with the conditions separated by AND/OR operator, example: "ID = 1 OR ID = 2"), which when applied will threat the related field as if it's string and can only apply conditions valid for string types. + * @param fieldExpressions a list of field expression definitions + * @param boolLogic boolean logic. Accepted values are AND and OR. + * @param keepFilterState if keepFilterState is set to true, it will not discard previous filtering expressions + * @param fieldExpressionsOnStrings a list of field expression definitions (or a string with the conditions separated by AND/OR operator, example: "ID = 1 OR ID = 2"), which when applied will threat the related field as if it's string and can only apply conditions valid for string types. */ - filter(fieldExpressions: any[], boolLogic: Object, keepFilterState: Object, fieldExpressionsOnStrings: Object): void; + filter(fieldExpressions: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; /** * This clears local filtering applied to the data view by resetting it to the original data and applying any paging @@ -3083,7 +3015,7 @@ class JSONPDataSource { * the actual total number of records may not * match the number of records that exists on the client * - * @param count the total number of records + * @param count the total number of records * @param key * @param dsObj * @param context @@ -3093,14 +3025,14 @@ class JSONPDataSource { /** * Gets / sets if the response from the server contains a property which specifies the total number of records in the server-side backend * - * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend + * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend */ hasTotalRecordsCount(hasCount: boolean): void; /** * Returns metadata object for the specified key * - * @param key Primary key of the record + * @param key Primary key of the record */ metadata(key: string): Object; @@ -3117,14 +3049,14 @@ class JSONPDataSource { /** * Gets /sets the current page index. If an index is passed as a parameter, the data source is re-bound. * - * @param index the page index. If none is specified, returns the current page index. + * @param index the page index. If none is specified, returns the current page index. */ pageIndex(index?: number): number; /** * Gets /sets the page index that should be persisted. For now ONLY when filtering is applied and call explicitly DataBind. * - * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. + * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. */ persistedPageIndex(value?: number): number; @@ -3141,7 +3073,7 @@ class JSONPDataSource { /** * Gets /sets the page size and rebinds the data source if a parameter is specified. If no parameter is passed, returns the current page size * - * @param s the page size. + * @param s the page size. */ pageSize(s?: number): number; @@ -3155,28 +3087,28 @@ class JSONPDataSource { /** * Returns a list of records for the specified page. Implies that paging is enabled. * - * @param p the page index for which records will be returned + * @param p the page index for which records will be returned */ recordsForPage(p: number): void; /** * Converts a HTML TABLE dom element to a JavaScript array of objects that contain the records data * - * @param tableDOM TABLE dom element to transform + * @param tableDOM TABLE dom element to transform */ tableToObject(tableDOM: Element): Object; /** * Parses the string and returns an evaluated JSON object * - * @param s the JSON as string. + * @param s the JSON as string. */ stringToJSONObject(s: string): void; /** * Parses a string and returns a XML Document * - * @param s the XML represented as a string + * @param s the XML represented as a string */ stringToXmlObject(s: string): void; @@ -3198,22 +3130,22 @@ class JSONPDataSource { /** * Toggle grouped record with the specified id and updates collections visible groupby data and data view * - * @param id data-id attribute of the respective group row in the DOM - * @param collapsed if true the record should be collapsed, otherwise expanded + * @param id data-id attribute of the respective group row in the DOM + * @param collapsed if true the record should be collapsed, otherwise expanded */ toggleGroupByRecord(id: string, collapsed: boolean): void; /** * Check whether the specified gorupby record is collapsed * - * @param gbRec id of the grouped record OR grouped record + * @param gbRec id of the grouped record OR grouped record */ isGroupByRecordCollapsed(gbRec: Object): boolean; /** * Check whether grouping is applied for the specified sorting expressions. * - * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings + * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings */ isGroupByApplied(exprs?: any[]): boolean; } @@ -3229,7 +3161,7 @@ class XmlDataSource { /** * Sets a list of fields to the data source. If no parameter is specified, just returns the already existing list of fields * - * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } + * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } */ fields(fields?: Object): Object; @@ -3266,36 +3198,36 @@ class XmlDataSource { /** * Gets/sets the schema definition. * - * @param s a schema object - * @param t type of the data source. See settings.type + * @param s a schema object + * @param t type of the data source. See settings.type */ schema(s?: Object, t?: string): void; /** * Gets/sets a list of paging settings * - * @param p object holding all paging settings. See settings.paging + * @param p object holding all paging settings. See settings.paging */ pagingSettings(p?: Object): Object; /** * Gets/sets a list of filtering settings * - * @param f object holding all filtering settings. See settings.filtering + * @param f object holding all filtering settings. See settings.filtering */ filterSettings(f?: Object): void; /** * Gets/sets a list of paging settings * - * @param s object holding all sorting settings. See settings.sorting + * @param s object holding all sorting settings. See settings.sorting */ sortSettings(s?: Object): Object; /** * Gets/sets a list of summaries settings. * - * @param s object holding all summaries settings. See settings.summaries + * @param s object holding all summaries settings. See settings.summaries */ summariesSettings(s?: Object): void; @@ -3317,16 +3249,16 @@ class XmlDataSource { /** * Returns a record by a specified key (requires that primaryKey is set in the settings) * - * @param key Primary key of the record - * @param ds the data source in which to search for the record. When not set it will use the current data source. - * @param objPath Not used in $.ig.DataSource + * @param key Primary key of the record + * @param ds the data source in which to search for the record. When not set it will use the current data source. + * @param objPath Not used in $.ig.DataSource */ findRecordByKey(key: string, ds?: string, objPath?: string): Object; /** * Removes a specific record denoted by the primaryKey of the passed key parameter from the data source * - * @param key primary key of the record + * @param key primary key of the record * @param origDs */ removeRecordByKey(key: Object, origDs: Object): void; @@ -3334,7 +3266,7 @@ class XmlDataSource { /** * Removes a record from the data source at specific index. * - * @param index index of record + * @param index index of record * @param origDs */ removeRecordByIndex(index: number, origDs: Object): void; @@ -3342,82 +3274,82 @@ class XmlDataSource { /** * Sets a cell value for the cell denoted by rowId and colId. Creates a transaction for the update operation and returns it * - * @param rowId the rowId - row key (string) or index (number) - * @param colId the column id - column key (string) or index (number) - * @param val The new value - * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the rowId - row key (string) or index (number) + * @param colId the column id - column key (string) or index (number) + * @param val The new value + * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log */ setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; /** * Updates a record in the datasource. Creates a transaction that can be committed / rolled back * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log */ updateRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; /** * Adds a new row to the data source. Creates a transaction that can be committed / rolled back * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log */ addRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; /** * Adds a new row to the data source. Creates a transaction that can be committed / rolled back * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param rowIndex row index at which to insert the new row - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - * @param parentRowId Not used in $.ig.DataSource + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param rowIndex row index at which to insert the new row + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param parentRowId Not used in $.ig.DataSource */ insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: Object): Object; /** * Deletes a row from the data source. * - * @param rowId the record key - primaryKey (string) or index (number) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the record key - primaryKey (string) or index (number) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log */ deleteRow(rowId: Object, autoCommit: boolean): Object; /** * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back * - * @param data the transaction data + * @param data the transaction data */ addNode(data: Object): void; /** * Removes a node from the tree data source. Creates a transaction that can be committed / rolled back * - * @param data the transaction data + * @param data the transaction data */ removeNode(data: Object): void; /** * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source * - * @param t a transaction object + * @param t a transaction object */ getDetachedRecord(t: Object): Object; /** * Update the data source with every transaction from the log * - * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. + * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. */ commit(id?: number): void; /** * Clears the transaction log without updating anything in the data source * - * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. + * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. */ rollback(id?: Object): void; @@ -3439,8 +3371,8 @@ class XmlDataSource { /** * Posts to the settings.updateUrl using $.ajax, by serializing the changes as url params * - * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) - * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) + * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) + * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) */ saveChanges(success: Function, error: Function): void; @@ -3461,16 +3393,16 @@ class XmlDataSource { * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView * 6. fire the databound event * - * @param callback callback function - * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context + * @param callback callback function + * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context */ dataBind(callback?: string, callee?: Object): void; /** * Gets a cell value from the record by the specified fieldName. If there's a mapper defined for the field, the resolved by the mapper value will be returned. * - * @param fieldName the fieldName - name of the field - * @param record the record from which to get it + * @param fieldName the fieldName - name of the field + * @param record the record from which to get it */ getCellValue(fieldName: string, record: Object): Object; @@ -3480,8 +3412,8 @@ class XmlDataSource { * If key or dsObj are not set then returns summaries data. * Takes summary data from passed argument dsObj(using argument key) * - * @param key response key to take summary data(for example "Metadata.Summaries") - * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) + * @param key response key to take summary data(for example "Metadata.Summaries") + * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) */ summariesResponse(key?: string, dsObj?: Object): Object; @@ -3498,8 +3430,8 @@ class XmlDataSource { * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] * - * @param fields an array of fields object definitions - * @param direction asc / desc direction + * @param fields an array of fields object definitions + * @param direction asc / desc direction */ sort(fields: Object, direction: string): void; @@ -3511,8 +3443,8 @@ class XmlDataSource { /** * Filters the data source locally by text. If "fields" parameter is set search is performed only in the listed fields otherwise all fields are searched. * - * @param expression a text to search for. Multiple search texts should be separated by space. When multiple search texts are provided all of them should be presented in the search fields (bool logic "and" is applied). - * @param fields an array of fields that will be searched. + * @param expression a text to search for. Multiple search texts should be separated by space. When multiple search texts are provided all of them should be presented in the search fields (bool logic "and" is applied). + * @param fields an array of fields that will be searched. */ filterByText(expression: string, fields?: any[]): void; @@ -3526,28 +3458,14 @@ class XmlDataSource { * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain * if expr is detected to be a regular expression, the "cond" part is skipped * To [filter by text](ig.datasource#methods:filterByText) "fieldExpressions" should have only one object with the following schema: + * {filterAllFields: , expr: , fields: } * - * @param fieldExpressions {filterAllFields: , expr: , fields: } - * - * ``` - * ds = new $.%%WidgetName%%({ - * type: "json", - * dataSource: adventureWorks, - * schema: jsonSchema - * }); - * ds.dataBind(); - * - * ds.filter([{fieldName : "Color", expr: "Red", cond: "Equals"}], "AND", true); - * - * // Filter by text - * ds.filter([{filterAllFields: true, expr: "abc", fields: [name: "Description", type: "string"]}]); - * ``` - * - * @param boolLogic a list of field expression definitions - * @param keepFilterState boolean logic. Accepted values are AND and OR. - * @param fieldExpressionsOnStrings a list of field expression definitions (or a string with the conditions separated by AND/OR operator, example: "ID = 1 OR ID = 2"), which when applied will threat the related field as if it's string and can only apply conditions valid for string types. + * @param fieldExpressions a list of field expression definitions + * @param boolLogic boolean logic. Accepted values are AND and OR. + * @param keepFilterState if keepFilterState is set to true, it will not discard previous filtering expressions + * @param fieldExpressionsOnStrings a list of field expression definitions (or a string with the conditions separated by AND/OR operator, example: "ID = 1 OR ID = 2"), which when applied will threat the related field as if it's string and can only apply conditions valid for string types. */ - filter(fieldExpressions: any[], boolLogic: Object, keepFilterState: Object, fieldExpressionsOnStrings: Object): void; + filter(fieldExpressions: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; /** * This clears local filtering applied to the data view by resetting it to the original data and applying any paging @@ -3561,7 +3479,7 @@ class XmlDataSource { * the actual total number of records may not * match the number of records that exists on the client * - * @param count the total number of records + * @param count the total number of records * @param key * @param dsObj * @param context @@ -3571,14 +3489,14 @@ class XmlDataSource { /** * Gets / sets if the response from the server contains a property which specifies the total number of records in the server-side backend * - * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend + * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend */ hasTotalRecordsCount(hasCount: boolean): void; /** * Returns metadata object for the specified key * - * @param key Primary key of the record + * @param key Primary key of the record */ metadata(key: string): Object; @@ -3595,14 +3513,14 @@ class XmlDataSource { /** * Gets /sets the current page index. If an index is passed as a parameter, the data source is re-bound. * - * @param index the page index. If none is specified, returns the current page index. + * @param index the page index. If none is specified, returns the current page index. */ pageIndex(index?: number): number; /** * Gets /sets the page index that should be persisted. For now ONLY when filtering is applied and call explicitly DataBind. * - * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. + * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. */ persistedPageIndex(value?: number): number; @@ -3619,7 +3537,7 @@ class XmlDataSource { /** * Gets /sets the page size and rebinds the data source if a parameter is specified. If no parameter is passed, returns the current page size * - * @param s the page size. + * @param s the page size. */ pageSize(s?: number): number; @@ -3633,28 +3551,28 @@ class XmlDataSource { /** * Returns a list of records for the specified page. Implies that paging is enabled. * - * @param p the page index for which records will be returned + * @param p the page index for which records will be returned */ recordsForPage(p: number): void; /** * Converts a HTML TABLE dom element to a JavaScript array of objects that contain the records data * - * @param tableDOM TABLE dom element to transform + * @param tableDOM TABLE dom element to transform */ tableToObject(tableDOM: Element): Object; /** * Parses the string and returns an evaluated JSON object * - * @param s the JSON as string. + * @param s the JSON as string. */ stringToJSONObject(s: string): void; /** * Parses a string and returns a XML Document * - * @param s the XML represented as a string + * @param s the XML represented as a string */ stringToXmlObject(s: string): void; @@ -3676,22 +3594,22 @@ class XmlDataSource { /** * Toggle grouped record with the specified id and updates collections visible groupby data and data view * - * @param id data-id attribute of the respective group row in the DOM - * @param collapsed if true the record should be collapsed, otherwise expanded + * @param id data-id attribute of the respective group row in the DOM + * @param collapsed if true the record should be collapsed, otherwise expanded */ toggleGroupByRecord(id: string, collapsed: boolean): void; /** * Check whether the specified gorupby record is collapsed * - * @param gbRec id of the grouped record OR grouped record + * @param gbRec id of the grouped record OR grouped record */ isGroupByRecordCollapsed(gbRec: Object): boolean; /** * Check whether grouping is applied for the specified sorting expressions. * - * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings + * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings */ isGroupByApplied(exprs?: any[]): boolean; } @@ -3719,7 +3637,7 @@ class FunctionDataSource { /** * Sets a list of fields to the data source. If no parameter is specified, just returns the already existing list of fields * - * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } + * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } */ fields(fields?: Object): Object; @@ -3756,36 +3674,36 @@ class FunctionDataSource { /** * Gets/sets the schema definition. * - * @param s a schema object - * @param t type of the data source. See settings.type + * @param s a schema object + * @param t type of the data source. See settings.type */ schema(s?: Object, t?: string): void; /** * Gets/sets a list of paging settings * - * @param p object holding all paging settings. See settings.paging + * @param p object holding all paging settings. See settings.paging */ pagingSettings(p?: Object): Object; /** * Gets/sets a list of filtering settings * - * @param f object holding all filtering settings. See settings.filtering + * @param f object holding all filtering settings. See settings.filtering */ filterSettings(f?: Object): void; /** * Gets/sets a list of paging settings * - * @param s object holding all sorting settings. See settings.sorting + * @param s object holding all sorting settings. See settings.sorting */ sortSettings(s?: Object): Object; /** * Gets/sets a list of summaries settings. * - * @param s object holding all summaries settings. See settings.summaries + * @param s object holding all summaries settings. See settings.summaries */ summariesSettings(s?: Object): void; @@ -3807,16 +3725,16 @@ class FunctionDataSource { /** * Returns a record by a specified key (requires that primaryKey is set in the settings) * - * @param key Primary key of the record - * @param ds the data source in which to search for the record. When not set it will use the current data source. - * @param objPath Not used in $.ig.DataSource + * @param key Primary key of the record + * @param ds the data source in which to search for the record. When not set it will use the current data source. + * @param objPath Not used in $.ig.DataSource */ findRecordByKey(key: string, ds?: string, objPath?: string): Object; /** * Removes a specific record denoted by the primaryKey of the passed key parameter from the data source * - * @param key primary key of the record + * @param key primary key of the record * @param origDs */ removeRecordByKey(key: Object, origDs: Object): void; @@ -3824,7 +3742,7 @@ class FunctionDataSource { /** * Removes a record from the data source at specific index. * - * @param index index of record + * @param index index of record * @param origDs */ removeRecordByIndex(index: number, origDs: Object): void; @@ -3832,82 +3750,82 @@ class FunctionDataSource { /** * Sets a cell value for the cell denoted by rowId and colId. Creates a transaction for the update operation and returns it * - * @param rowId the rowId - row key (string) or index (number) - * @param colId the column id - column key (string) or index (number) - * @param val The new value - * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the rowId - row key (string) or index (number) + * @param colId the column id - column key (string) or index (number) + * @param val The new value + * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log */ setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; /** * Updates a record in the datasource. Creates a transaction that can be committed / rolled back * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log */ updateRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; /** * Adds a new row to the data source. Creates a transaction that can be committed / rolled back * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log */ addRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; /** * Adds a new row to the data source. Creates a transaction that can be committed / rolled back * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param rowIndex row index at which to insert the new row - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - * @param parentRowId Not used in $.ig.DataSource + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param rowIndex row index at which to insert the new row + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param parentRowId Not used in $.ig.DataSource */ insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: Object): Object; /** * Deletes a row from the data source. * - * @param rowId the record key - primaryKey (string) or index (number) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the record key - primaryKey (string) or index (number) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log */ deleteRow(rowId: Object, autoCommit: boolean): Object; /** * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back * - * @param data the transaction data + * @param data the transaction data */ addNode(data: Object): void; /** * Removes a node from the tree data source. Creates a transaction that can be committed / rolled back * - * @param data the transaction data + * @param data the transaction data */ removeNode(data: Object): void; /** * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source * - * @param t a transaction object + * @param t a transaction object */ getDetachedRecord(t: Object): Object; /** * Update the data source with every transaction from the log * - * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. + * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. */ commit(id?: number): void; /** * Clears the transaction log without updating anything in the data source * - * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. + * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. */ rollback(id?: Object): void; @@ -3929,8 +3847,8 @@ class FunctionDataSource { /** * Posts to the settings.updateUrl using $.ajax, by serializing the changes as url params * - * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) - * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) + * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) + * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) */ saveChanges(success: Function, error: Function): void; @@ -3951,16 +3869,16 @@ class FunctionDataSource { * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView * 6. fire the databound event * - * @param callback callback function - * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context + * @param callback callback function + * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context */ dataBind(callback?: string, callee?: Object): void; /** * Gets a cell value from the record by the specified fieldName. If there's a mapper defined for the field, the resolved by the mapper value will be returned. * - * @param fieldName the fieldName - name of the field - * @param record the record from which to get it + * @param fieldName the fieldName - name of the field + * @param record the record from which to get it */ getCellValue(fieldName: string, record: Object): Object; @@ -3970,8 +3888,8 @@ class FunctionDataSource { * If key or dsObj are not set then returns summaries data. * Takes summary data from passed argument dsObj(using argument key) * - * @param key response key to take summary data(for example "Metadata.Summaries") - * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) + * @param key response key to take summary data(for example "Metadata.Summaries") + * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) */ summariesResponse(key?: string, dsObj?: Object): Object; @@ -3988,8 +3906,8 @@ class FunctionDataSource { * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] * - * @param fields an array of fields object definitions - * @param direction asc / desc direction + * @param fields an array of fields object definitions + * @param direction asc / desc direction */ sort(fields: Object, direction: string): void; @@ -4001,8 +3919,8 @@ class FunctionDataSource { /** * Filters the data source locally by text. If "fields" parameter is set search is performed only in the listed fields otherwise all fields are searched. * - * @param expression a text to search for. Multiple search texts should be separated by space. When multiple search texts are provided all of them should be presented in the search fields (bool logic "and" is applied). - * @param fields an array of fields that will be searched. + * @param expression a text to search for. Multiple search texts should be separated by space. When multiple search texts are provided all of them should be presented in the search fields (bool logic "and" is applied). + * @param fields an array of fields that will be searched. */ filterByText(expression: string, fields?: any[]): void; @@ -4016,28 +3934,14 @@ class FunctionDataSource { * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain * if expr is detected to be a regular expression, the "cond" part is skipped * To [filter by text](ig.datasource#methods:filterByText) "fieldExpressions" should have only one object with the following schema: + * {filterAllFields: , expr: , fields: } * - * @param fieldExpressions {filterAllFields: , expr: , fields: } - * - * ``` - * ds = new $.%%WidgetName%%({ - * type: "json", - * dataSource: adventureWorks, - * schema: jsonSchema - * }); - * ds.dataBind(); - * - * ds.filter([{fieldName : "Color", expr: "Red", cond: "Equals"}], "AND", true); - * - * // Filter by text - * ds.filter([{filterAllFields: true, expr: "abc", fields: [name: "Description", type: "string"]}]); - * ``` - * - * @param boolLogic a list of field expression definitions - * @param keepFilterState boolean logic. Accepted values are AND and OR. - * @param fieldExpressionsOnStrings a list of field expression definitions (or a string with the conditions separated by AND/OR operator, example: "ID = 1 OR ID = 2"), which when applied will threat the related field as if it's string and can only apply conditions valid for string types. + * @param fieldExpressions a list of field expression definitions + * @param boolLogic boolean logic. Accepted values are AND and OR. + * @param keepFilterState if keepFilterState is set to true, it will not discard previous filtering expressions + * @param fieldExpressionsOnStrings a list of field expression definitions (or a string with the conditions separated by AND/OR operator, example: "ID = 1 OR ID = 2"), which when applied will threat the related field as if it's string and can only apply conditions valid for string types. */ - filter(fieldExpressions: any[], boolLogic: Object, keepFilterState: Object, fieldExpressionsOnStrings: Object): void; + filter(fieldExpressions: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; /** * This clears local filtering applied to the data view by resetting it to the original data and applying any paging @@ -4051,7 +3955,7 @@ class FunctionDataSource { * the actual total number of records may not * match the number of records that exists on the client * - * @param count the total number of records + * @param count the total number of records * @param key * @param dsObj * @param context @@ -4061,14 +3965,14 @@ class FunctionDataSource { /** * Gets / sets if the response from the server contains a property which specifies the total number of records in the server-side backend * - * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend + * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend */ hasTotalRecordsCount(hasCount: boolean): void; /** * Returns metadata object for the specified key * - * @param key Primary key of the record + * @param key Primary key of the record */ metadata(key: string): Object; @@ -4085,14 +3989,14 @@ class FunctionDataSource { /** * Gets /sets the current page index. If an index is passed as a parameter, the data source is re-bound. * - * @param index the page index. If none is specified, returns the current page index. + * @param index the page index. If none is specified, returns the current page index. */ pageIndex(index?: number): number; /** * Gets /sets the page index that should be persisted. For now ONLY when filtering is applied and call explicitly DataBind. * - * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. + * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. */ persistedPageIndex(value?: number): number; @@ -4109,7 +4013,7 @@ class FunctionDataSource { /** * Gets /sets the page size and rebinds the data source if a parameter is specified. If no parameter is passed, returns the current page size * - * @param s the page size. + * @param s the page size. */ pageSize(s?: number): number; @@ -4123,28 +4027,28 @@ class FunctionDataSource { /** * Returns a list of records for the specified page. Implies that paging is enabled. * - * @param p the page index for which records will be returned + * @param p the page index for which records will be returned */ recordsForPage(p: number): void; /** * Converts a HTML TABLE dom element to a JavaScript array of objects that contain the records data * - * @param tableDOM TABLE dom element to transform + * @param tableDOM TABLE dom element to transform */ tableToObject(tableDOM: Element): Object; /** * Parses the string and returns an evaluated JSON object * - * @param s the JSON as string. + * @param s the JSON as string. */ stringToJSONObject(s: string): void; /** * Parses a string and returns a XML Document * - * @param s the XML represented as a string + * @param s the XML represented as a string */ stringToXmlObject(s: string): void; @@ -4166,22 +4070,22 @@ class FunctionDataSource { /** * Toggle grouped record with the specified id and updates collections visible groupby data and data view * - * @param id data-id attribute of the respective group row in the DOM - * @param collapsed if true the record should be collapsed, otherwise expanded + * @param id data-id attribute of the respective group row in the DOM + * @param collapsed if true the record should be collapsed, otherwise expanded */ toggleGroupByRecord(id: string, collapsed: boolean): void; /** * Check whether the specified gorupby record is collapsed * - * @param gbRec id of the grouped record OR grouped record + * @param gbRec id of the grouped record OR grouped record */ isGroupByRecordCollapsed(gbRec: Object): boolean; /** * Check whether grouping is applied for the specified sorting expressions. * - * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings + * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings */ isGroupByApplied(exprs?: any[]): boolean; } @@ -4209,7 +4113,7 @@ class HtmlTableDataSource { /** * Sets a list of fields to the data source. If no parameter is specified, just returns the already existing list of fields * - * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } + * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } */ fields(fields?: Object): Object; @@ -4246,36 +4150,36 @@ class HtmlTableDataSource { /** * Gets/sets the schema definition. * - * @param s a schema object - * @param t type of the data source. See settings.type + * @param s a schema object + * @param t type of the data source. See settings.type */ schema(s?: Object, t?: string): void; /** * Gets/sets a list of paging settings * - * @param p object holding all paging settings. See settings.paging + * @param p object holding all paging settings. See settings.paging */ pagingSettings(p?: Object): Object; /** * Gets/sets a list of filtering settings * - * @param f object holding all filtering settings. See settings.filtering + * @param f object holding all filtering settings. See settings.filtering */ filterSettings(f?: Object): void; /** * Gets/sets a list of paging settings * - * @param s object holding all sorting settings. See settings.sorting + * @param s object holding all sorting settings. See settings.sorting */ sortSettings(s?: Object): Object; /** * Gets/sets a list of summaries settings. * - * @param s object holding all summaries settings. See settings.summaries + * @param s object holding all summaries settings. See settings.summaries */ summariesSettings(s?: Object): void; @@ -4297,16 +4201,16 @@ class HtmlTableDataSource { /** * Returns a record by a specified key (requires that primaryKey is set in the settings) * - * @param key Primary key of the record - * @param ds the data source in which to search for the record. When not set it will use the current data source. - * @param objPath Not used in $.ig.DataSource + * @param key Primary key of the record + * @param ds the data source in which to search for the record. When not set it will use the current data source. + * @param objPath Not used in $.ig.DataSource */ findRecordByKey(key: string, ds?: string, objPath?: string): Object; /** * Removes a specific record denoted by the primaryKey of the passed key parameter from the data source * - * @param key primary key of the record + * @param key primary key of the record * @param origDs */ removeRecordByKey(key: Object, origDs: Object): void; @@ -4314,7 +4218,7 @@ class HtmlTableDataSource { /** * Removes a record from the data source at specific index. * - * @param index index of record + * @param index index of record * @param origDs */ removeRecordByIndex(index: number, origDs: Object): void; @@ -4322,82 +4226,82 @@ class HtmlTableDataSource { /** * Sets a cell value for the cell denoted by rowId and colId. Creates a transaction for the update operation and returns it * - * @param rowId the rowId - row key (string) or index (number) - * @param colId the column id - column key (string) or index (number) - * @param val The new value - * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the rowId - row key (string) or index (number) + * @param colId the column id - column key (string) or index (number) + * @param val The new value + * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log */ setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; /** * Updates a record in the datasource. Creates a transaction that can be committed / rolled back * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log */ updateRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; /** * Adds a new row to the data source. Creates a transaction that can be committed / rolled back * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log */ addRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; /** * Adds a new row to the data source. Creates a transaction that can be committed / rolled back * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param rowIndex row index at which to insert the new row - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - * @param parentRowId Not used in $.ig.DataSource + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param rowIndex row index at which to insert the new row + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param parentRowId Not used in $.ig.DataSource */ insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: Object): Object; /** * Deletes a row from the data source. * - * @param rowId the record key - primaryKey (string) or index (number) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the record key - primaryKey (string) or index (number) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log */ deleteRow(rowId: Object, autoCommit: boolean): Object; /** * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back * - * @param data the transaction data + * @param data the transaction data */ addNode(data: Object): void; /** * Removes a node from the tree data source. Creates a transaction that can be committed / rolled back * - * @param data the transaction data + * @param data the transaction data */ removeNode(data: Object): void; /** * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source * - * @param t a transaction object + * @param t a transaction object */ getDetachedRecord(t: Object): Object; /** * Update the data source with every transaction from the log * - * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. + * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. */ commit(id?: number): void; /** * Clears the transaction log without updating anything in the data source * - * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. + * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. */ rollback(id?: Object): void; @@ -4419,8 +4323,8 @@ class HtmlTableDataSource { /** * Posts to the settings.updateUrl using $.ajax, by serializing the changes as url params * - * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) - * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) + * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) + * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) */ saveChanges(success: Function, error: Function): void; @@ -4441,16 +4345,16 @@ class HtmlTableDataSource { * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView * 6. fire the databound event * - * @param callback callback function - * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context + * @param callback callback function + * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context */ dataBind(callback?: string, callee?: Object): void; /** * Gets a cell value from the record by the specified fieldName. If there's a mapper defined for the field, the resolved by the mapper value will be returned. * - * @param fieldName the fieldName - name of the field - * @param record the record from which to get it + * @param fieldName the fieldName - name of the field + * @param record the record from which to get it */ getCellValue(fieldName: string, record: Object): Object; @@ -4460,8 +4364,8 @@ class HtmlTableDataSource { * If key or dsObj are not set then returns summaries data. * Takes summary data from passed argument dsObj(using argument key) * - * @param key response key to take summary data(for example "Metadata.Summaries") - * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) + * @param key response key to take summary data(for example "Metadata.Summaries") + * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) */ summariesResponse(key?: string, dsObj?: Object): Object; @@ -4478,8 +4382,8 @@ class HtmlTableDataSource { * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] * - * @param fields an array of fields object definitions - * @param direction asc / desc direction + * @param fields an array of fields object definitions + * @param direction asc / desc direction */ sort(fields: Object, direction: string): void; @@ -4491,8 +4395,8 @@ class HtmlTableDataSource { /** * Filters the data source locally by text. If "fields" parameter is set search is performed only in the listed fields otherwise all fields are searched. * - * @param expression a text to search for. Multiple search texts should be separated by space. When multiple search texts are provided all of them should be presented in the search fields (bool logic "and" is applied). - * @param fields an array of fields that will be searched. + * @param expression a text to search for. Multiple search texts should be separated by space. When multiple search texts are provided all of them should be presented in the search fields (bool logic "and" is applied). + * @param fields an array of fields that will be searched. */ filterByText(expression: string, fields?: any[]): void; @@ -4506,28 +4410,14 @@ class HtmlTableDataSource { * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain * if expr is detected to be a regular expression, the "cond" part is skipped * To [filter by text](ig.datasource#methods:filterByText) "fieldExpressions" should have only one object with the following schema: + * {filterAllFields: , expr: , fields: } * - * @param fieldExpressions {filterAllFields: , expr: , fields: } - * - * ``` - * ds = new $.%%WidgetName%%({ - * type: "json", - * dataSource: adventureWorks, - * schema: jsonSchema - * }); - * ds.dataBind(); - * - * ds.filter([{fieldName : "Color", expr: "Red", cond: "Equals"}], "AND", true); - * - * // Filter by text - * ds.filter([{filterAllFields: true, expr: "abc", fields: [name: "Description", type: "string"]}]); - * ``` - * - * @param boolLogic a list of field expression definitions - * @param keepFilterState boolean logic. Accepted values are AND and OR. - * @param fieldExpressionsOnStrings a list of field expression definitions (or a string with the conditions separated by AND/OR operator, example: "ID = 1 OR ID = 2"), which when applied will threat the related field as if it's string and can only apply conditions valid for string types. + * @param fieldExpressions a list of field expression definitions + * @param boolLogic boolean logic. Accepted values are AND and OR. + * @param keepFilterState if keepFilterState is set to true, it will not discard previous filtering expressions + * @param fieldExpressionsOnStrings a list of field expression definitions (or a string with the conditions separated by AND/OR operator, example: "ID = 1 OR ID = 2"), which when applied will threat the related field as if it's string and can only apply conditions valid for string types. */ - filter(fieldExpressions: any[], boolLogic: Object, keepFilterState: Object, fieldExpressionsOnStrings: Object): void; + filter(fieldExpressions: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; /** * This clears local filtering applied to the data view by resetting it to the original data and applying any paging @@ -4541,7 +4431,7 @@ class HtmlTableDataSource { * the actual total number of records may not * match the number of records that exists on the client * - * @param count the total number of records + * @param count the total number of records * @param key * @param dsObj * @param context @@ -4551,14 +4441,14 @@ class HtmlTableDataSource { /** * Gets / sets if the response from the server contains a property which specifies the total number of records in the server-side backend * - * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend + * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend */ hasTotalRecordsCount(hasCount: boolean): void; /** * Returns metadata object for the specified key * - * @param key Primary key of the record + * @param key Primary key of the record */ metadata(key: string): Object; @@ -4575,14 +4465,14 @@ class HtmlTableDataSource { /** * Gets /sets the current page index. If an index is passed as a parameter, the data source is re-bound. * - * @param index the page index. If none is specified, returns the current page index. + * @param index the page index. If none is specified, returns the current page index. */ pageIndex(index?: number): number; /** * Gets /sets the page index that should be persisted. For now ONLY when filtering is applied and call explicitly DataBind. * - * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. + * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. */ persistedPageIndex(value?: number): number; @@ -4599,7 +4489,7 @@ class HtmlTableDataSource { /** * Gets /sets the page size and rebinds the data source if a parameter is specified. If no parameter is passed, returns the current page size * - * @param s the page size. + * @param s the page size. */ pageSize(s?: number): number; @@ -4613,28 +4503,28 @@ class HtmlTableDataSource { /** * Returns a list of records for the specified page. Implies that paging is enabled. * - * @param p the page index for which records will be returned + * @param p the page index for which records will be returned */ recordsForPage(p: number): void; /** * Converts a HTML TABLE dom element to a JavaScript array of objects that contain the records data * - * @param tableDOM TABLE dom element to transform + * @param tableDOM TABLE dom element to transform */ tableToObject(tableDOM: Element): Object; /** * Parses the string and returns an evaluated JSON object * - * @param s the JSON as string. + * @param s the JSON as string. */ stringToJSONObject(s: string): void; /** * Parses a string and returns a XML Document * - * @param s the XML represented as a string + * @param s the XML represented as a string */ stringToXmlObject(s: string): void; @@ -4656,22 +4546,22 @@ class HtmlTableDataSource { /** * Toggle grouped record with the specified id and updates collections visible groupby data and data view * - * @param id data-id attribute of the respective group row in the DOM - * @param collapsed if true the record should be collapsed, otherwise expanded + * @param id data-id attribute of the respective group row in the DOM + * @param collapsed if true the record should be collapsed, otherwise expanded */ toggleGroupByRecord(id: string, collapsed: boolean): void; /** * Check whether the specified gorupby record is collapsed * - * @param gbRec id of the grouped record OR grouped record + * @param gbRec id of the grouped record OR grouped record */ isGroupByRecordCollapsed(gbRec: Object): boolean; /** * Check whether grouping is applied for the specified sorting expressions. * - * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings + * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings */ isGroupByApplied(exprs?: any[]): boolean; } @@ -4687,7 +4577,7 @@ class ArrayDataSource { /** * Sets a list of fields to the data source. If no parameter is specified, just returns the already existing list of fields * - * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } + * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } */ fields(fields?: Object): Object; @@ -4724,36 +4614,36 @@ class ArrayDataSource { /** * Gets/sets the schema definition. * - * @param s a schema object - * @param t type of the data source. See settings.type + * @param s a schema object + * @param t type of the data source. See settings.type */ schema(s?: Object, t?: string): void; /** * Gets/sets a list of paging settings * - * @param p object holding all paging settings. See settings.paging + * @param p object holding all paging settings. See settings.paging */ pagingSettings(p?: Object): Object; /** * Gets/sets a list of filtering settings * - * @param f object holding all filtering settings. See settings.filtering + * @param f object holding all filtering settings. See settings.filtering */ filterSettings(f?: Object): void; /** * Gets/sets a list of paging settings * - * @param s object holding all sorting settings. See settings.sorting + * @param s object holding all sorting settings. See settings.sorting */ sortSettings(s?: Object): Object; /** * Gets/sets a list of summaries settings. * - * @param s object holding all summaries settings. See settings.summaries + * @param s object holding all summaries settings. See settings.summaries */ summariesSettings(s?: Object): void; @@ -4775,16 +4665,16 @@ class ArrayDataSource { /** * Returns a record by a specified key (requires that primaryKey is set in the settings) * - * @param key Primary key of the record - * @param ds the data source in which to search for the record. When not set it will use the current data source. - * @param objPath Not used in $.ig.DataSource + * @param key Primary key of the record + * @param ds the data source in which to search for the record. When not set it will use the current data source. + * @param objPath Not used in $.ig.DataSource */ findRecordByKey(key: string, ds?: string, objPath?: string): Object; /** * Removes a specific record denoted by the primaryKey of the passed key parameter from the data source * - * @param key primary key of the record + * @param key primary key of the record * @param origDs */ removeRecordByKey(key: Object, origDs: Object): void; @@ -4792,7 +4682,7 @@ class ArrayDataSource { /** * Removes a record from the data source at specific index. * - * @param index index of record + * @param index index of record * @param origDs */ removeRecordByIndex(index: number, origDs: Object): void; @@ -4800,82 +4690,82 @@ class ArrayDataSource { /** * Sets a cell value for the cell denoted by rowId and colId. Creates a transaction for the update operation and returns it * - * @param rowId the rowId - row key (string) or index (number) - * @param colId the column id - column key (string) or index (number) - * @param val The new value - * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the rowId - row key (string) or index (number) + * @param colId the column id - column key (string) or index (number) + * @param val The new value + * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log */ setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; /** * Updates a record in the datasource. Creates a transaction that can be committed / rolled back * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log */ updateRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; /** * Adds a new row to the data source. Creates a transaction that can be committed / rolled back * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log */ addRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; /** * Adds a new row to the data source. Creates a transaction that can be committed / rolled back * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param rowIndex row index at which to insert the new row - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - * @param parentRowId Not used in $.ig.DataSource + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param rowIndex row index at which to insert the new row + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param parentRowId Not used in $.ig.DataSource */ insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: Object): Object; /** * Deletes a row from the data source. * - * @param rowId the record key - primaryKey (string) or index (number) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the record key - primaryKey (string) or index (number) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log */ deleteRow(rowId: Object, autoCommit: boolean): Object; /** * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back * - * @param data the transaction data + * @param data the transaction data */ addNode(data: Object): void; /** * Removes a node from the tree data source. Creates a transaction that can be committed / rolled back * - * @param data the transaction data + * @param data the transaction data */ removeNode(data: Object): void; /** * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source * - * @param t a transaction object + * @param t a transaction object */ getDetachedRecord(t: Object): Object; /** * Update the data source with every transaction from the log * - * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. + * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. */ commit(id?: number): void; /** * Clears the transaction log without updating anything in the data source * - * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. + * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. */ rollback(id?: Object): void; @@ -4897,8 +4787,8 @@ class ArrayDataSource { /** * Posts to the settings.updateUrl using $.ajax, by serializing the changes as url params * - * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) - * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) + * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) + * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) */ saveChanges(success: Function, error: Function): void; @@ -4919,16 +4809,16 @@ class ArrayDataSource { * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView * 6. fire the databound event * - * @param callback callback function - * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context + * @param callback callback function + * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context */ dataBind(callback?: string, callee?: Object): void; /** * Gets a cell value from the record by the specified fieldName. If there's a mapper defined for the field, the resolved by the mapper value will be returned. * - * @param fieldName the fieldName - name of the field - * @param record the record from which to get it + * @param fieldName the fieldName - name of the field + * @param record the record from which to get it */ getCellValue(fieldName: string, record: Object): Object; @@ -4938,8 +4828,8 @@ class ArrayDataSource { * If key or dsObj are not set then returns summaries data. * Takes summary data from passed argument dsObj(using argument key) * - * @param key response key to take summary data(for example "Metadata.Summaries") - * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) + * @param key response key to take summary data(for example "Metadata.Summaries") + * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) */ summariesResponse(key?: string, dsObj?: Object): Object; @@ -4956,8 +4846,8 @@ class ArrayDataSource { * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] * - * @param fields an array of fields object definitions - * @param direction asc / desc direction + * @param fields an array of fields object definitions + * @param direction asc / desc direction */ sort(fields: Object, direction: string): void; @@ -4969,8 +4859,8 @@ class ArrayDataSource { /** * Filters the data source locally by text. If "fields" parameter is set search is performed only in the listed fields otherwise all fields are searched. * - * @param expression a text to search for. Multiple search texts should be separated by space. When multiple search texts are provided all of them should be presented in the search fields (bool logic "and" is applied). - * @param fields an array of fields that will be searched. + * @param expression a text to search for. Multiple search texts should be separated by space. When multiple search texts are provided all of them should be presented in the search fields (bool logic "and" is applied). + * @param fields an array of fields that will be searched. */ filterByText(expression: string, fields?: any[]): void; @@ -4984,28 +4874,14 @@ class ArrayDataSource { * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain * if expr is detected to be a regular expression, the "cond" part is skipped * To [filter by text](ig.datasource#methods:filterByText) "fieldExpressions" should have only one object with the following schema: + * {filterAllFields: , expr: , fields: } * - * @param fieldExpressions {filterAllFields: , expr: , fields: } - * - * ``` - * ds = new $.%%WidgetName%%({ - * type: "json", - * dataSource: adventureWorks, - * schema: jsonSchema - * }); - * ds.dataBind(); - * - * ds.filter([{fieldName : "Color", expr: "Red", cond: "Equals"}], "AND", true); - * - * // Filter by text - * ds.filter([{filterAllFields: true, expr: "abc", fields: [name: "Description", type: "string"]}]); - * ``` - * - * @param boolLogic a list of field expression definitions - * @param keepFilterState boolean logic. Accepted values are AND and OR. - * @param fieldExpressionsOnStrings a list of field expression definitions (or a string with the conditions separated by AND/OR operator, example: "ID = 1 OR ID = 2"), which when applied will threat the related field as if it's string and can only apply conditions valid for string types. + * @param fieldExpressions a list of field expression definitions + * @param boolLogic boolean logic. Accepted values are AND and OR. + * @param keepFilterState if keepFilterState is set to true, it will not discard previous filtering expressions + * @param fieldExpressionsOnStrings a list of field expression definitions (or a string with the conditions separated by AND/OR operator, example: "ID = 1 OR ID = 2"), which when applied will threat the related field as if it's string and can only apply conditions valid for string types. */ - filter(fieldExpressions: any[], boolLogic: Object, keepFilterState: Object, fieldExpressionsOnStrings: Object): void; + filter(fieldExpressions: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; /** * This clears local filtering applied to the data view by resetting it to the original data and applying any paging @@ -5019,7 +4895,7 @@ class ArrayDataSource { * the actual total number of records may not * match the number of records that exists on the client * - * @param count the total number of records + * @param count the total number of records * @param key * @param dsObj * @param context @@ -5029,14 +4905,14 @@ class ArrayDataSource { /** * Gets / sets if the response from the server contains a property which specifies the total number of records in the server-side backend * - * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend + * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend */ hasTotalRecordsCount(hasCount: boolean): void; /** * Returns metadata object for the specified key * - * @param key Primary key of the record + * @param key Primary key of the record */ metadata(key: string): Object; @@ -5053,14 +4929,14 @@ class ArrayDataSource { /** * Gets /sets the current page index. If an index is passed as a parameter, the data source is re-bound. * - * @param index the page index. If none is specified, returns the current page index. + * @param index the page index. If none is specified, returns the current page index. */ pageIndex(index?: number): number; /** * Gets /sets the page index that should be persisted. For now ONLY when filtering is applied and call explicitly DataBind. * - * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. + * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. */ persistedPageIndex(value?: number): number; @@ -5077,7 +4953,7 @@ class ArrayDataSource { /** * Gets /sets the page size and rebinds the data source if a parameter is specified. If no parameter is passed, returns the current page size * - * @param s the page size. + * @param s the page size. */ pageSize(s?: number): number; @@ -5091,28 +4967,28 @@ class ArrayDataSource { /** * Returns a list of records for the specified page. Implies that paging is enabled. * - * @param p the page index for which records will be returned + * @param p the page index for which records will be returned */ recordsForPage(p: number): void; /** * Converts a HTML TABLE dom element to a JavaScript array of objects that contain the records data * - * @param tableDOM TABLE dom element to transform + * @param tableDOM TABLE dom element to transform */ tableToObject(tableDOM: Element): Object; /** * Parses the string and returns an evaluated JSON object * - * @param s the JSON as string. + * @param s the JSON as string. */ stringToJSONObject(s: string): void; /** * Parses a string and returns a XML Document * - * @param s the XML represented as a string + * @param s the XML represented as a string */ stringToXmlObject(s: string): void; @@ -5134,22 +5010,22 @@ class ArrayDataSource { /** * Toggle grouped record with the specified id and updates collections visible groupby data and data view * - * @param id data-id attribute of the respective group row in the DOM - * @param collapsed if true the record should be collapsed, otherwise expanded + * @param id data-id attribute of the respective group row in the DOM + * @param collapsed if true the record should be collapsed, otherwise expanded */ toggleGroupByRecord(id: string, collapsed: boolean): void; /** * Check whether the specified gorupby record is collapsed * - * @param gbRec id of the grouped record OR grouped record + * @param gbRec id of the grouped record OR grouped record */ isGroupByRecordCollapsed(gbRec: Object): boolean; /** * Check whether grouping is applied for the specified sorting expressions. * - * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings + * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings */ isGroupByApplied(exprs?: any[]): boolean; } @@ -5178,44 +5054,45 @@ interface MashupDataSourceMashupSettings { declare namespace Infragistics { class MashupDataSource { constructor(mashupSettings: MashupDataSourceMashupSettings); + constructor(settings: DataSourceSettings); /** * Sets a cell value for the cell denoted by rowId and colId. Creates a transaction for the update operation and returns it * - * @param rowId the rowId - row key (string) or index (number) - * @param colId the column id - column key (string) or index (number) - * @param val The new value - * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the rowId - row key (string) or index (number) + * @param colId the column id - column key (string) or index (number) + * @param val The new value + * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log */ setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; /** * Updates a record in the datasource. Creates a transaction that can be committed / rolled back * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log */ updateRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; /** * Adds a new row to the data source. Creates a transaction that can be committed / rolled back * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log */ addRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; /** * Adds a new row to the data source. Creates a transaction that can be committed / rolled back * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param rowIndex row index at which to insert the new row - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - * @param parentRowId Not used in $.ig.DataSource + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param rowIndex row index at which to insert the new row + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param parentRowId Not used in $.ig.DataSource */ insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: Object): Object; @@ -5227,7 +5104,7 @@ class MashupDataSource { /** * Sets a list of fields to the data source. If no parameter is specified, just returns the already existing list of fields * - * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } + * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } */ fields(fields?: Object): Object; @@ -5264,36 +5141,36 @@ class MashupDataSource { /** * Gets/sets the schema definition. * - * @param s a schema object - * @param t type of the data source. See settings.type + * @param s a schema object + * @param t type of the data source. See settings.type */ schema(s?: Object, t?: string): void; /** * Gets/sets a list of paging settings * - * @param p object holding all paging settings. See settings.paging + * @param p object holding all paging settings. See settings.paging */ pagingSettings(p?: Object): Object; /** * Gets/sets a list of filtering settings * - * @param f object holding all filtering settings. See settings.filtering + * @param f object holding all filtering settings. See settings.filtering */ filterSettings(f?: Object): void; /** * Gets/sets a list of paging settings * - * @param s object holding all sorting settings. See settings.sorting + * @param s object holding all sorting settings. See settings.sorting */ sortSettings(s?: Object): Object; /** * Gets/sets a list of summaries settings. * - * @param s object holding all summaries settings. See settings.summaries + * @param s object holding all summaries settings. See settings.summaries */ summariesSettings(s?: Object): void; @@ -5315,16 +5192,16 @@ class MashupDataSource { /** * Returns a record by a specified key (requires that primaryKey is set in the settings) * - * @param key Primary key of the record - * @param ds the data source in which to search for the record. When not set it will use the current data source. - * @param objPath Not used in $.ig.DataSource + * @param key Primary key of the record + * @param ds the data source in which to search for the record. When not set it will use the current data source. + * @param objPath Not used in $.ig.DataSource */ findRecordByKey(key: string, ds?: string, objPath?: string): Object; /** * Removes a specific record denoted by the primaryKey of the passed key parameter from the data source * - * @param key primary key of the record + * @param key primary key of the record * @param origDs */ removeRecordByKey(key: Object, origDs: Object): void; @@ -5332,7 +5209,7 @@ class MashupDataSource { /** * Removes a record from the data source at specific index. * - * @param index index of record + * @param index index of record * @param origDs */ removeRecordByIndex(index: number, origDs: Object): void; @@ -5340,43 +5217,43 @@ class MashupDataSource { /** * Deletes a row from the data source. * - * @param rowId the record key - primaryKey (string) or index (number) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the record key - primaryKey (string) or index (number) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log */ deleteRow(rowId: Object, autoCommit: boolean): Object; /** * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back * - * @param data the transaction data + * @param data the transaction data */ addNode(data: Object): void; /** * Removes a node from the tree data source. Creates a transaction that can be committed / rolled back * - * @param data the transaction data + * @param data the transaction data */ removeNode(data: Object): void; /** * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source * - * @param t a transaction object + * @param t a transaction object */ getDetachedRecord(t: Object): Object; /** * Update the data source with every transaction from the log * - * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. + * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. */ commit(id?: number): void; /** * Clears the transaction log without updating anything in the data source * - * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. + * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. */ rollback(id?: Object): void; @@ -5398,16 +5275,16 @@ class MashupDataSource { /** * Posts to the settings.updateUrl using $.ajax, by serializing the changes as url params * - * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) - * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) + * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) + * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) */ saveChanges(success: Function, error: Function): void; /** * Gets a cell value from the record by the specified fieldName. If there's a mapper defined for the field, the resolved by the mapper value will be returned. * - * @param fieldName the fieldName - name of the field - * @param record the record from which to get it + * @param fieldName the fieldName - name of the field + * @param record the record from which to get it */ getCellValue(fieldName: string, record: Object): Object; @@ -5417,8 +5294,8 @@ class MashupDataSource { * If key or dsObj are not set then returns summaries data. * Takes summary data from passed argument dsObj(using argument key) * - * @param key response key to take summary data(for example "Metadata.Summaries") - * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) + * @param key response key to take summary data(for example "Metadata.Summaries") + * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) */ summariesResponse(key?: string, dsObj?: Object): Object; @@ -5435,8 +5312,8 @@ class MashupDataSource { * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] * - * @param fields an array of fields object definitions - * @param direction asc / desc direction + * @param fields an array of fields object definitions + * @param direction asc / desc direction */ sort(fields: Object, direction: string): void; @@ -5448,8 +5325,8 @@ class MashupDataSource { /** * Filters the data source locally by text. If "fields" parameter is set search is performed only in the listed fields otherwise all fields are searched. * - * @param expression a text to search for. Multiple search texts should be separated by space. When multiple search texts are provided all of them should be presented in the search fields (bool logic "and" is applied). - * @param fields an array of fields that will be searched. + * @param expression a text to search for. Multiple search texts should be separated by space. When multiple search texts are provided all of them should be presented in the search fields (bool logic "and" is applied). + * @param fields an array of fields that will be searched. */ filterByText(expression: string, fields?: any[]): void; @@ -5463,28 +5340,14 @@ class MashupDataSource { * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain * if expr is detected to be a regular expression, the "cond" part is skipped * To [filter by text](ig.datasource#methods:filterByText) "fieldExpressions" should have only one object with the following schema: + * {filterAllFields: , expr: , fields: } * - * @param fieldExpressions {filterAllFields: , expr: , fields: } - * - * ``` - * ds = new $.%%WidgetName%%({ - * type: "json", - * dataSource: adventureWorks, - * schema: jsonSchema - * }); - * ds.dataBind(); - * - * ds.filter([{fieldName : "Color", expr: "Red", cond: "Equals"}], "AND", true); - * - * // Filter by text - * ds.filter([{filterAllFields: true, expr: "abc", fields: [name: "Description", type: "string"]}]); - * ``` - * - * @param boolLogic a list of field expression definitions - * @param keepFilterState boolean logic. Accepted values are AND and OR. - * @param fieldExpressionsOnStrings a list of field expression definitions (or a string with the conditions separated by AND/OR operator, example: "ID = 1 OR ID = 2"), which when applied will threat the related field as if it's string and can only apply conditions valid for string types. + * @param fieldExpressions a list of field expression definitions + * @param boolLogic boolean logic. Accepted values are AND and OR. + * @param keepFilterState if keepFilterState is set to true, it will not discard previous filtering expressions + * @param fieldExpressionsOnStrings a list of field expression definitions (or a string with the conditions separated by AND/OR operator, example: "ID = 1 OR ID = 2"), which when applied will threat the related field as if it's string and can only apply conditions valid for string types. */ - filter(fieldExpressions: any[], boolLogic: Object, keepFilterState: Object, fieldExpressionsOnStrings: Object): void; + filter(fieldExpressions: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; /** * This clears local filtering applied to the data view by resetting it to the original data and applying any paging @@ -5498,7 +5361,7 @@ class MashupDataSource { * the actual total number of records may not * match the number of records that exists on the client * - * @param count the total number of records + * @param count the total number of records * @param key * @param dsObj * @param context @@ -5508,14 +5371,14 @@ class MashupDataSource { /** * Gets / sets if the response from the server contains a property which specifies the total number of records in the server-side backend * - * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend + * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend */ hasTotalRecordsCount(hasCount: boolean): void; /** * Returns metadata object for the specified key * - * @param key Primary key of the record + * @param key Primary key of the record */ metadata(key: string): Object; @@ -5532,14 +5395,14 @@ class MashupDataSource { /** * Gets /sets the current page index. If an index is passed as a parameter, the data source is re-bound. * - * @param index the page index. If none is specified, returns the current page index. + * @param index the page index. If none is specified, returns the current page index. */ pageIndex(index?: number): number; /** * Gets /sets the page index that should be persisted. For now ONLY when filtering is applied and call explicitly DataBind. * - * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. + * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. */ persistedPageIndex(value?: number): number; @@ -5556,7 +5419,7 @@ class MashupDataSource { /** * Gets /sets the page size and rebinds the data source if a parameter is specified. If no parameter is passed, returns the current page size * - * @param s the page size. + * @param s the page size. */ pageSize(s?: number): number; @@ -5570,28 +5433,28 @@ class MashupDataSource { /** * Returns a list of records for the specified page. Implies that paging is enabled. * - * @param p the page index for which records will be returned + * @param p the page index for which records will be returned */ recordsForPage(p: number): void; /** * Converts a HTML TABLE dom element to a JavaScript array of objects that contain the records data * - * @param tableDOM TABLE dom element to transform + * @param tableDOM TABLE dom element to transform */ tableToObject(tableDOM: Element): Object; /** * Parses the string and returns an evaluated JSON object * - * @param s the JSON as string. + * @param s the JSON as string. */ stringToJSONObject(s: string): void; /** * Parses a string and returns a XML Document * - * @param s the XML represented as a string + * @param s the XML represented as a string */ stringToXmlObject(s: string): void; @@ -5613,22 +5476,22 @@ class MashupDataSource { /** * Toggle grouped record with the specified id and updates collections visible groupby data and data view * - * @param id data-id attribute of the respective group row in the DOM - * @param collapsed if true the record should be collapsed, otherwise expanded + * @param id data-id attribute of the respective group row in the DOM + * @param collapsed if true the record should be collapsed, otherwise expanded */ toggleGroupByRecord(id: string, collapsed: boolean): void; /** * Check whether the specified gorupby record is collapsed * - * @param gbRec id of the grouped record OR grouped record + * @param gbRec id of the grouped record OR grouped record */ isGroupByRecordCollapsed(gbRec: Object): boolean; /** * Check whether grouping is applied for the specified sorting expressions. * - * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings + * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings */ isGroupByApplied(exprs?: any[]): boolean; } @@ -5921,16 +5784,16 @@ class TreeHierarchicalDataSource { * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView * 6. fire the databound event * - * @param callback callback function - * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context + * @param callback callback function + * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context */ dataBind(callback?: string, callee?: Object): void; /** * Gets the passed record's parent records * - * @param dataRow the child record. - * @param ds the data source in which to search for the related parent records. + * @param dataRow the child record. + * @param ds the data source in which to search for the related parent records. */ getParentRowsForRow(dataRow: Object, ds?: Object): Object; @@ -5942,31 +5805,31 @@ class TreeHierarchicalDataSource { /** * Gets/Sets whether the data source has been transformed from flat to hierarchical * - * @param isTransformed Determines if the data source is marked as transformed or not. + * @param isTransformed Determines if the data source is marked as transformed or not. */ isTransformedToHierarchicalData(isTransformed?: boolean): void; /** * Transforms flat data to hierararchical data and returns the result * - * @param data The flat data that will be transformed to hierarchical + * @param data The flat data that will be transformed to hierarchical */ transformToHierarchicalData(data: Object): Object; /** * This processes the passed data for the specified level and applies the schema transformation to it. * - * @param data The data to be processed and transformed - * @param level The level to which the data belongs to. If this is not set it defaults to 0. - * @param suppressTransformation Determines whether the data should go through schema transformation. If true schema transofrmatin will not be applied. + * @param data The data to be processed and transformed + * @param level The level to which the data belongs to. If this is not set it defaults to 0. + * @param suppressTransformation Determines whether the data should go through schema transformation. If true schema transofrmatin will not be applied. */ processDataPerLevel(data: Object, level?: number, suppressTransformation?: boolean): Object; /** * Returnschild data transformed to flat data * - * @param record The data record whose data is transformed and returned as flat - * @param level The level. If not set defaults to 0. + * @param record The data record whose data is transformed and returned as flat + * @param level The level. If not set defaults to 0. */ getFlatDataForRecord(record: Object, level?: number): Object; @@ -5974,8 +5837,8 @@ class TreeHierarchicalDataSource { * Generates flat data. * Returns an object that contains the generated flat data, the flat visible data, records count and visible records count. * - * @param data The data record whose data is transformed. - * @param level The level from which to start recursively generating the flat data. If not set defaults to 0. + * @param data The data record whose data is transformed. + * @param level The level from which to start recursively generating the flat data. If not set defaults to 0. */ generateFlatData(data: Object, level?: number): Object; @@ -6007,33 +5870,33 @@ class TreeHierarchicalDataSource { /** * Sets the expanded/collapsed state of a row by its index * - * @param index The index of the row. - * @param expanded If true then the row will be expanded. Otherwise it will be collapsed. - * @param callbackArgs Specifies a custom function to be called when the state of the row is changed. + * @param index The index of the row. + * @param expanded If true then the row will be expanded. Otherwise it will be collapsed. + * @param callbackArgs Specifies a custom function to be called when the state of the row is changed. */ setExpandedStateByRowIndex(index: number, expanded: boolean, callbackArgs: Function): void; /** * Sets the expanded state of a row by its primary key * - * @param rowId The id of the row. - * @param expanded If true the row will be expanded. Otherwise it will be collapsed. - * @param callbackArgs Specifies a custom function to be called when the state of the row is changed. + * @param rowId The id of the row. + * @param expanded If true the row will be expanded. Otherwise it will be collapsed. + * @param callbackArgs Specifies a custom function to be called when the state of the row is changed. */ setExpandedStateByPrimaryKey(rowId: string, expanded: boolean, callbackArgs: Function): void; /** * Gets whether the row with the specified id is expanded.Returns true if the row is expanded or false if it's not. * - * @param rowId //The id of the row. + * @param rowId //The id of the row. */ getExpandStateById(rowId: string): boolean; /** * Toggles the row's state by the row's id. * - * @param rowId The id of the row. - * @param callbackArgs Specifies a custom function to be called when the state of the row is changed. + * @param rowId The id of the row. + * @param callbackArgs Specifies a custom function to be called when the state of the row is changed. */ toggleRow(rowId: string, callbackArgs: Function): void; @@ -6045,8 +5908,8 @@ class TreeHierarchicalDataSource { * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] * - * @param fields an array of fields object definitions - * @param direction asc / desc direction + * @param fields an array of fields object definitions + * @param direction asc / desc direction */ sort(fields: Object, direction: string): void; @@ -6056,24 +5919,24 @@ class TreeHierarchicalDataSource { * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] * - * @param data the data array that will be sorted. - * @param level the level to which the data belongs to - * @param fields an array of fields object definitions - * @param direction asc / desc direction + * @param data the data array that will be sorted. + * @param level the level to which the data belongs to + * @param fields an array of fields object definitions + * @param direction asc / desc direction */ sortDataRecursive(data: Object, level: number, fields: Object, direction: string): void; /** * Sorts the passed data and returns the sorted result. * - * @param data the data to be sorted + * @param data the data to be sorted * * fields => an array of fields object definitions: * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] * - * @param fields an array of fields object definitions - * @param direction asc / desc direction + * @param fields an array of fields object definitions + * @param direction asc / desc direction */ sortData(data: Object, fields: Object, direction: string): void; @@ -6102,9 +5965,9 @@ class TreeHierarchicalDataSource { * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain * if expr is detected to be a regular expression, the "cond" part is skipped * - * @param fieldExpressions a list of field expression definitions - * @param boolLogic boolean logic. Accepted values are AND and OR. - * @param keepFilterState if keepFilterState is set to true, it will not discard previous filtering expressions + * @param fieldExpressions a list of field expression definitions + * @param boolLogic boolean logic. Accepted values are AND and OR. + * @param keepFilterState if keepFilterState is set to true, it will not discard previous filtering expressions * @param fieldExpressionsOnStrings */ filter(fieldExpressions: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; @@ -6132,7 +5995,7 @@ class TreeHierarchicalDataSource { /** * Clears __matchFiltering property from the data record objects in the filtered data source. The __matchFiltering property determines whether a record matches the specified filtering condition. * - * @param data the array of data objects to be cleared. If not set the current filtered data array is used. + * @param data the array of data objects to be cleared. If not set the current filtered data array is used. */ clearMatchFiltering(data?: Object): void; @@ -6146,16 +6009,16 @@ class TreeHierarchicalDataSource { /** * Returns a record by a specified key (requires that primaryKey is set in the settings) * - * @param key Primary key of the record - * @param ds the data source in which to search for the record. When not set it will use the current data source. - * @param objPath path to the object. Example: {path: '5/1'} + * @param key Primary key of the record + * @param ds the data source in which to search for the record. When not set it will use the current data source. + * @param objPath path to the object. Example: {path: '5/1'} */ findRecordByKey(key: Object, ds?: string, objPath?: Object): Object; /** * Removes a specific record denoted by the primaryKey of the passed key parameter from the data source * - * @param key primary key of the record + * @param key primary key of the record * @param origDs */ removeRecordByKey(key: Object, origDs: Object): void; @@ -6163,34 +6026,34 @@ class TreeHierarchicalDataSource { /** * Deletes a row from the data source. * - * @param rowId the record key - primaryKey (string) or index (number) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the record key - primaryKey (string) or index (number) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log */ deleteRow(rowId: Object, autoCommit: boolean): Object; /** * Gets the chilren records by the parent record's key in the passed data source * - * @param key primary key of the record - * @param ds the data source + * @param key primary key of the record + * @param ds the data source */ getChildrenByKey(key: Object, ds: Object): Object; /** * Adds a new row to the data source. Creates a transaction that can be committed / rolled back * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param rowIndex row index at which to be insert the new row - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - * @param parentRowId the value of the primary key of the parent row(if any) + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param rowIndex row index at which to be insert the new row + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param parentRowId the value of the primary key of the parent row(if any) */ insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: Object): Object; /** * Sets a list of fields to the data source. If no parameter is specified, just returns the already existing list of fields * - * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } + * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } */ fields(fields?: Object): Object; @@ -6227,36 +6090,36 @@ class TreeHierarchicalDataSource { /** * Gets/sets the schema definition. * - * @param s a schema object - * @param t type of the data source. See settings.type + * @param s a schema object + * @param t type of the data source. See settings.type */ schema(s?: Object, t?: string): void; /** * Gets/sets a list of paging settings * - * @param p object holding all paging settings. See settings.paging + * @param p object holding all paging settings. See settings.paging */ pagingSettings(p?: Object): Object; /** * Gets/sets a list of filtering settings * - * @param f object holding all filtering settings. See settings.filtering + * @param f object holding all filtering settings. See settings.filtering */ filterSettings(f?: Object): void; /** * Gets/sets a list of paging settings * - * @param s object holding all sorting settings. See settings.sorting + * @param s object holding all sorting settings. See settings.sorting */ sortSettings(s?: Object): Object; /** * Gets/sets a list of summaries settings. * - * @param s object holding all summaries settings. See settings.summaries + * @param s object holding all summaries settings. See settings.summaries */ summariesSettings(s?: Object): void; @@ -6278,7 +6141,7 @@ class TreeHierarchicalDataSource { /** * Removes a record from the data source at specific index. * - * @param index index of record + * @param index index of record * @param origDs */ removeRecordByIndex(index: number, origDs: Object): void; @@ -6286,63 +6149,63 @@ class TreeHierarchicalDataSource { /** * Sets a cell value for the cell denoted by rowId and colId. Creates a transaction for the update operation and returns it * - * @param rowId the rowId - row key (string) or index (number) - * @param colId the column id - column key (string) or index (number) - * @param val The new value - * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the rowId - row key (string) or index (number) + * @param colId the column id - column key (string) or index (number) + * @param val The new value + * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log */ setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; /** * Updates a record in the datasource. Creates a transaction that can be committed / rolled back * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log */ updateRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; /** * Adds a new row to the data source. Creates a transaction that can be committed / rolled back * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log */ addRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; /** * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back * - * @param data the transaction data + * @param data the transaction data */ addNode(data: Object): void; /** * Removes a node from the tree data source. Creates a transaction that can be committed / rolled back * - * @param data the transaction data + * @param data the transaction data */ removeNode(data: Object): void; /** * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source * - * @param t a transaction object + * @param t a transaction object */ getDetachedRecord(t: Object): Object; /** * Update the data source with every transaction from the log * - * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. + * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. */ commit(id?: number): void; /** * Clears the transaction log without updating anything in the data source * - * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. + * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. */ rollback(id?: Object): void; @@ -6364,16 +6227,16 @@ class TreeHierarchicalDataSource { /** * Posts to the settings.updateUrl using $.ajax, by serializing the changes as url params * - * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) - * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) + * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) + * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) */ saveChanges(success: Function, error: Function): void; /** * Gets a cell value from the record by the specified fieldName. If there's a mapper defined for the field, the resolved by the mapper value will be returned. * - * @param fieldName the fieldName - name of the field - * @param record the record from which to get it + * @param fieldName the fieldName - name of the field + * @param record the record from which to get it */ getCellValue(fieldName: string, record: Object): Object; @@ -6383,8 +6246,8 @@ class TreeHierarchicalDataSource { * If key or dsObj are not set then returns summaries data. * Takes summary data from passed argument dsObj(using argument key) * - * @param key response key to take summary data(for example "Metadata.Summaries") - * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) + * @param key response key to take summary data(for example "Metadata.Summaries") + * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) */ summariesResponse(key?: string, dsObj?: Object): Object; @@ -6401,8 +6264,8 @@ class TreeHierarchicalDataSource { /** * Filters the data source locally by text. If "fields" parameter is set search is performed only in the listed fields otherwise all fields are searched. * - * @param expression a text to search for. Multiple search texts should be separated by space. When multiple search texts are provided all of them should be presented in the search fields (bool logic "and" is applied). - * @param fields an array of fields that will be searched. + * @param expression a text to search for. Multiple search texts should be separated by space. When multiple search texts are provided all of them should be presented in the search fields (bool logic "and" is applied). + * @param fields an array of fields that will be searched. */ filterByText(expression: string, fields?: any[]): void; @@ -6413,7 +6276,7 @@ class TreeHierarchicalDataSource { * the actual total number of records may not * match the number of records that exists on the client * - * @param count the total number of records + * @param count the total number of records * @param key * @param dsObj * @param context @@ -6423,28 +6286,28 @@ class TreeHierarchicalDataSource { /** * Gets / sets if the response from the server contains a property which specifies the total number of records in the server-side backend * - * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend + * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend */ hasTotalRecordsCount(hasCount: boolean): void; /** * Returns metadata object for the specified key * - * @param key Primary key of the record + * @param key Primary key of the record */ metadata(key: string): Object; /** * Gets /sets the current page index. If an index is passed as a parameter, the data source is re-bound. * - * @param index the page index. If none is specified, returns the current page index. + * @param index the page index. If none is specified, returns the current page index. */ pageIndex(index?: number): number; /** * Gets /sets the page index that should be persisted. For now ONLY when filtering is applied and call explicitly DataBind. * - * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. + * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. */ persistedPageIndex(value?: number): number; @@ -6461,7 +6324,7 @@ class TreeHierarchicalDataSource { /** * Gets /sets the page size and rebinds the data source if a parameter is specified. If no parameter is passed, returns the current page size * - * @param s the page size. + * @param s the page size. */ pageSize(s?: number): number; @@ -6475,28 +6338,28 @@ class TreeHierarchicalDataSource { /** * Returns a list of records for the specified page. Implies that paging is enabled. * - * @param p the page index for which records will be returned + * @param p the page index for which records will be returned */ recordsForPage(p: number): void; /** * Converts a HTML TABLE dom element to a JavaScript array of objects that contain the records data * - * @param tableDOM TABLE dom element to transform + * @param tableDOM TABLE dom element to transform */ tableToObject(tableDOM: Element): Object; /** * Parses the string and returns an evaluated JSON object * - * @param s the JSON as string. + * @param s the JSON as string. */ stringToJSONObject(s: string): void; /** * Parses a string and returns a XML Document * - * @param s the XML represented as a string + * @param s the XML represented as a string */ stringToXmlObject(s: string): void; @@ -6518,22 +6381,22 @@ class TreeHierarchicalDataSource { /** * Toggle grouped record with the specified id and updates collections visible groupby data and data view * - * @param id data-id attribute of the respective group row in the DOM - * @param collapsed if true the record should be collapsed, otherwise expanded + * @param id data-id attribute of the respective group row in the DOM + * @param collapsed if true the record should be collapsed, otherwise expanded */ toggleGroupByRecord(id: string, collapsed: boolean): void; /** * Check whether the specified gorupby record is collapsed * - * @param gbRec id of the grouped record OR grouped record + * @param gbRec id of the grouped record OR grouped record */ isGroupByRecordCollapsed(gbRec: Object): boolean; /** * Check whether grouping is applied for the specified sorting expressions. * - * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings + * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings */ isGroupByApplied(exprs?: any[]): boolean; } @@ -6566,6 +6429,7 @@ interface SimpleTextMarkerTemplateSettings { declare namespace Infragistics { class SimpleTextMarkerTemplate { constructor(requireThis: boolean); + constructor(settings: SimpleTextMarkerTemplateSettings); getText(item: Object, textDelegate: Object): void; measure(measureInfo: Object): void; @@ -6847,14 +6711,15 @@ interface GridExcelExporterSettings { declare namespace Infragistics { class GridExcelExporter { constructor(callbacks: GridExcelExporterCallbacks); + constructor(settings: GridExcelExporterSettings); /** * Exports the provided igGrid to Excel document. * - * @param grid Grid to be exported. - * @param userSettings Settings for exporting the grid. - * @param userCallbacks Callbacks for the events. + * @param grid Grid to be exported. + * @param userSettings Settings for exporting the grid. + * @param userCallbacks Callbacks for the events. */ exportGrid(grid: Object, userSettings: Object, userCallbacks: Object): void; } @@ -8806,9 +8671,9 @@ class igTemplating { /** * Populates the given template with the provided data. If data is a function that requires arguments, the arguments need to be provided as an array following the data. tmpl(template, data[, args]) * - * @param template Specifies the template string - * @param data Specifies the data to be templated in the template. If function is provided, then it has to be object or array returning function, possible receiving arguments array which can be specified as the third parameter - * @param args If function is provided as the second parameter, then this parameter is the arguments for the function. + * @param template Specifies the template string + * @param data Specifies the data to be templated in the template. If function is provided, then it has to be object or array returning function, possible receiving arguments array which can be specified as the third parameter + * @param args If function is provided as the second parameter, then this parameter is the arguments for the function. */ tmpl(template: string, data: Object, args?: any[]): string; clearTmplCache(): void; @@ -8816,7 +8681,7 @@ class igTemplating { /** * Encoding < > ' and " * - * @param value The string to be encoded. + * @param value The string to be encoded. */ encode(value: string): string; } @@ -8868,13 +8733,6 @@ interface IgQRCodeBarcode { */ height?: string|number; - /** - * Gets or sets the scaling value used to affect the pixel density of the control. - * A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control - * to appear blurry. - */ - pixelScalingRatio?: number; - /** * Gets or sets the brush to use to fill the backing of the barcode. */ @@ -9102,6 +8960,7 @@ interface JQuery { /** * The width of the barcode. It can be set as a number in pixels, string (px) or percentage (%). */ + igQRCodeBarcode(optionLiteral: 'option', optionName: "width"): string|number; /** @@ -9109,11 +8968,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igQRCodeBarcode(optionLiteral: 'option', optionName: "width", optionValue: string|number): void; /** * The height of the barcode. It can be set as a number in pixels, string (px) or percentage (%). */ + igQRCodeBarcode(optionLiteral: 'option', optionName: "height"): string|number; /** @@ -9121,24 +8982,9 @@ interface JQuery { * * @optionValue New value to be set. */ + igQRCodeBarcode(optionLiteral: 'option', optionName: "height", optionValue: string|number): void; - /** - * Gets the scaling value used to affect the pixel density of the control. - * A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control - * to appear blurry. - */ - igQRCodeBarcode(optionLiteral: 'option', optionName: "pixelScalingRatio"): number; - - /** - * Sets the scaling value used to affect the pixel density of the control. - * A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control - * to appear blurry. - * - * @optionValue New value to be set. - */ - igQRCodeBarcode(optionLiteral: 'option', optionName: "pixelScalingRatio", optionValue: number): void; - /** * Gets the brush to use to fill the backing of the barcode. */ @@ -9238,6 +9084,7 @@ interface JQuery { /** * Gets the stretch. */ + igQRCodeBarcode(optionLiteral: 'option', optionName: "stretch"): string; /** @@ -9245,11 +9092,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igQRCodeBarcode(optionLiteral: 'option', optionName: "stretch", optionValue: string): void; /** * Gets a value which specifies how the grid fills within the barcode control dimensions. */ + igQRCodeBarcode(optionLiteral: 'option', optionName: "barsFillMode"): string; /** @@ -9257,6 +9106,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igQRCodeBarcode(optionLiteral: 'option', optionName: "barsFillMode", optionValue: string): void; /** @@ -9286,6 +9136,7 @@ interface JQuery { /** * Gets the error correction level of the QR Code symbol. */ + igQRCodeBarcode(optionLiteral: 'option', optionName: "errorCorrectionLevel"): string; /** @@ -9293,11 +9144,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igQRCodeBarcode(optionLiteral: 'option', optionName: "errorCorrectionLevel", optionValue: string): void; /** * Gets the size version of the QR Code symbol. */ + igQRCodeBarcode(optionLiteral: 'option', optionName: "sizeVersion"): string; /** @@ -9305,11 +9158,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igQRCodeBarcode(optionLiteral: 'option', optionName: "sizeVersion", optionValue: string): void; /** * Gets the encoding mode for compaction of the QR Code symbol data. The default value is undefined if the Shift_JIS encoding is loaded. Otherwise the default value is byte. */ + igQRCodeBarcode(optionLiteral: 'option', optionName: "encodingMode"): string; /** @@ -9317,6 +9172,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igQRCodeBarcode(optionLiteral: 'option', optionName: "encodingMode", optionValue: string): void; /** @@ -9336,6 +9192,7 @@ interface JQuery { /** * Gets a value indicating whether to show the ECI header. */ + igQRCodeBarcode(optionLiteral: 'option', optionName: "eciHeaderDisplayMode"): string; /** @@ -9343,11 +9200,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igQRCodeBarcode(optionLiteral: 'option', optionName: "eciHeaderDisplayMode", optionValue: string): void; /** * Gets the FNC1 mode indicator which identifies symbols encoding messages formatted according to specific predefined industry or application specificatoins. */ + igQRCodeBarcode(optionLiteral: 'option', optionName: "fnc1Mode"): string; /** @@ -9355,6 +9214,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igQRCodeBarcode(optionLiteral: 'option', optionName: "fnc1Mode", optionValue: string): void; /** @@ -9605,14 +9465,14 @@ interface IgBaseChartMethods { /** * Find index of item within actual data used by chart. * - * @param item The reference to item. + * @param item The reference to item. */ findIndexOfItem(item: Object): number; /** * Get item within actual data used by chart. That is similar to this.getData()[ index ]. * - * @param index Index of data item. + * @param index Index of data item. */ getDataItem(index: Object): Object; @@ -9624,40 +9484,40 @@ interface IgBaseChartMethods { /** * Adds a new item to the data source and notifies the chart. * - * @param item The item that we want to add to the data source. + * @param item The item that we want to add to the data source. */ addItem(item: Object): Object; /** * Inserts a new item to the data source and notifies the chart. * - * @param item the new item that we want to insert in the data source. - * @param index The index in the data source where the new item will be inserted. + * @param item the new item that we want to insert in the data source. + * @param index The index in the data source where the new item will be inserted. */ insertItem(item: Object, index: number): Object; /** * Deletes an item from the data source and notifies the chart. * - * @param index The index in the data source from where the item will be been removed. + * @param index The index in the data source from where the item will be been removed. */ removeItem(index: number): Object; /** * Updates an item in the data source and notifies the chart. * - * @param index The index of the item in the data source that we want to change. - * @param item The new item object that will be set in the data source. + * @param index The index of the item in the data source that we want to change. + * @param item The new item object that will be set in the data source. */ setItem(index: number, item: Object): Object; /** * Notifies the chart that an item has been set in an associated data source. * - * @param dataSource The data source in which the change happened. - * @param index The index in the items source that has been changed. - * @param newItem the new item that has been set in the collection. - * @param oldItem the old item that has been overwritten in the collection. + * @param dataSource The data source in which the change happened. + * @param index The index in the items source that has been changed. + * @param newItem the new item that has been set in the collection. + * @param oldItem the old item that has been overwritten in the collection. */ notifySetItem(dataSource: Object, index: number, newItem: Object, oldItem: Object): Object; @@ -9665,7 +9525,7 @@ interface IgBaseChartMethods { * Notifies the chart that the items have been cleared from an associated data source. * It's not necessary to notify more than one target of a change if they share the same items source. * - * @param dataSource The data source in which the change happened. + * @param dataSource The data source in which the change happened. */ notifyClearItems(dataSource: Object): Object; @@ -9673,9 +9533,9 @@ interface IgBaseChartMethods { * Notifies the target axis or series that an item has been inserted at the specified index in its data source. * It's not necessary to notify more than one target of a change if they share the same items source. * - * @param dataSource The data source in which the change happened. - * @param index The index in the items source where the new item has been inserted. - * @param newItem the new item that has been set in the collection. + * @param dataSource The data source in which the change happened. + * @param index The index in the items source where the new item has been inserted. + * @param newItem the new item that has been set in the collection. */ notifyInsertItem(dataSource: Object, index: number, newItem: Object): Object; @@ -9683,9 +9543,9 @@ interface IgBaseChartMethods { * Notifies the target axis or series that an item has been removed from the specified index in its data source. * It's not necessary to notify more than one target of a change if they share the same items source. * - * @param dataSource The data source in which the change happened. - * @param index The index in the items source from where the old item has been removed. - * @param oldItem the old item that has been removed from the collection. + * @param dataSource The data source in which the change happened. + * @param index The index in the items source from where the old item has been removed. + * @param oldItem the old item that has been removed from the collection. */ notifyRemoveItem(dataSource: Object, index: number, oldItem: Object): Object; @@ -10450,21 +10310,21 @@ interface IgBulletGraphMethods { /** * Adds a new range to the bullet graph. * - * @param value The range object to be added. + * @param value The range object to be added. */ addRange(value: Object): void; /** * Removes a range from the bullet graph. * - * @param value A JS object with properties set as follows: name: nameOfTheRangeToRemove, remove: true + * @param value A JS object with properties set as follows: name: nameOfTheRangeToRemove, remove: true */ removeRange(value: Object): void; /** * Updates the specified range of the bullet graph. * - * @param value The range object to be updated. + * @param value The range object to be updated. */ updateRange(value: Object): void; @@ -10505,6 +10365,7 @@ interface JQuery { /** * The width of the gauge. It can be set as a number in pixels, string (px) or percentage (%). */ + igBulletGraph(optionLiteral: 'option', optionName: "width"): string|number; /** @@ -10512,11 +10373,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igBulletGraph(optionLiteral: 'option', optionName: "width", optionValue: string|number): void; /** * The height of the gauge. It can be set as a number in pixels, string (px) or percentage (%). */ + igBulletGraph(optionLiteral: 'option', optionName: "height"): string|number; /** @@ -10524,6 +10387,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igBulletGraph(optionLiteral: 'option', optionName: "height", optionValue: string|number): void; /** @@ -10577,6 +10441,7 @@ interface JQuery { /** * Gets the orientation of the scale. */ + igBulletGraph(optionLiteral: 'option', optionName: "orientation"): string; /** @@ -10584,6 +10449,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igBulletGraph(optionLiteral: 'option', optionName: "orientation", optionValue: string): void; /** @@ -11335,8 +11201,7 @@ interface PropertyChangedEvent { (event: Event, ui: PropertyChangedEventUIParam): void; } -interface PropertyChangedEventUIParam { -} +interface PropertyChangedEventUIParam {} interface IgCategoryChart { /** @@ -12231,14 +12096,14 @@ interface IgCategoryChartMethods { /** * Find index of item within actual data used by chart. * - * @param item The reference to item. + * @param item The reference to item. */ findIndexOfItem(item: Object): number; /** * Get item within actual data used by chart. That is similar to this.getData()[ index ]. * - * @param index Index of data item. + * @param index Index of data item. */ getDataItem(index: Object): Object; @@ -12250,40 +12115,40 @@ interface IgCategoryChartMethods { /** * Adds a new item to the data source and notifies the chart. * - * @param item The item that we want to add to the data source. + * @param item The item that we want to add to the data source. */ addItem(item: Object): Object; /** * Inserts a new item to the data source and notifies the chart. * - * @param item the new item that we want to insert in the data source. - * @param index The index in the data source where the new item will be inserted. + * @param item the new item that we want to insert in the data source. + * @param index The index in the data source where the new item will be inserted. */ insertItem(item: Object, index: number): Object; /** * Deletes an item from the data source and notifies the chart. * - * @param index The index in the data source from where the item will be been removed. + * @param index The index in the data source from where the item will be been removed. */ removeItem(index: number): Object; /** * Updates an item in the data source and notifies the chart. * - * @param index The index of the item in the data source that we want to change. - * @param item The new item object that will be set in the data source. + * @param index The index of the item in the data source that we want to change. + * @param item The new item object that will be set in the data source. */ setItem(index: number, item: Object): Object; /** * Notifies the chart that an item has been set in an associated data source. * - * @param dataSource The data source in which the change happened. - * @param index The index in the items source that has been changed. - * @param newItem the new item that has been set in the collection. - * @param oldItem the old item that has been overwritten in the collection. + * @param dataSource The data source in which the change happened. + * @param index The index in the items source that has been changed. + * @param newItem the new item that has been set in the collection. + * @param oldItem the old item that has been overwritten in the collection. */ notifySetItem(dataSource: Object, index: number, newItem: Object, oldItem: Object): Object; @@ -12291,7 +12156,7 @@ interface IgCategoryChartMethods { * Notifies the chart that the items have been cleared from an associated data source. * It's not necessary to notify more than one target of a change if they share the same items source. * - * @param dataSource The data source in which the change happened. + * @param dataSource The data source in which the change happened. */ notifyClearItems(dataSource: Object): Object; @@ -12299,9 +12164,9 @@ interface IgCategoryChartMethods { * Notifies the target axis or series that an item has been inserted at the specified index in its data source. * It's not necessary to notify more than one target of a change if they share the same items source. * - * @param dataSource The data source in which the change happened. - * @param index The index in the items source where the new item has been inserted. - * @param newItem the new item that has been set in the collection. + * @param dataSource The data source in which the change happened. + * @param index The index in the items source where the new item has been inserted. + * @param newItem the new item that has been set in the collection. */ notifyInsertItem(dataSource: Object, index: number, newItem: Object): Object; @@ -12309,9 +12174,9 @@ interface IgCategoryChartMethods { * Notifies the target axis or series that an item has been removed from the specified index in its data source. * It's not necessary to notify more than one target of a change if they share the same items source. * - * @param dataSource The data source in which the change happened. - * @param index The index in the items source from where the old item has been removed. - * @param oldItem the old item that has been removed from the collection. + * @param dataSource The data source in which the change happened. + * @param index The index in the items source from where the old item has been removed. + * @param oldItem the old item that has been removed from the collection. */ notifyRemoveItem(dataSource: Object, index: number, oldItem: Object): Object; @@ -12884,13 +12749,7 @@ interface JQuery { * @optionValue New value to be set. */ igCategoryChart(optionLiteral: 'option', optionName: "yAxisTitleTextColor", optionValue: string): void; - - /** - */ igCategoryChart(optionLiteral: 'option', optionName: "createWrappedTooltip"): any; - - /** - */ igCategoryChart(optionLiteral: 'option', optionName: "createWrappedTooltip", optionValue: any): void; /** @@ -12904,13 +12763,7 @@ interface JQuery { * @optionValue New value to be set. */ igCategoryChart(optionLiteral: 'option', optionName: "tooltipTemplate", optionValue: string): void; - - /** - */ igCategoryChart(optionLiteral: 'option', optionName: "tooltipTemplates"): any; - - /** - */ igCategoryChart(optionLiteral: 'option', optionName: "tooltipTemplates", optionValue: any): void; /** @@ -12960,13 +12813,7 @@ interface JQuery { * @optionValue New value to be set. */ igCategoryChart(optionLiteral: 'option', optionName: "yAxisTitleTextStyle", optionValue: string): void; - - /** - */ igCategoryChart(optionLiteral: 'option', optionName: "widget"): any; - - /** - */ igCategoryChart(optionLiteral: 'option', optionName: "widget", optionValue: any): void; /** @@ -13058,6 +12905,7 @@ interface JQuery { /** * Gets the type of chart series to generate from the data. */ + igCategoryChart(optionLiteral: 'option', optionName: "chartType"): string; /** @@ -13065,6 +12913,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igCategoryChart(optionLiteral: 'option', optionName: "chartType", optionValue: string): void; /** @@ -13176,6 +13025,7 @@ interface JQuery { /** * Gets horizontal alignment which determines the title position, relative to the left and right edges of the chart. */ + igCategoryChart(optionLiteral: 'option', optionName: "titleAlignment"): string; /** @@ -13183,11 +13033,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igCategoryChart(optionLiteral: 'option', optionName: "titleAlignment", optionValue: string): void; /** * Gets horizontal alignment which determines the subtitle position, relative to the left and right edges of the chart. */ + igCategoryChart(optionLiteral: 'option', optionName: "subtitleAlignment"): string; /** @@ -13195,12 +13047,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igCategoryChart(optionLiteral: 'option', optionName: "subtitleAlignment", optionValue: string): void; /** * Gets the behavior that determines how unknown values will be plotted on the chart.Null and Double.NaN are two examples of unknown values. * */ + igCategoryChart(optionLiteral: 'option', optionName: "unknownValuePlotting"): string; /** @@ -13209,11 +13063,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igCategoryChart(optionLiteral: 'option', optionName: "unknownValuePlotting", optionValue: string): void; /** * Gets the behavior for markers in each series which are placed too close together for the current view, resulting in a collision. */ + igCategoryChart(optionLiteral: 'option', optionName: "markerCollisionAvoidance"): string; /** @@ -13221,6 +13077,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igCategoryChart(optionLiteral: 'option', optionName: "markerCollisionAvoidance", optionValue: string): void; /** @@ -13238,6 +13095,7 @@ interface JQuery { /** * Gets the method that determines how to animate series plots when the chart is loading into view */ + igCategoryChart(optionLiteral: 'option', optionName: "transitionInMode"): string; /** @@ -13245,11 +13103,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igCategoryChart(optionLiteral: 'option', optionName: "transitionInMode", optionValue: string): void; /** * Gets the arrival speed used for animating series plots when the chart is loading into view */ + igCategoryChart(optionLiteral: 'option', optionName: "transitionInSpeedType"): string; /** @@ -13257,6 +13117,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igCategoryChart(optionLiteral: 'option', optionName: "transitionInSpeedType", optionValue: string): void; /** @@ -13734,6 +13595,7 @@ interface JQuery { /** * Gets the formula used for calculating trend lines in this chart. */ + igCategoryChart(optionLiteral: 'option', optionName: "trendLineType"): string; /** @@ -13741,6 +13603,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igCategoryChart(optionLiteral: 'option', optionName: "trendLineType", optionValue: string): void; /** @@ -13850,6 +13713,7 @@ interface JQuery { /** * Gets the horizontal alignment of the X-axis title. */ + igCategoryChart(optionLiteral: 'option', optionName: "xAxisTitleAlignment"): string; /** @@ -13857,11 +13721,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igCategoryChart(optionLiteral: 'option', optionName: "xAxisTitleAlignment", optionValue: string): void; /** * Gets the vertical alignment of the Y-axis title. */ + igCategoryChart(optionLiteral: 'option', optionName: "yAxisTitleAlignment"): string; /** @@ -13869,11 +13735,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igCategoryChart(optionLiteral: 'option', optionName: "yAxisTitleAlignment", optionValue: string): void; /** * Gets the horizontal alignment of X-axis labels. */ + igCategoryChart(optionLiteral: 'option', optionName: "xAxisLabelHorizontalAlignment"): string; /** @@ -13881,11 +13749,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igCategoryChart(optionLiteral: 'option', optionName: "xAxisLabelHorizontalAlignment", optionValue: string): void; /** * Gets the horizontal alignment of Y-axis labels. */ + igCategoryChart(optionLiteral: 'option', optionName: "yAxisLabelHorizontalAlignment"): string; /** @@ -13893,11 +13763,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igCategoryChart(optionLiteral: 'option', optionName: "yAxisLabelHorizontalAlignment", optionValue: string): void; /** * Gets the vertical alignment of X-axis labels. */ + igCategoryChart(optionLiteral: 'option', optionName: "xAxisLabelVerticalAlignment"): string; /** @@ -13905,11 +13777,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igCategoryChart(optionLiteral: 'option', optionName: "xAxisLabelVerticalAlignment", optionValue: string): void; /** * Gets the vertical alignment of Y-axis labels. */ + igCategoryChart(optionLiteral: 'option', optionName: "yAxisLabelVerticalAlignment"): string; /** @@ -13917,11 +13791,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igCategoryChart(optionLiteral: 'option', optionName: "yAxisLabelVerticalAlignment", optionValue: string): void; /** * Gets the visibility of X-axis labels. */ + igCategoryChart(optionLiteral: 'option', optionName: "xAxisLabelVisibility"): string; /** @@ -13929,11 +13805,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igCategoryChart(optionLiteral: 'option', optionName: "xAxisLabelVisibility", optionValue: string): void; /** * Gets the visibility of Y-axis labels. */ + igCategoryChart(optionLiteral: 'option', optionName: "yAxisLabelVisibility"): string; /** @@ -13941,6 +13819,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igCategoryChart(optionLiteral: 'option', optionName: "yAxisLabelVisibility", optionValue: string): void; /** @@ -15541,8 +15420,7 @@ interface BrowserNotSupportedEvent { (event: Event, ui: BrowserNotSupportedEventUIParam): void; } -interface BrowserNotSupportedEventUIParam { -} +interface BrowserNotSupportedEventUIParam {} interface SeriesCursorMouseMoveEvent { (event: Event, ui: SeriesCursorMouseMoveEventUIParam): void; @@ -16910,8 +16788,8 @@ interface IgDataChartMethods { /** * Exports the chart to a PNG image. * - * @param width The width of the image. - * @param height The height of the image. + * @param width The width of the image. + * @param height The height of the image. */ exportImage(width?: Object, height?: Object): Object; @@ -16933,44 +16811,44 @@ interface IgDataChartMethods { /** * Adds a new item to the data source and notifies the chart. * - * @param item The item that we want to add to the data source. - * @param targetName The name of the series or axis bound to the data source. This is required only when the data is bound to series or axis. If the data is bound to dataSource of igDataChart, the second parameter should not be set. + * @param item The item that we want to add to the data source. + * @param targetName The name of the series or axis bound to the data source. This is required only when the data is bound to series or axis. If the data is bound to dataSource of igDataChart, the second parameter should not be set. */ addItem(item: Object, targetName: string): void; /** * Inserts a new item to the data source and notifies the chart. * - * @param item the new item that we want to insert in the data source. - * @param index The index in the data source where the new item will be inserted. - * @param targetName The name of the series or axis bound to the data source. + * @param item the new item that we want to insert in the data source. + * @param index The index in the data source where the new item will be inserted. + * @param targetName The name of the series or axis bound to the data source. */ insertItem(item: Object, index: number, targetName: string): void; /** * Deletes an item from the data source and notifies the chart. * - * @param index The index in the data source from where the item will be been removed. - * @param targetName The name of the series or axis bound to the data source. This is required only when the data is bound to series or axis. If the data is bound to dataSource of igDataChart, the second parameter should not be set. + * @param index The index in the data source from where the item will be been removed. + * @param targetName The name of the series or axis bound to the data source. This is required only when the data is bound to series or axis. If the data is bound to dataSource of igDataChart, the second parameter should not be set. */ removeItem(index: number, targetName: string): void; /** * Updates an item in the data source and notifies the chart. * - * @param index The index of the item in the data source that we want to change. - * @param item The new item object that will be set in the data source. - * @param targetName The name of the series or axis bound to the data source. + * @param index The index of the item in the data source that we want to change. + * @param item The new item object that will be set in the data source. + * @param targetName The name of the series or axis bound to the data source. */ setItem(index: number, item: Object, targetName: string): void; /** * Notifies the chart that an item has been set in an associated data source. * - * @param dataSource The data source in which the change happened. - * @param index The index in the items source that has been changed. - * @param newItem the new item that has been set in the collection. - * @param oldItem the old item that has been overwritten in the collection. + * @param dataSource The data source in which the change happened. + * @param index The index in the items source that has been changed. + * @param newItem the new item that has been set in the collection. + * @param oldItem the old item that has been overwritten in the collection. */ notifySetItem(dataSource: Object, index: number, newItem: Object, oldItem: Object): Object; @@ -16978,7 +16856,7 @@ interface IgDataChartMethods { * Notifies the chart that the items have been cleared from an associated data source. * It's not necessary to notify more than one target of a change if they share the same items source. * - * @param dataSource The data source in which the change happened. + * @param dataSource The data source in which the change happened. */ notifyClearItems(dataSource: Object): Object; @@ -16986,9 +16864,9 @@ interface IgDataChartMethods { * Notifies the target axis or series that an item has been inserted at the specified index in its data source. * It's not necessary to notify more than one target of a change if they share the same items source. * - * @param dataSource The data source in which the change happened. - * @param index The index in the items source where the new item has been inserted. - * @param newItem the new item that has been set in the collection. + * @param dataSource The data source in which the change happened. + * @param index The index in the items source where the new item has been inserted. + * @param newItem the new item that has been set in the collection. */ notifyInsertItem(dataSource: Object, index: number, newItem: Object): Object; @@ -16996,17 +16874,17 @@ interface IgDataChartMethods { * Notifies the target axis or series that an item has been removed from the specified index in its data source. * It's not necessary to notify more than one target of a change if they share the same items source. * - * @param dataSource The data source in which the change happened. - * @param index The index in the items source from where the old item has been removed. - * @param oldItem the old item that has been removed from the collection. + * @param dataSource The data source in which the change happened. + * @param index The index in the items source from where the old item has been removed. + * @param oldItem the old item that has been removed from the collection. */ notifyRemoveItem(dataSource: Object, index: number, oldItem: Object): Object; /** * Notifies the target axis or series that it should scroll the requested data item into view. * - * @param targetName The name of the axis or series notify. - * @param item The data item to bring into view, if possible. + * @param targetName The name of the axis or series notify. + * @param item The data item to bring into view, if possible. */ scrollIntoView(targetName: string, item: Object): Object; @@ -17014,8 +16892,8 @@ interface IgDataChartMethods { * Notifies the target axis that it should scale the requested value into chart space from axis space. * For example you can use this method if you want to find where value 50 of the x axis stands scaled to chart's width. * - * @param targetName The name of the axis to notify. - * @param unscaledValue The value in axis space to translate into chart space. + * @param targetName The name of the axis to notify. + * @param unscaledValue The value in axis space to translate into chart space. */ scaleValue(targetName: string, unscaledValue: number): number; @@ -17023,22 +16901,22 @@ interface IgDataChartMethods { * Notifies the target axis that it should unscale the requested value into axis space from chart space. * For example you can use this method if you want to find what is the value of x axis unscaled from 0 width of the chart. * - * @param targetName The name of the axis to notify. - * @param scaledValue The value in chart space to translate into axis space. + * @param targetName The name of the axis to notify. + * @param scaledValue The value in chart space to translate into axis space. */ unscaleValue(targetName: string, scaledValue: number): number; /** * For the target axis, if using enhanced interval management and precise interval fitting, this will reset the cached maximum label width, and recalculate using the current labels. * - * @param targetName The name of the axis to notify. + * @param targetName The name of the axis to notify. */ resetCachedEnhancedInterval(targetName: string): Object; /** * Notifies the target series that something that affects its visual properties has changed and the visual output needs a repaint. * - * @param targetName The name of the series to notify. + * @param targetName The name of the series to notify. */ notifyVisualPropertiesChanged(targetName: string): Object; @@ -17055,21 +16933,21 @@ interface IgDataChartMethods { /** * Gets the actual minimum value of the target numeric or date time axis * - * @param targetName The name of the axis from which to get the minimum value. + * @param targetName The name of the axis from which to get the minimum value. */ getActualMinimumValue(targetName: string): void; /** * Gets the actual maximum value of the target numeric or date time axis * - * @param targetName The name of the axis from which to get the maximum value. + * @param targetName The name of the axis from which to get the maximum value. */ getActualMaximumValue(targetName: string): void; /** * Gets the actual interval of the target numeric or date time axis * - * @param targetName The name of the axis from which to get the interval. + * @param targetName The name of the axis from which to get the interval. */ getActualInterval(targetName: string): void; @@ -17081,236 +16959,236 @@ interface IgDataChartMethods { /** * Indicates that a series should render, even though no option has been modified that would normally cause it to refresh. * - * @param targetName The name of the series to render. - * @param animate Whether the change should be animated, if possible. + * @param targetName The name of the series to render. + * @param animate Whether the change should be animated, if possible. */ renderSeries(targetName: string, animate: boolean): void; /** * Gets the item item index associated with the specified world position. * - * @param targetName The name of the series to target. - * @param worldPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} ) that represents a position in the space of the axes. + * @param targetName The name of the series to target. + * @param worldPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} ) that represents a position in the space of the axes. */ getItemIndex(targetName: string, worldPoint: Object): number; /** * Gets the item that is the best match for the specified world coordinates. * - * @param targetName The name of the series to target. - * @param worldPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} ) that represents a position in the space of the axes. + * @param targetName The name of the series to target. + * @param worldPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} ) that represents a position in the space of the axes. */ getItem(targetName: string, worldPoint: Object): Object; /** * For a category plotted series, gets the current width of the items within the categories. This only returns a value if the items have some form of width (e.g. columns, bars, etc.) otherwise 0 is returned. * - * @param targetName The name of the series to target. + * @param targetName The name of the series to target. */ getItemSpan(targetName: string): number; /** * If possible, will return the best available main value of the series for a given world coordinate. * - * @param targetName The name of the series to target. - * @param worldPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} ) that represents a position in the space of the axes. - * @param useInterpolation If true, interpolation should be used to get in-between values, rather than only the actual values in the data set. - * @param skipUnknowns If true, unknown values should be skipped. + * @param targetName The name of the series to target. + * @param worldPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} ) that represents a position in the space of the axes. + * @param useInterpolation If true, interpolation should be used to get in-between values, rather than only the actual values in the data set. + * @param skipUnknowns If true, unknown values should be skipped. */ getSeriesValue(targetName: string, worldPoint: Object, useInterpolation: boolean, skipUnknowns: boolean): number; /** * If possible, will return the best available value bounding box within the series that has the best value match for the world position provided. * - * @param targetName The name of the series to target. - * @param worldPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} ) that represents a position in the space of the axes. + * @param targetName The name of the series to target. + * @param worldPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} ) that represents a position in the space of the axes. */ getSeriesValueBoundingBox(targetName: string, worldPoint: Object): Object; /** * If possible, will return the best available value fine grained bounding boxes within the series that have the best value match for the world position provided. * - * @param targetName The name of the series to target. - * @param worldPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} ) that represents a position in the space of the axes. + * @param targetName The name of the series to target. + * @param worldPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} ) that represents a position in the space of the axes. */ getSeriesValueFineGrainedBoundingBoxes(targetName: string, worldPoint: Object): Object; /** * If possible, will return the best available main value position of the series for a given world coordinate. * - * @param targetName The name of the series to target. - * @param worldPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} ) that represents a position in the space of the axes. - * @param useInterpolation If true, interpolation should be used to get in-between values, rather than only the actual values in the data set. - * @param skipUnknowns If true, unknown values should be skipped. + * @param targetName The name of the series to target. + * @param worldPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} ) that represents a position in the space of the axes. + * @param useInterpolation If true, interpolation should be used to get in-between values, rather than only the actual values in the data set. + * @param skipUnknowns If true, unknown values should be skipped. */ getSeriesValuePosition(targetName: string, worldPoint: Object, useInterpolation: boolean, skipUnknowns: boolean): Object; /** * If possible, will return the best available main value position of the series for a given world coordinate. * - * @param targetName The name of the series to target. - * @param seriesPoint The series pixel position (in the form {x: [number], y: [number]} that represents a position within the pixel space of the series. - * @param useInterpolation If true, interpolation should be used to get in-between values, rather than only the actual values in the data set. - * @param skipUnknowns If true, unknown values should be skipped. + * @param targetName The name of the series to target. + * @param seriesPoint The series pixel position (in the form {x: [number], y: [number]} that represents a position within the pixel space of the series. + * @param useInterpolation If true, interpolation should be used to get in-between values, rather than only the actual values in the data set. + * @param skipUnknowns If true, unknown values should be skipped. */ getSeriesValuePositionFromSeriesPixel(targetName: string, seriesPoint: Object, useInterpolation: boolean, skipUnknowns: boolean): Object; /** * If possible, will return the best available main value of the series for a given world coordinate. * - * @param targetName The name of the series to target. - * @param seriesPoint The series pixel position (in the form {x: [number], y: [number]} ) that represents a position in the pixel space of the series. - * @param useInterpolation If true, interpolation should be used to get in-between values, rather than only the actual values in the data set. - * @param skipUnknowns If true, unknown values should be skipped. + * @param targetName The name of the series to target. + * @param seriesPoint The series pixel position (in the form {x: [number], y: [number]} ) that represents a position in the pixel space of the series. + * @param useInterpolation If true, interpolation should be used to get in-between values, rather than only the actual values in the data set. + * @param skipUnknowns If true, unknown values should be skipped. */ getSeriesValueFromSeriesPixel(targetName: string, seriesPoint: Object, useInterpolation: boolean, skipUnknowns: boolean): number; /** * If possible, will return the best available value bounding box within the series that has the best value match for the given series pixel coordinate. * - * @param targetName The name of the series to target. - * @param seriesPoint The series pixel position (in the form {x: [number], y: [number]} ) that represents a position in the pixel space of the series. + * @param targetName The name of the series to target. + * @param seriesPoint The series pixel position (in the form {x: [number], y: [number]} ) that represents a position in the pixel space of the series. */ getSeriesValueBoundingBoxFromSeriesPixel(targetName: string, seriesPoint: Object): Object; /** * If possible, will return the best available value fine grained bounding boxes within the series that have the best value match for series pixel position provided. * - * @param targetName The name of the series to target. - * @param worldPoint The series pixel position (in the form {x: [number], y: [number]} ) that represents a position in the pixel space of the series. + * @param targetName The name of the series to target. + * @param worldPoint The series pixel position (in the form {x: [number], y: [number]} ) that represents a position in the pixel space of the series. */ getSeriesValueFineGrainedBoundingBoxesFromSeriesPixel(targetName: string, worldPoint: Object): Object; /** * If possible, will return the best available high value of the series for a given world coordinate. * - * @param targetName The name of the series to target. - * @param worldPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} ) that represents a position in the space of the axes. - * @param useInterpolation If true, interpolation should be used to get in-between values, rather than only the actual values in the data set. - * @param skipUnknowns If true, unknown values should be skipped. + * @param targetName The name of the series to target. + * @param worldPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} ) that represents a position in the space of the axes. + * @param useInterpolation If true, interpolation should be used to get in-between values, rather than only the actual values in the data set. + * @param skipUnknowns If true, unknown values should be skipped. */ getSeriesHighValue(targetName: string, worldPoint: Object, useInterpolation: boolean, skipUnknowns: boolean): number; /** * If possible, will return the best available high value position of the series for a given world coordinate. * - * @param targetName The name of the series to target. - * @param worldPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} ) that represents a position in the space of the axes. - * @param useInterpolation If true, interpolation should be used to get in-between values, rather than only the actual values in the data set. - * @param skipUnknowns If true, unknown values should be skipped. + * @param targetName The name of the series to target. + * @param worldPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} ) that represents a position in the space of the axes. + * @param useInterpolation If true, interpolation should be used to get in-between values, rather than only the actual values in the data set. + * @param skipUnknowns If true, unknown values should be skipped. */ getSeriesHighValuePosition(targetName: string, worldPoint: Object, useInterpolation: boolean, skipUnknowns: boolean): Object; /** * If possible, will return the best available high value position of the series for a given world coordinate. * - * @param targetName The name of the series to target. - * @param seriesPoint The series pixel position (in the form {x: [number], y: [number]} that represents a position within the pixel space of the series. - * @param useInterpolation If true, interpolation should be used to get in-between values, rather than only the actual values in the data set. - * @param skipUnknowns If true, unknown values should be skipped. + * @param targetName The name of the series to target. + * @param seriesPoint The series pixel position (in the form {x: [number], y: [number]} that represents a position within the pixel space of the series. + * @param useInterpolation If true, interpolation should be used to get in-between values, rather than only the actual values in the data set. + * @param skipUnknowns If true, unknown values should be skipped. */ getSeriesHighValuePositionFromSeriesPixel(targetName: string, seriesPoint: Object, useInterpolation: boolean, skipUnknowns: boolean): Object; /** * If possible, will return the best available high value of the series for a given world coordinate. * - * @param targetName The name of the series to target. - * @param seriesPoint The series pixel position (in the form {x: [number], y: [number]} ) that represents a position in the pixel space of the series. - * @param useInterpolation If true, interpolation should be used to get in-between values, rather than only the actual values in the data set. - * @param skipUnknowns If true, unknown values should be skipped. + * @param targetName The name of the series to target. + * @param seriesPoint The series pixel position (in the form {x: [number], y: [number]} ) that represents a position in the pixel space of the series. + * @param useInterpolation If true, interpolation should be used to get in-between values, rather than only the actual values in the data set. + * @param skipUnknowns If true, unknown values should be skipped. */ getSeriesHighValueFromSeriesPixel(targetName: string, seriesPoint: Object, useInterpolation: boolean, skipUnknowns: boolean): number; /** * If possible, will return the best available low value of the series for a given world coordinate. * - * @param targetName The name of the series to target. - * @param worldPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} ) that represents a position in the space of the axes. - * @param useInterpolation If true, interpolation should be used to get in-between values, rather than only the actual values in the data set. - * @param skipUnknowns If true, unknown values should be skipped. + * @param targetName The name of the series to target. + * @param worldPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} ) that represents a position in the space of the axes. + * @param useInterpolation If true, interpolation should be used to get in-between values, rather than only the actual values in the data set. + * @param skipUnknowns If true, unknown values should be skipped. */ getSeriesLowValue(targetName: string, worldPoint: Object, useInterpolation: boolean, skipUnknowns: boolean): number; /** * If possible, will return the best available low value position of the series for a given world coordinate. * - * @param targetName The name of the series to target. - * @param worldPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} ) that represents a position in the space of the axes. - * @param useInterpolation If true, interpolation should be used to get in-between values, rather than only the actual values in the data set. - * @param skipUnknowns If true, unknown values should be skipped. + * @param targetName The name of the series to target. + * @param worldPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} ) that represents a position in the space of the axes. + * @param useInterpolation If true, interpolation should be used to get in-between values, rather than only the actual values in the data set. + * @param skipUnknowns If true, unknown values should be skipped. */ getSeriesLowValuePosition(targetName: string, worldPoint: Object, useInterpolation: boolean, skipUnknowns: boolean): Object; /** * If possible, will return the best available low value position of the series for a given world coordinate. * - * @param targetName The name of the series to target. - * @param seriesPoint The series pixel position (in the form {x: [number], y: [number]} that represents a position within the pixel space of the series. - * @param useInterpolation If true, interpolation should be used to get in-between values, rather than only the actual values in the data set. - * @param skipUnknowns If true, unknown values should be skipped. + * @param targetName The name of the series to target. + * @param seriesPoint The series pixel position (in the form {x: [number], y: [number]} that represents a position within the pixel space of the series. + * @param useInterpolation If true, interpolation should be used to get in-between values, rather than only the actual values in the data set. + * @param skipUnknowns If true, unknown values should be skipped. */ getSeriesLowValuePositionFromSeriesPixel(targetName: string, seriesPoint: Object, useInterpolation: boolean, skipUnknowns: boolean): Object; /** * If possible, will return the best available low value of the series for a given world coordinate. * - * @param targetName The name of the series to target. - * @param seriesPoint The series pixel position (in the form {x: [number], y: [number]} ) that represents a position in the pixel space of the series. - * @param useInterpolation If true, interpolation should be used to get in-between values, rather than only the actual values in the data set. - * @param skipUnknowns If true, unknown values should be skipped. + * @param targetName The name of the series to target. + * @param seriesPoint The series pixel position (in the form {x: [number], y: [number]} ) that represents a position in the pixel space of the series. + * @param useInterpolation If true, interpolation should be used to get in-between values, rather than only the actual values in the data set. + * @param skipUnknowns If true, unknown values should be skipped. */ getSeriesLowValueFromSeriesPixel(targetName: string, seriesPoint: Object, useInterpolation: boolean, skipUnknowns: boolean): number; /** * Gets the item item index associated with the specified series pixel coordinate. * - * @param targetName The name of the series to target. - * @param seriesPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} ) that represents a position in the space of the axes. + * @param targetName The name of the series to target. + * @param seriesPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} ) that represents a position in the space of the axes. */ getItemIndexFromSeriesPixel(targetName: string, seriesPoint: Object): number; /** * Gets the item that is the best match for the specified world coordinates. * - * @param targetName The name of the series to target. - * @param seriesPoint The series pixel position (in the form {x: [number], y: [number]} ) that represents a position in the pixel space of the series. + * @param targetName The name of the series to target. + * @param seriesPoint The series pixel position (in the form {x: [number], y: [number]} ) that represents a position in the pixel space of the series. */ getItemFromSeriesPixel(targetName: string, seriesPoint: Object): Object; /** * Gets the category offset for a series, if applicable. * - * @param targetName The name of the series to target. + * @param targetName The name of the series to target. */ getSeriesOffsetValue(targetName: string): number; /** * Gets the category width for a series, if applicable. * - * @param targetName The name of the series to target. + * @param targetName The name of the series to target. */ getSeriesCategoryWidth(targetName: string): number; /** * Replays the transition in animation for a series, if applicable. * - * @param targetName The name of the series to target. + * @param targetName The name of the series to target. */ replayTransitionIn(targetName: string): Object; /** * Simulates a hover interaction over a given point in the viewport of a series. * - * @param targetName The name of the series to target. - * @param seriesPoint The point at which to hover. Should have an x property with type number and a y property with type number. + * @param targetName The name of the series to target. + * @param seriesPoint The point at which to hover. Should have an x property with type number and a y property with type number. */ simulateHover(targetName: string, seriesPoint: Object): Object; /** * Moves the cursor point of the target annotation layer to the desired world coordinates. * - * @param targetName The name of the series to target. - * @param worldPoint The point to which to move the cursor. Should have an x property with type number and a y property with type number. + * @param targetName The name of the series to target. + * @param worldPoint The point to which to move the cursor. Should have an x property with type number and a y property with type number. */ moveCursorPoint(targetName: string, worldPoint: Object): Object; @@ -17853,38 +17731,38 @@ interface IgPieChartMethods { /** * Adds a new item to the data source and notifies the chart. * - * @param item the new item that will be added to the data source. + * @param item the new item that will be added to the data source. */ addItem(item: Object): void; /** * Inserts a new item to the data source and notifies the chart. * - * @param item the new item that will be inserted in the data source. - * @param index The index in the data source where the new item will be inserted. + * @param item the new item that will be inserted in the data source. + * @param index The index in the data source where the new item will be inserted. */ insertItem(item: Object, index: number): void; /** * Deletes an item from the data source and notifies the chart. * - * @param index The index in the data source from where the item will be been removed. + * @param index The index in the data source from where the item will be been removed. */ removeItem(index: number): void; /** * Updates an item in the data source and notifies the chart. * - * @param index The index in the data source that we want to change. - * @param item the new item that we want to set in the data source. + * @param index The index in the data source that we want to change. + * @param item the new item that we want to set in the data source. */ setItem(index: number, item: Object): void; /** * Exports the chart to a PNG image. * - * @param width The width of the image. - * @param height The height of the image. + * @param width The width of the image. + * @param height The height of the image. */ exportImage(width?: Object, height?: Object): Object; @@ -18117,6 +17995,7 @@ interface JQuery { * The response to user panning and zooming: whether to update the view immediately while the user action is happening, or to defer the update to after the user action is complete. The user action will be an action such as a mouse drag which causes panning and/or zooming to occur. * */ + igDataChart(optionLiteral: 'option', optionName: "windowResponse"): string; /** @@ -18125,6 +18004,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igDataChart(optionLiteral: 'option', optionName: "windowResponse", optionValue: string): void; /** @@ -18146,6 +18026,7 @@ interface JQuery { /** * The visibility of the OverviewPlusDetailPane. */ + igDataChart(optionLiteral: 'option', optionName: "overviewPlusDetailPaneVisibility"): string; /** @@ -18153,11 +18034,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igDataChart(optionLiteral: 'option', optionName: "overviewPlusDetailPaneVisibility", optionValue: string): void; /** * Gets the current Chart's crosshair visibility override. Note: setting this property does not affect the mobile browser version of the chart. */ + igDataChart(optionLiteral: 'option', optionName: "crosshairVisibility"): string; /** @@ -18165,6 +18048,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igDataChart(optionLiteral: 'option', optionName: "crosshairVisibility", optionValue: string): void; /** @@ -18182,6 +18066,7 @@ interface JQuery { /** * Gets the DefaultInteraction property. The default interaction state defines the chart's response to mouse events. */ + igDataChart(optionLiteral: 'option', optionName: "defaultInteraction"): string; /** @@ -18189,11 +18074,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igDataChart(optionLiteral: 'option', optionName: "defaultInteraction", optionValue: string): void; /** * Gets the current Chart's DragModifier property. */ + igDataChart(optionLiteral: 'option', optionName: "dragModifier"): string; /** @@ -18201,11 +18088,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igDataChart(optionLiteral: 'option', optionName: "dragModifier", optionValue: string): void; /** * Gets the current Chart's PanModifier property. */ + igDataChart(optionLiteral: 'option', optionName: "panModifier"): string; /** @@ -18213,6 +18102,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igDataChart(optionLiteral: 'option', optionName: "panModifier", optionValue: string): void; /** @@ -18556,6 +18446,7 @@ interface JQuery { /** * Gets the GridMode property. */ + igDataChart(optionLiteral: 'option', optionName: "gridMode"): string; /** @@ -18563,6 +18454,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igDataChart(optionLiteral: 'option', optionName: "gridMode", optionValue: string): void; /** @@ -18632,6 +18524,7 @@ interface JQuery { /** * The width of the chart. It can be set as a number in pixels, string (px) or percentage (%). */ + igDataChart(optionLiteral: 'option', optionName: "width"): string|number; /** @@ -18639,11 +18532,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igDataChart(optionLiteral: 'option', optionName: "width", optionValue: string|number): void; /** * The height of the chart. It can be set as a number in pixels, string (px) or percentage (%). */ + igDataChart(optionLiteral: 'option', optionName: "height"): string|number; /** @@ -18651,6 +18546,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igDataChart(optionLiteral: 'option', optionName: "height", optionValue: string|number): void; /** @@ -18908,6 +18804,7 @@ interface JQuery { /** * The horizontal alignment to use for the title. */ + igDataChart(optionLiteral: 'option', optionName: "titleHorizontalAlignment"): string; /** @@ -18915,11 +18812,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igDataChart(optionLiteral: 'option', optionName: "titleHorizontalAlignment", optionValue: string): void; /** * The horizontal alignment to use for the subtitle. */ + igDataChart(optionLiteral: 'option', optionName: "subtitleHorizontalAlignment"): string; /** @@ -18927,6 +18826,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igDataChart(optionLiteral: 'option', optionName: "subtitleHorizontalAlignment", optionValue: string): void; /** @@ -18992,6 +18892,7 @@ interface JQuery { /** * Gets which type of hit testing the series should use. */ + igDataChart(optionLiteral: 'option', optionName: "contentHitTestMode"): string; /** @@ -18999,6 +18900,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igDataChart(optionLiteral: 'option', optionName: "contentHitTestMode", optionValue: string): void; /** @@ -19606,6 +19508,7 @@ interface JQuery { /** * The width of the chart. It can be set as a number in pixels, string (px) or percentage (%). */ + igPieChart(optionLiteral: 'option', optionName: "width"): string|number; /** @@ -19613,11 +19516,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igPieChart(optionLiteral: 'option', optionName: "width", optionValue: string|number): void; /** * The height of the chart. It can be set as a number in pixels, string (px) or percentage (%). */ + igPieChart(optionLiteral: 'option', optionName: "height"): string|number; /** @@ -19625,6 +19530,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igPieChart(optionLiteral: 'option', optionName: "height", optionValue: string|number): void; /** @@ -19739,6 +19645,7 @@ interface JQuery { * Gets the position of chart labels. * */ + igPieChart(optionLiteral: 'option', optionName: "labelsPosition"): string; /** @@ -19747,6 +19654,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igPieChart(optionLiteral: 'option', optionName: "labelsPosition", optionValue: string): void; /** @@ -19781,6 +19689,7 @@ interface JQuery { * Gets the type of selection the pie chart allows. * */ + igPieChart(optionLiteral: 'option', optionName: "selectionMode"): string; /** @@ -19789,6 +19698,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igPieChart(optionLiteral: 'option', optionName: "selectionMode", optionValue: string): void; /** @@ -19823,6 +19733,7 @@ interface JQuery { * Gets whether the leader lines are visible. * */ + igPieChart(optionLiteral: 'option', optionName: "leaderLineVisibility"): string; /** @@ -19831,12 +19742,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igPieChart(optionLiteral: 'option', optionName: "leaderLineVisibility", optionValue: string): void; /** * Gets what type of leader lines will be used for the outside end labels. * */ + igPieChart(optionLiteral: 'option', optionName: "leaderLineType"): string; /** @@ -19845,6 +19758,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igPieChart(optionLiteral: 'option', optionName: "leaderLineType", optionValue: string): void; /** @@ -19910,6 +19824,7 @@ interface JQuery { /** * Gets whether to use numeric or percent-based threshold value. */ + igPieChart(optionLiteral: 'option', optionName: "othersCategoryType"): string; /** @@ -19917,6 +19832,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igPieChart(optionLiteral: 'option', optionName: "othersCategoryType", optionValue: string): void; /** @@ -20073,6 +19989,7 @@ interface JQuery { * Gets the rotational direction of the chart. * */ + igPieChart(optionLiteral: 'option', optionName: "sweepDirection"): string; /** @@ -20081,6 +19998,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igPieChart(optionLiteral: 'option', optionName: "sweepDirection", optionValue: string): void; /** @@ -20656,6 +20574,7 @@ interface JQuery { /** * Type of the legend. */ + igChartLegend(optionLiteral: 'option', optionName: "type"): string; /** @@ -20663,11 +20582,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igChartLegend(optionLiteral: 'option', optionName: "type", optionValue: string): void; /** * The width of the legend. It can be set as a number in pixels, string (px) or percentage (%). */ + igChartLegend(optionLiteral: 'option', optionName: "width"): string|number; /** @@ -20675,11 +20596,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igChartLegend(optionLiteral: 'option', optionName: "width", optionValue: string|number): void; /** * The height of the legend. It can be set as a number in pixels, string (px) or percentage (%). */ + igChartLegend(optionLiteral: 'option', optionName: "height"): string|number; /** @@ -20687,6 +20610,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igChartLegend(optionLiteral: 'option', optionName: "height", optionValue: string|number): void; /** @@ -20868,7 +20792,7 @@ interface IgColorPickerMethods { /** * Gets the color for an element from the color picker in RGB format. * - * @param $element A jQuery element in the color picker from which the color will be retrieved. + * @param $element A jQuery element in the color picker from which the color will be retrieved. */ colorFromElement($element: Object): string; @@ -20881,7 +20805,7 @@ interface IgColorPickerMethods { /** * Select a color. * - * @param color The #RGB value of the color to be selected. + * @param color The #RGB value of the color to be selected. */ selectColor(color: string): Object; } @@ -21729,7 +21653,6 @@ interface IgCombo { * Gets/Sets type of filtering.Note: option is set to "remote", then the "css.waitFiltering" is applied to combo and its drop-down list. * * - * * Valid values: * "remote" filtering is performed by server * "local" filtering is performed by $.ig.DataSource @@ -21747,7 +21670,6 @@ interface IgCombo { * Gets/Sets condition used for filtering.Note: When [autoComplete](ui.igcombo#options:autoComplete) is enabled, the filtering condition is always "startsWith". * * - * * Valid values: * "contains" * "doesNotContain" @@ -22217,7 +22139,7 @@ interface IgComboMethods { /** * Clears the input text, resets highlighting, filtering and selection. * - * @param options Object with set of options controlling the behavior of this api method. + * @param options Object with set of options controlling the behavior of this api method. * focusCombo (boolean): Set to true to focus combo after clearing the input. * @param event Indicates the browser event which triggered this action (not API). Calling the method with this param set to "true" will trigger [selectionChanging](ui.igcombo#events:selectionChanging) and [selectionChanged](ui.igcombo#events:selectionChanged) events. */ @@ -22249,14 +22171,14 @@ interface IgComboMethods { * * @param value Value or array of values matching the valueKey property of item/items to be selected * @param options Object with set of options controlling the behavior of this api method. - * closeDropDown (boolean): Set to true to close the drop down list after the selection. - * focusCombo (boolean): Set to true to focus combo after the selection. - * additive (boolean): Set to true to select the item without losing other selection. Works only when multi selection is enabled. - * keepFiltering (boolean): Set to true to keep filtering after the selection. By default the filtering is cleared. - * keepInputText (boolean): Set to true to keep input text unchanged after the selection. By default input text is updated. - * keepHighlighting (boolean): Set to true to keep highlighting unchanged after the selection. By default highlighting is removed. - * keepNavItem (boolean): Set to true to keep current navigation item unchanged after the selection. By default the navigation item is changed to the new selected item. - * keepScrollPosition (boolean): Set to true to keep current scroll position. By default the scroll position will change so that the last selected item is visible. + * closeDropDown (boolean): Set to true to close the drop down list after the selection. + * focusCombo (boolean): Set to true to focus combo after the selection. + * additive (boolean): Set to true to select the item without losing other selection. Works only when multi selection is enabled. + * keepFiltering (boolean): Set to true to keep filtering after the selection. By default the filtering is cleared. + * keepInputText (boolean): Set to true to keep input text unchanged after the selection. By default input text is updated. + * keepHighlighting (boolean): Set to true to keep highlighting unchanged after the selection. By default highlighting is removed. + * keepNavItem (boolean): Set to true to keep current navigation item unchanged after the selection. By default the navigation item is changed to the new selected item. + * keepScrollPosition (boolean): Set to true to keep current scroll position. By default the scroll position will change so that the last selected item is visible. * @param event Indicates the browser event which triggered this action (not API). Calling the method with this param set to "true" will trigger [selectionChanging](ui.igcombo#events:selectionChanging) and [selectionChanged](ui.igcombo#events:selectionChanged) events. */ value(value?: Object, options?: Object, event?: Object): Object; @@ -22266,14 +22188,14 @@ interface IgComboMethods { * * @param $items jQuery object with item or items to be selected. * @param options Object with set of options controlling the behavior of this api method. - * closeDropDown (boolean): Set to true to close the drop down list after the selection. - * focusCombo (boolean): Set to true to focus combo after the selection. - * additive (boolean): Set to true to select the item without losing other selection. Works only when multi selection is enabled. - * keepFiltering (boolean): Set to true to keep filtering after the selection. By default the filtering is cleared. - * keepInputText (boolean): Set to true to keep input text unchanged after the selection. By default input text is updated. - * keepHighlighting (boolean): Set to true to keep highlighting unchanged after the selection. By default highlighting is removed. - * keepNavItem (boolean): Set to true to keep current navigation item unchanged after the selection. By default the navigation item is changed to the new selected item. - * keepScrollPosition (boolean): Set to true to keep current scroll position. By default the scroll position will change so that the last selected item is visible. + * closeDropDown (boolean): Set to true to close the drop down list after the selection. + * focusCombo (boolean): Set to true to focus combo after the selection. + * additive (boolean): Set to true to select the item without losing other selection. Works only when multi selection is enabled. + * keepFiltering (boolean): Set to true to keep filtering after the selection. By default the filtering is cleared. + * keepInputText (boolean): Set to true to keep input text unchanged after the selection. By default input text is updated. + * keepHighlighting (boolean): Set to true to keep highlighting unchanged after the selection. By default highlighting is removed. + * keepNavItem (boolean): Set to true to keep current navigation item unchanged after the selection. By default the navigation item is changed to the new selected item. + * keepScrollPosition (boolean): Set to true to keep current scroll position. By default the scroll position will change so that the last selected item is visible. * @param event Indicates the browser event which triggered this action (not API). Calling the method with this param set to "true" will trigger [selectionChanging](ui.igcombo#events:selectionChanging) and [selectionChanged](ui.igcombo#events:selectionChanged) events. */ select($items: Object, options?: Object, event?: Object): Object; @@ -22283,14 +22205,14 @@ interface IgComboMethods { * * @param index Index or array of indexes of items to be selected * @param options Object with set of options controlling the behavior of this api method. - * closeDropDown (boolean): Set to true to close the drop down list after the selection. - * focusCombo (boolean): Set to true to focus combo after the selection. - * additive (boolean): Set to true to select the item without losing other selection. Works only when multi selection is enabled. - * keepFiltering (boolean): Set to true to keep filtering after the selection. By default the filtering is cleared. - * keepInputText (boolean): Set to true to keep input text unchanged after the selection. By default input text is updated. - * keepHighlighting (boolean): Set to true to keep highlighting unchanged after the selection. By default highlighting is removed. - * keepNavItem (boolean): Set to true to keep current navigation item unchanged after the selection. By default the navigation item is changed to the new selected item. - * keepScrollPosition (boolean): Set to true to keep current scroll position. By default the scroll position will change so that the last selected item is visible. + * closeDropDown (boolean): Set to true to close the drop down list after the selection. + * focusCombo (boolean): Set to true to focus combo after the selection. + * additive (boolean): Set to true to select the item without losing other selection. Works only when multi selection is enabled. + * keepFiltering (boolean): Set to true to keep filtering after the selection. By default the filtering is cleared. + * keepInputText (boolean): Set to true to keep input text unchanged after the selection. By default input text is updated. + * keepHighlighting (boolean): Set to true to keep highlighting unchanged after the selection. By default highlighting is removed. + * keepNavItem (boolean): Set to true to keep current navigation item unchanged after the selection. By default the navigation item is changed to the new selected item. + * keepScrollPosition (boolean): Set to true to keep current scroll position. By default the scroll position will change so that the last selected item is visible. * @param event Indicates the browser event which triggered this action (not API). Calling the method with this param set to "true" will trigger [selectionChanging](ui.igcombo#events:selectionChanging) and [selectionChanged](ui.igcombo#events:selectionChanged) events. */ index(index?: Object, options?: Object, event?: Object): Object; @@ -22299,13 +22221,13 @@ interface IgComboMethods { * Selects all items from the drop-down list. * * @param options Object with set of options controlling the behavior of this api method. - * closeDropDown (boolean): Set to true to close the drop down list after the selection. - * focusCombo (boolean): Set to true to focus combo after the selection. - * keepFiltering (boolean): Set to true to keep filtering after the selection. By default the filtering is cleared. - * keepInputText (boolean): Set to true to keep input text unchanged after the selection. By default input text is updated. - * keepHighlighting (boolean): Set to true to keep highlighting unchanged after the selection. By default highlighting is removed. - * keepNavItem (boolean): Set to true to keep current navigation item unchanged after the selection. By default the navigation item is changed to the new selected item. - * keepScrollPosition (boolean): Set to true to keep current scroll position. By default the scroll position will change so that the last selected item is visible. + * closeDropDown (boolean): Set to true to close the drop down list after the selection. + * focusCombo (boolean): Set to true to focus combo after the selection. + * keepFiltering (boolean): Set to true to keep filtering after the selection. By default the filtering is cleared. + * keepInputText (boolean): Set to true to keep input text unchanged after the selection. By default input text is updated. + * keepHighlighting (boolean): Set to true to keep highlighting unchanged after the selection. By default highlighting is removed. + * keepNavItem (boolean): Set to true to keep current navigation item unchanged after the selection. By default the navigation item is changed to the new selected item. + * keepScrollPosition (boolean): Set to true to keep current scroll position. By default the scroll position will change so that the last selected item is visible. * @param event Indicates the browser event which triggered this action (not API). Calling the method with this param set to "true" will trigger [selectionChanging](ui.igcombo#events:selectionChanging) and [selectionChanged](ui.igcombo#events:selectionChanged) events. */ selectAll(options?: Object, event?: Object): Object; @@ -22315,8 +22237,8 @@ interface IgComboMethods { * * @param value Value or array of values matching the [valueKey](ui.igcombo#options:valueKey) property of item/items to be deselected * @param options Object with set of options controlling the behavior of this api method. - * focusCombo (boolean): Set to true to focus combo after the deselection. - * keepInputText (boolean): Set to true to keep input text unchanged after the deselection. By default input text is updated. + * focusCombo (boolean): Set to true to focus combo after the deselection. + * keepInputText (boolean): Set to true to keep input text unchanged after the deselection. By default input text is updated. * @param event Indicates the browser event which triggered this action (not API). Calling the method with this param set to "true" will trigger [selectionChanging](ui.igcombo#events:selectionChanging) and [selectionChanged](ui.igcombo#events:selectionChanged) events. */ deselectByValue(value: Object, options?: Object, event?: Object): Object; @@ -22326,8 +22248,8 @@ interface IgComboMethods { * * @param $items jQuery object with item or items to be deselected * @param options Object with set of options controlling the behavior of this api method. - * focusCombo (boolean): Set to true to focus combo after the deselection. - * keepInputText (boolean): Set to true to keep input text unchanged after the deselection. By default input text is updated. + * focusCombo (boolean): Set to true to focus combo after the deselection. + * keepInputText (boolean): Set to true to keep input text unchanged after the deselection. By default input text is updated. * @param event Indicates the browser event which triggered this action (not API). Calling the method with this param set to "true" will trigger [selectionChanging](ui.igcombo#events:selectionChanging) and [selectionChanged](ui.igcombo#events:selectionChanged) events. */ deselect($items: Object, options?: Object, event?: Object): Object; @@ -22337,8 +22259,8 @@ interface IgComboMethods { * * @param index Index or array of indexes of items to be selected * @param options Object with set of options controlling the behavior of this api method. - * focusCombo (boolean): Set to true to focus combo after the deselection. - * keepInputText (boolean): Set to true to keep input text unchanged after the deselection. By default input text is updated. + * focusCombo (boolean): Set to true to focus combo after the deselection. + * keepInputText (boolean): Set to true to keep input text unchanged after the deselection. By default input text is updated. * @param event Indicates the browser event which triggered this action (not API). Calling the method with this param set to "true" will trigger [selectionChanging](ui.igcombo#events:selectionChanging) and [selectionChanged](ui.igcombo#events:selectionChanged) events. */ deselectByIndex(index: Object, options?: Object, event?: Object): Object; @@ -22347,8 +22269,8 @@ interface IgComboMethods { * Deselects all selected items from the drop down list. * * @param options Object with set of options controlling the behavior of this api method. - * focusCombo (boolean): Set to true to focus combo after the deselection. - * keepInputText (boolean): Set to true to keep input text unchanged after the deselection. By default input text is updated. + * focusCombo (boolean): Set to true to focus combo after the deselection. + * keepInputText (boolean): Set to true to keep input text unchanged after the deselection. By default input text is updated. * @param event Indicates the browser event which triggered this action (not API). Calling the method with this param set to "true" will trigger [selectionChanging](ui.igcombo#events:selectionChanging) and [selectionChanged](ui.igcombo#events:selectionChanged) events. */ deselectAll(options?: Object, event?: Object): Object; @@ -22485,6 +22407,7 @@ interface JQuery { * Gets/Sets the width of combo. The numeric and string values (valid html units for size) are supported. It includes %, px, em and other units. * */ + igCombo(optionLiteral: 'option', optionName: "width"): string|number; /** @@ -22493,12 +22416,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igCombo(optionLiteral: 'option', optionName: "width", optionValue: string|number): void; /** * Gets/Sets height of combo. The numeric and string values (valid html units for size) are supported. It includes %, px, em and other units. * */ + igCombo(optionLiteral: 'option', optionName: "height"): string|number; /** @@ -22507,12 +22432,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igCombo(optionLiteral: 'option', optionName: "height", optionValue: string|number): void; /** * Gets/Sets the width of drop-down list in pixels. * */ + igCombo(optionLiteral: 'option', optionName: "dropDownWidth"): string|number; /** @@ -22521,6 +22448,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igCombo(optionLiteral: 'option', optionName: "dropDownWidth", optionValue: string|number): void; /** @@ -22601,6 +22529,7 @@ interface JQuery { * Response type when a URL is set as the data source. See http://api.jquery.com/jQuery.ajax/ => dataType. * */ + igCombo(optionLiteral: 'option', optionName: "responseDataType"): string; /** @@ -22609,6 +22538,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igCombo(optionLiteral: 'option', optionName: "responseDataType", optionValue: string): void; /** @@ -22786,17 +22716,17 @@ interface JQuery { /** * Gets/Sets type of filtering.Note: option is set to "remote", then the "css.waitFiltering" is applied to combo and its drop-down list. * - * */ + igCombo(optionLiteral: 'option', optionName: "filteringType"): string; /** * /Sets type of filtering.Note: option is set to "remote", then the "css.waitFiltering" is applied to combo and its drop-down list. * * - * * @optionValue New value to be set. */ + igCombo(optionLiteral: 'option', optionName: "filteringType", optionValue: string): void; /** @@ -22816,23 +22746,24 @@ interface JQuery { /** * Gets/Sets condition used for filtering.Note: When [autoComplete](ui.igcombo#options:autoComplete) is enabled, the filtering condition is always "startsWith". * - * */ + igCombo(optionLiteral: 'option', optionName: "filteringCondition"): string; /** * /Sets condition used for filtering.Note: When [autoComplete](ui.igcombo#options:autoComplete) is enabled, the filtering condition is always "startsWith". * * - * * @optionValue New value to be set. */ + igCombo(optionLiteral: 'option', optionName: "filteringCondition", optionValue: string): void; /** * Gets/Sets filtering logic. * */ + igCombo(optionLiteral: 'option', optionName: "filteringLogic"): string; /** @@ -22841,6 +22772,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igCombo(optionLiteral: 'option', optionName: "filteringLogic", optionValue: string): void; /** @@ -22913,6 +22845,7 @@ interface JQuery { * Sets gets functionality mode. * */ + igCombo(optionLiteral: 'option', optionName: "mode"): string; /** @@ -22921,6 +22854,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igCombo(optionLiteral: 'option', optionName: "mode", optionValue: string): void; /** @@ -22987,6 +22921,7 @@ interface JQuery { * Gets/Sets condition used for highlighting of matching parts in items of drop-down list. * */ + igCombo(optionLiteral: 'option', optionName: "highlightMatchesMode"): string; /** @@ -22995,6 +22930,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igCombo(optionLiteral: 'option', optionName: "highlightMatchesMode", optionValue: string): void; /** @@ -23265,6 +23201,7 @@ interface JQuery { * Gets/Sets drop-down list orientation when open button is clicked. * */ + igCombo(optionLiteral: 'option', optionName: "dropDownOrientation"): string; /** @@ -23273,6 +23210,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igCombo(optionLiteral: 'option', optionName: "dropDownOrientation", optionValue: string): void; /** @@ -23676,7 +23614,6 @@ interface IgDialog { * Gets/Sets the state of the dialog.Note: when the dialog is modal, then pinned and minimized states are not supported, because that will trigger misbehavior. * * - * * Valid values: * "opened" The dialog is opened. * "minimized" The dialog is minimized. @@ -23781,7 +23718,6 @@ interface IgDialog { * Gets/Sets the initial height of the dialog in pixels for normal state.Besides numeric values, following units are supported: "px", "em" and "%". * In case of "%", the size of browser window is used and it has effect only on open action. * - * */ height?: number|string; @@ -23789,7 +23725,6 @@ interface IgDialog { * Gets/Sets the initial width of the dialog in pixels for normal state.Besides numeric values, following units are supported: "px", "em" and "%". * In case of "%", the size of browser window is used and it has effect only on open action. * - * */ width?: number|string; @@ -23931,7 +23866,6 @@ interface IgDialog { * If this option is set to "auto" and showMaximizeButton is enabled or if this option is set to true, then the dialog will be maximized when it was in normal state, * and dialog-state will be set to normal if it was maximized. * - * */ enableDblclick?: any; @@ -24020,7 +23954,7 @@ interface IgDialogMethods { * Gets/Sets the state of the editor. * Note: If the state of the dialog changes, then stateChanging and stateChanged events are raised. * - * @param state New state. + * @param state New state. */ state(state?: string): string; @@ -24036,7 +23970,7 @@ interface IgDialogMethods { * 2. That method does not change minimized or maximized state of the dialog. * It means that method "open" will open the dialog and keep previous minimized or maximized state. * - * @param e Browser event: internal use only. + * @param e Browser event: internal use only. */ close(e?: Object): Object; @@ -24094,14 +24028,14 @@ interface IgDialogMethods { /** * Moves a not modal dialog to the top. * - * @param e Original event of browser. + * @param e Original event of browser. */ moveToTop(e?: Object): Object; /** * Retrieves the igDialog content container or sets its content to be the new content provided. * - * @param newContent The new html content provided as a string. If the parameter is provided then the method acts as a setter. + * @param newContent The new html content provided as a string. If the parameter is provided then the method acts as a setter. */ content(newContent?: string): Object; } @@ -24152,17 +24086,17 @@ interface JQuery { /** * Gets/Sets the state of the dialog.Note: when the dialog is modal, then pinned and minimized states are not supported, because that will trigger misbehavior. * - * */ + igDialog(optionLiteral: 'option', optionName: "state"): string; /** * /Sets the state of the dialog.Note: when the dialog is modal, then pinned and minimized states are not supported, because that will trigger misbehavior. * * - * * @optionValue New value to be set. */ + igDialog(optionLiteral: 'option', optionName: "state", optionValue: string): void; /** @@ -24381,8 +24315,8 @@ interface JQuery { * Gets/Sets the initial height of the dialog in pixels for normal state.Besides numeric values, following units are supported: "px", "em" and "%". * In case of "%", the size of browser window is used and it has effect only on open action. * - * */ + igDialog(optionLiteral: 'option', optionName: "height"): number|string; /** @@ -24390,17 +24324,17 @@ interface JQuery { * In case of "%", the size of browser window is used and it has effect only on open action. * * - * * @optionValue New value to be set. */ + igDialog(optionLiteral: 'option', optionName: "height", optionValue: number|string): void; /** * Gets/Sets the initial width of the dialog in pixels for normal state.Besides numeric values, following units are supported: "px", "em" and "%". * In case of "%", the size of browser window is used and it has effect only on open action. * - * */ + igDialog(optionLiteral: 'option', optionName: "width"): number|string; /** @@ -24408,9 +24342,9 @@ interface JQuery { * In case of "%", the size of browser window is used and it has effect only on open action. * * - * * @optionValue New value to be set. */ + igDialog(optionLiteral: 'option', optionName: "width", optionValue: number|string): void; /** @@ -24726,7 +24660,6 @@ interface JQuery { * If this option is set to "auto" and showMaximizeButton is enabled or if this option is set to true, then the dialog will be maximized when it was in normal state, * and dialog-state will be set to normal if it was maximized. * - * */ igDialog(optionLiteral: 'option', optionName: "enableDblclick"): any; @@ -24736,7 +24669,6 @@ interface JQuery { * and dialog-state will be set to normal if it was maximized. * * - * * @optionValue New value to be set. */ igDialog(optionLiteral: 'option', optionName: "enableDblclick", optionValue: any): void; @@ -25058,8 +24990,7 @@ interface HoleDimensionsChangedEvent { (event: Event, ui: HoleDimensionsChangedEventUIParam): void; } -interface HoleDimensionsChangedEventUIParam { -} +interface HoleDimensionsChangedEventUIParam {} interface IgDoughnutChart { /** @@ -25253,21 +25184,21 @@ interface IgDoughnutChartMethods { /** * Adds a new series to the doughnut chart. * - * @param seriesObj The series object to be added. + * @param seriesObj The series object to be added. */ addSeries(seriesObj: Object): void; /** * Removes the specified series from the doughnut chart. * - * @param seriesObj The series object identifying the series to be removed. + * @param seriesObj The series object identifying the series to be removed. */ removeSeries(seriesObj: Object): void; /** * Updates the series with the specified name with the specified new property values. * - * @param value The series object identifying the series to be updated. + * @param value The series object identifying the series to be updated. */ updateSeries(value: Object): void; @@ -25299,61 +25230,61 @@ interface IgDoughnutChartMethods { /** * Returns data source of the series. * - * @param series Optional. The series name. If not provided an array of series data sources is returned. + * @param series Optional. The series name. If not provided an array of series data sources is returned. */ getData(series: string): Object; /** * Find index of item within actual data used by chart. * - * @param item The reference to item. + * @param item The reference to item. */ findIndexOfItem(item: Object): number; /** * Get item within actual data used by chart. That is similar to this.getData()[ index ]. * - * @param index Index of data item. + * @param index Index of data item. */ getDataItem(index: Object): Object; /** * Adds a new item to the data source and notifies the chart. * - * @param item The item that we want to add to the data source. + * @param item The item that we want to add to the data source. */ addItem(item: Object): Object; /** * Inserts a new item to the data source and notifies the chart. * - * @param item the new item that we want to insert in the data source. - * @param index The index in the data source where the new item will be inserted. + * @param item the new item that we want to insert in the data source. + * @param index The index in the data source where the new item will be inserted. */ insertItem(item: Object, index: number): Object; /** * Deletes an item from the data source and notifies the chart. * - * @param index The index in the data source from where the item will be been removed. + * @param index The index in the data source from where the item will be been removed. */ removeItem(index: number): Object; /** * Updates an item in the data source and notifies the chart. * - * @param index The index of the item in the data source that we want to change. - * @param item The new item object that will be set in the data source. + * @param index The index of the item in the data source that we want to change. + * @param item The new item object that will be set in the data source. */ setItem(index: number, item: Object): Object; /** * Notifies the chart that an item has been set in an associated data source. * - * @param dataSource The data source in which the change happened. - * @param index The index in the items source that has been changed. - * @param newItem the new item that has been set in the collection. - * @param oldItem the old item that has been overwritten in the collection. + * @param dataSource The data source in which the change happened. + * @param index The index in the items source that has been changed. + * @param newItem the new item that has been set in the collection. + * @param oldItem the old item that has been overwritten in the collection. */ notifySetItem(dataSource: Object, index: number, newItem: Object, oldItem: Object): Object; @@ -25361,7 +25292,7 @@ interface IgDoughnutChartMethods { * Notifies the chart that the items have been cleared from an associated data source. * It's not necessary to notify more than one target of a change if they share the same items source. * - * @param dataSource The data source in which the change happened. + * @param dataSource The data source in which the change happened. */ notifyClearItems(dataSource: Object): Object; @@ -25369,9 +25300,9 @@ interface IgDoughnutChartMethods { * Notifies the target axis or series that an item has been inserted at the specified index in its data source. * It's not necessary to notify more than one target of a change if they share the same items source. * - * @param dataSource The data source in which the change happened. - * @param index The index in the items source where the new item has been inserted. - * @param newItem the new item that has been set in the collection. + * @param dataSource The data source in which the change happened. + * @param index The index in the items source where the new item has been inserted. + * @param newItem the new item that has been set in the collection. */ notifyInsertItem(dataSource: Object, index: number, newItem: Object): Object; @@ -25379,9 +25310,9 @@ interface IgDoughnutChartMethods { * Notifies the target axis or series that an item has been removed from the specified index in its data source. * It's not necessary to notify more than one target of a change if they share the same items source. * - * @param dataSource The data source in which the change happened. - * @param index The index in the items source from where the old item has been removed. - * @param oldItem the old item that has been removed from the collection. + * @param dataSource The data source in which the change happened. + * @param index The index in the items source from where the old item has been removed. + * @param oldItem the old item that has been removed from the collection. */ notifyRemoveItem(dataSource: Object, index: number, oldItem: Object): Object; @@ -25425,6 +25356,7 @@ interface JQuery { /** * The width of the chart. It can be set as a number in pixels, string (px) or percentage (%). */ + igDoughnutChart(optionLiteral: 'option', optionName: "width"): string|number; /** @@ -25432,11 +25364,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igDoughnutChart(optionLiteral: 'option', optionName: "width", optionValue: string|number): void; /** * The height of the chart. It can be set as a number in pixels, string (px) or percentage (%). */ + igDoughnutChart(optionLiteral: 'option', optionName: "height"): string|number; /** @@ -25444,6 +25378,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igDoughnutChart(optionLiteral: 'option', optionName: "height", optionValue: string|number): void; /** @@ -26273,7 +26208,7 @@ interface IgBaseEditorMethods { /** * Gets/Sets name attribute applied to the editor element. * - * @param newValue The new input name. + * @param newValue The new input name. */ inputName(newValue?: string): string; value(newValue: Object): void; @@ -26296,7 +26231,7 @@ interface IgBaseEditorMethods { /** * Sets focus to the editor after the specified delay. * - * @param delay The delay before focusing the editor. + * @param delay The delay before focusing the editor. */ setFocus(delay?: number): void; @@ -26496,7 +26431,6 @@ interface IgTextEditor { * Gets visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. * * - * * Valid values: * "dropdown" A button to open/close the list is located on the right side of the editor. * "clear" A button to clear the value is located on the right side of the editor. @@ -26998,15 +26932,15 @@ interface IgTextEditorMethods { /** * Finds index of list item by text that matches with the search parameters. * - * @param text The text to search for in the drop down list. - * @param matchType The rule that is applied for searching the text. + * @param text The text to search for in the drop down list. + * @param matchType The rule that is applied for searching the text. */ findListItemIndex(text: string, matchType?: Object): number; /** * Gets the index of the selected list item. Sets selected item by index. * - * @param index The index of the item that needs to be selected. + * @param index The index of the item that needs to be selected. */ selectedListIndex(index?: number): number; @@ -27034,15 +26968,15 @@ interface IgTextEditorMethods { * Inserts the text at the location of the caret or over the current selection. If the editor is focused the method will insert the text over the current selection. If the editor is not focused the method will set the text as value of the editor. * Note: The method raises [textChanged](ui.igtexteditor#events:textChanged) event. * - * @param string The string to be inserted. + * @param string The string to be inserted. */ insert(string: string): void; /** * Selects the text between start and end indices in the editor. If the parameters are equal, then the method sets location of caret. The method has effect only when the editor has focus. * - * @param start Start of the selection. - * @param end End of the selection. + * @param start Start of the selection. + * @param end End of the selection. */ select(start: number, end: number): void; @@ -27069,7 +27003,7 @@ interface IgTextEditorMethods { /** * Gets/Sets name attribute applied to the editor element. * - * @param newValue The new input name. + * @param newValue The new input name. */ inputName(newValue?: string): string; value(newValue: Object): void; @@ -27092,7 +27026,7 @@ interface IgTextEditorMethods { /** * Sets focus to the editor after the specified delay. * - * @param delay The delay before focusing the editor. + * @param delay The delay before focusing the editor. */ setFocus(delay?: number): void; @@ -27239,7 +27173,6 @@ interface IgNumericEditor { * In addition, the maximum value that can be set to [minDecimals](ui.igNumericEditor#options:minDecimals) and [maxDecimals](ui.igNumericEditor#options:maxDecimals) options can be 15, when editor is in 'double' mode and 7, when in 'float' mode. * * - * * Valid values: * "double" the Number object is used with the limits of a double and if the value is not set, then the null or Number.NaN is used depending on the option [allowNullValue](ui.igNumericEditor#options:allowNullValue). Note: that is used as default. * "float" the Number object is used with the limits of a float and if the value is not set, then the null or Number.NaN is used depending on the option [allowNullValue](ui.igNumericEditor#options:allowNullValue). @@ -27285,7 +27218,6 @@ interface IgNumericEditor { * Notes: The "+" character is not supported in edit mode. * * - * * Valid values: * "null" scientific format is disabled. * "E" scientific format is enabled and the "E" character is used. @@ -27349,7 +27281,6 @@ interface IgNumericEditor { * Gets visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. * * - * * Valid values: * "dropdown" A button to open/close the list is located on the right side of the editor. * "clear" A button to clear the value is located on the right side of the editor. @@ -27593,14 +27524,14 @@ interface IgNumericEditorMethods { /** * Gets/Sets editor value. * - * @param newValue New editor value. + * @param newValue New editor value. */ value(newValue?: number): number; /** * Finds index of list item by text that matches with the search parameters. * - * @param number The text to search for. + * @param number The text to search for. */ findListItemIndex(number: number): number; getSelectedText(): void; @@ -27610,14 +27541,14 @@ interface IgNumericEditorMethods { /** * Increments value in editor according to the parameter or selects the previous item from the drop-down list if [isLimitedToListValues](ui.%%WidgetNameLowered%%#options:isLimitedToListValues) is enabled. * - * @param delta Increments value. + * @param delta Increments value. */ spinUp(delta?: number): void; /** * Decrements value in editor according to the parameter selects the next item from the drop-down list if [isLimitedToListValues](ui.%%WidgetNameLowered%%#options:isLimitedToListValues) is enabled. * - * @param delta Decrement value. + * @param delta Decrement value. */ spinDown(delta?: number): void; @@ -27674,7 +27605,7 @@ interface IgNumericEditorMethods { /** * Gets the index of the selected list item. Sets selected item by index. * - * @param index The index of the item that needs to be selected. + * @param index The index of the item that needs to be selected. */ selectedListIndex(index?: number): number; @@ -27687,15 +27618,15 @@ interface IgNumericEditorMethods { * Inserts the text at the location of the caret or over the current selection. If the editor is focused the method will insert the text over the current selection. If the editor is not focused the method will set the text as value of the editor. * Note: The method raises [textChanged](ui.igtexteditor#events:textChanged) event. * - * @param string The string to be inserted. + * @param string The string to be inserted. */ insert(string: string): void; /** * Selects the text between start and end indices in the editor. If the parameters are equal, then the method sets location of caret. The method has effect only when the editor has focus. * - * @param start Start of the selection. - * @param end End of the selection. + * @param start Start of the selection. + * @param end End of the selection. */ select(start: number, end: number): void; @@ -27836,7 +27767,6 @@ interface IgCurrencyEditor { * In addition, the maximum value that can be set to [minDecimals](ui.igNumericEditor#options:minDecimals) and [maxDecimals](ui.igNumericEditor#options:maxDecimals) options can be 15, when editor is in 'double' mode and 7, when in 'float' mode. * * - * * Valid values: * "double" the Number object is used with the limits of a double and if the value is not set, then the null or Number.NaN is used depending on the option [allowNullValue](ui.igNumericEditor#options:allowNullValue). Note: that is used as default. * "float" the Number object is used with the limits of a float and if the value is not set, then the null or Number.NaN is used depending on the option [allowNullValue](ui.igNumericEditor#options:allowNullValue). @@ -27882,7 +27812,6 @@ interface IgCurrencyEditor { * Notes: The "+" character is not supported in edit mode. * * - * * Valid values: * "null" scientific format is disabled. * "E" scientific format is enabled and the "E" character is used. @@ -27946,7 +27875,6 @@ interface IgCurrencyEditor { * Gets visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. * * - * * Valid values: * "dropdown" A button to open/close the list is located on the right side of the editor. * "clear" A button to clear the value is located on the right side of the editor. @@ -28124,21 +28052,21 @@ interface IgCurrencyEditorMethods { /** * Gets/sets a string that is used as the currency symbol shown with the number in the input. The value provided as a param is propagated to the currencySymbol option and thus has the same priority as the option. * - * @param symbol New currency symbol. + * @param symbol New currency symbol. */ currencySymbol(symbol?: Object): string; /** * Gets/Sets editor value. * - * @param newValue New editor value. + * @param newValue New editor value. */ value(newValue?: number): number; /** * Finds index of list item by text that matches with the search parameters. * - * @param number The text to search for. + * @param number The text to search for. */ findListItemIndex(number: number): number; getSelectedText(): void; @@ -28148,14 +28076,14 @@ interface IgCurrencyEditorMethods { /** * Increments value in editor according to the parameter or selects the previous item from the drop-down list if [isLimitedToListValues](ui.%%WidgetNameLowered%%#options:isLimitedToListValues) is enabled. * - * @param delta Increments value. + * @param delta Increments value. */ spinUp(delta?: number): void; /** * Decrements value in editor according to the parameter selects the next item from the drop-down list if [isLimitedToListValues](ui.%%WidgetNameLowered%%#options:isLimitedToListValues) is enabled. * - * @param delta Decrement value. + * @param delta Decrement value. */ spinDown(delta?: number): void; @@ -28210,7 +28138,6 @@ interface IgPercentEditor { * In addition, the maximum value that can be set to [minDecimals](ui.igPercentEditor#options:minDecimals) and [maxDecimals](ui.igPercentEditor#options:maxDecimals) options can be 15, when editor is in 'double' mode and 7, when in 'float' mode. * * - * * Valid values: * "double" the Number object is used with the limits of a double and if the value is not set, then the null or Number.NaN is used depending on the option [allowNullValue](ui.igpercenteditor#options:allowNullValue). Note: that is used as default. * "float" the Number object is used with the limits of a float and if the value is not set, then the null or Number.NaN is used depending on the option [allowNullValue](ui.igpercenteditor#options:allowNullValue). @@ -28358,7 +28285,6 @@ interface IgPercentEditor { * Notes: The "+" character is not supported in edit mode. * * - * * Valid values: * "null" scientific format is disabled. * "E" scientific format is enabled and the "E" character is used. @@ -28422,7 +28348,6 @@ interface IgPercentEditor { * Gets visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. * * - * * Valid values: * "dropdown" A button to open/close the list is located on the right side of the editor. * "clear" A button to clear the value is located on the right side of the editor. @@ -28601,28 +28526,28 @@ interface IgPercentEditorMethods { * Paste text at location of the caret or over the current selection. Best used during editing, as the method will instead set the text as value (modified by the [displayFactor](ui.igpercenteditor#options:displayFactor)) if the editor is not focused. * Note: the method raises the [textChanged](ui.igpercenteditor#events:textChanged) event. * - * @param string The string to be inserted. + * @param string The string to be inserted. */ insert(string: string): void; /** * Gets/Sets a string that is used as the percent symbol shown with the number in the input. The value provided as a param is propagated to the [percentSymbol](ui.igpercenteditor#options:percentSymbol) option and thus has the same priority as the option. * - * @param symbol New percent symbol. + * @param symbol New percent symbol. */ percentSymbol(symbol?: Object): string; /** * Gets/Sets editor value. * - * @param newValue New editor value. + * @param newValue New editor value. */ value(newValue?: number): number; /** * Finds index of list item by text that matches with the search parameters. * - * @param number The text to search for. + * @param number The text to search for. */ findListItemIndex(number: number): number; getSelectedText(): void; @@ -28632,14 +28557,14 @@ interface IgPercentEditorMethods { /** * Increments value in editor according to the parameter or selects the previous item from the drop-down list if [isLimitedToListValues](ui.%%WidgetNameLowered%%#options:isLimitedToListValues) is enabled. * - * @param delta Increments value. + * @param delta Increments value. */ spinUp(delta?: number): void; /** * Decrements value in editor according to the parameter selects the next item from the drop-down list if [isLimitedToListValues](ui.%%WidgetNameLowered%%#options:isLimitedToListValues) is enabled. * - * @param delta Decrement value. + * @param delta Decrement value. */ spinDown(delta?: number): void; @@ -28976,7 +28901,7 @@ interface IgMaskEditorMethods { /** * Gets/Sets mask editor value. * - * @param newValue New mask editor value. + * @param newValue New mask editor value. */ value(newValue?: string): string; dropDownContainer(): void; @@ -29026,15 +28951,15 @@ interface IgMaskEditorMethods { * Inserts the text at the location of the caret or over the current selection. If the editor is focused the method will insert the text over the current selection. If the editor is not focused the method will set the text as value of the editor. * Note: The method raises [textChanged](ui.igtexteditor#events:textChanged) event. * - * @param string The string to be inserted. + * @param string The string to be inserted. */ insert(string: string): void; /** * Selects the text between start and end indices in the editor. If the parameters are equal, then the method sets location of caret. The method has effect only when the editor has focus. * - * @param start Start of the selection. - * @param end End of the selection. + * @param start Start of the selection. + * @param end End of the selection. */ select(start: number, end: number): void; } @@ -29482,7 +29407,7 @@ interface IgDateEditorMethods { * * Note! This option doesn't use the dateInputFormat to extract the date * - * @param newValue New editor value. Date object can be set as value. String value can be passed and the editor will use the javascript Date object constructor to create date object and will use it for the comparison. MVC date format can be used too. For example Date(/"thicks"/). + * @param newValue New editor value. Date object can be set as value. String value can be passed and the editor will use the javascript Date object constructor to create date object and will use it for the comparison. MVC date format can be used too. For example Date(/"thicks"/). */ value(newValue?: Date): Date; @@ -29503,14 +29428,14 @@ interface IgDateEditorMethods { /** * Increases the date or time period, depending on the current cursor position. * - * @param delta The increase delta. + * @param delta The increase delta. */ spinUp(delta?: number): void; /** * Decreases the date or time period, depending on the current cursor position. * - * @param delta The decrease delta. + * @param delta The decrease delta. */ spinDown(delta?: number): void; @@ -30078,7 +30003,7 @@ interface IgDatePickerMethods { * * Note! This option doesn't use the dateInputFormat to extract the date * - * @param newValue New editor value. Date object can be set as value. String value can be passed and the editor will use the javascript Date object constructor to create date object and will use it for the comparison. MVC date format can be used too. For example Date(/"thicks"/). + * @param newValue New editor value. Date object can be set as value. String value can be passed and the editor will use the javascript Date object constructor to create date object and will use it for the comparison. MVC date format can be used too. For example Date(/"thicks"/). */ value(newValue?: Date): Date; @@ -30099,14 +30024,14 @@ interface IgDatePickerMethods { /** * Increases the date or time period, depending on the current cursor position. * - * @param delta The increase delta. + * @param delta The increase delta. */ spinUp(delta?: number): void; /** * Decreases the date or time period, depending on the current cursor position. * - * @param delta The decrease delta. + * @param delta The decrease delta. */ spinDown(delta?: number): void; @@ -30140,7 +30065,6 @@ interface IgCheckboxEditor { * Gets/Sets size of the checkbox based on preset styles.For different sizes, define 'width' and 'height' options instead. * * - * * Valid values: * "verysmall" The size of the Checkbox editor is very small. * "small" The size of the Checkbox editor is small. @@ -30377,7 +30301,7 @@ interface IgCheckboxEditorMethods { /** * Gets/Sets name attribute applied to the editor element. * - * @param newValue The new input name. + * @param newValue The new input name. */ inputName(newValue?: string): string; @@ -30399,7 +30323,7 @@ interface IgCheckboxEditorMethods { /** * Sets focus to the editor after the specified delay. * - * @param delay The delay before focusing the editor. + * @param delay The delay before focusing the editor. */ setFocus(delay?: number): void; @@ -30450,6 +30374,7 @@ interface JQuery { * Gets/Sets the width of the control. * */ + igBaseEditor(optionLiteral: 'option', optionName: "width"): string|number; /** @@ -30458,12 +30383,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igBaseEditor(optionLiteral: 'option', optionName: "width", optionValue: string|number): void; /** * Gets/Sets the height of the control. * */ + igBaseEditor(optionLiteral: 'option', optionName: "height"): string|number; /** @@ -30472,6 +30399,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igBaseEditor(optionLiteral: 'option', optionName: "height", optionValue: string|number): void; /** @@ -30522,6 +30450,7 @@ interface JQuery { * Gets/Sets the representation of null value. In case of default the value for the input is set to null, which makes the input to hold an empty string * */ + igBaseEditor(optionLiteral: 'option', optionName: "nullValue"): string|number; /** @@ -30530,6 +30459,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igBaseEditor(optionLiteral: 'option', optionName: "nullValue", optionValue: string|number): void; /** @@ -30921,17 +30851,17 @@ interface JQuery { /** * Gets visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. * - * */ + igTextEditor(optionLiteral: 'option', optionName: "buttonType"): string; /** * Visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. * * - * * @optionValue New value to be set. */ + igTextEditor(optionLiteral: 'option', optionName: "buttonType", optionValue: string): void; /** @@ -31076,6 +31006,7 @@ interface JQuery { * Gets/Sets the horizontal alignment of the text in the editor. * */ + igTextEditor(optionLiteral: 'option', optionName: "textAlign"): string; /** @@ -31084,6 +31015,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTextEditor(optionLiteral: 'option', optionName: "textAlign", optionValue: string): void; /** @@ -31104,6 +31036,7 @@ interface JQuery { * Gets/Sets the action when the editor gets focused. The default value is selectAll. * */ + igTextEditor(optionLiteral: 'option', optionName: "selectionOnFocus"): string; /** @@ -31112,12 +31045,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igTextEditor(optionLiteral: 'option', optionName: "selectionOnFocus", optionValue: string): void; /** * Gets the text mode of the editor such as: single-line text editor, password editor or multiline editor. That option has effect only on initialization. If based element (selector) is TEXTAREA, then it is used as input-field. * */ + igTextEditor(optionLiteral: 'option', optionName: "textMode"): string; /** @@ -31126,6 +31061,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTextEditor(optionLiteral: 'option', optionName: "textMode", optionValue: string): void; /** @@ -31188,6 +31124,7 @@ interface JQuery { * Gets/Sets the drop-down list opening orientation when the list gets open. If the option is set to auto the editor has priority to open the drop-down list bottom. If the space is not enough it tries to open the list top. If the space is not enough in both directions then the list gets opened at the bottom of the editor. * */ + igTextEditor(optionLiteral: 'option', optionName: "dropDownOrientation"): string; /** @@ -31196,6 +31133,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTextEditor(optionLiteral: 'option', optionName: "dropDownOrientation", optionValue: string): void; /** @@ -31314,6 +31252,7 @@ interface JQuery { * Gets/Sets the width of the control. * */ + igTextEditor(optionLiteral: 'option', optionName: "width"): string|number; /** @@ -31322,12 +31261,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igTextEditor(optionLiteral: 'option', optionName: "width", optionValue: string|number): void; /** * Gets/Sets the height of the control. * */ + igTextEditor(optionLiteral: 'option', optionName: "height"): string|number; /** @@ -31336,6 +31277,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTextEditor(optionLiteral: 'option', optionName: "height", optionValue: string|number): void; /** @@ -31386,6 +31328,7 @@ interface JQuery { * Gets/Sets the representation of null value. In case of default the value for the input is set to null, which makes the input to hold an empty string * */ + igTextEditor(optionLiteral: 'option', optionName: "nullValue"): string|number; /** @@ -31394,6 +31337,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTextEditor(optionLiteral: 'option', optionName: "nullValue", optionValue: string|number): void; /** @@ -32126,6 +32070,7 @@ interface JQuery { * Gets/Sets the horizontal alignment of the text in the editor. * */ + igNumericEditor(optionLiteral: 'option', optionName: "textAlign"): string; /** @@ -32134,6 +32079,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igNumericEditor(optionLiteral: 'option', optionName: "textAlign", optionValue: string): void; /** @@ -32141,8 +32087,8 @@ interface JQuery { * The range for the specific type follows the numeric type standards, e.g. in .NET Framework [floating-point](https://msdn.microsoft.com/en-us/library/9ahet949.aspx) types and [integral types](https://msdn.microsoft.com/en-us/library/exx3b86w.aspx). * In addition, the maximum value that can be set to [minDecimals](ui.igNumericEditor#options:minDecimals) and [maxDecimals](ui.igNumericEditor#options:maxDecimals) options can be 15, when editor is in 'double' mode and 7, when in 'float' mode. * - * */ + igNumericEditor(optionLiteral: 'option', optionName: "dataMode"): string; /** @@ -32151,9 +32097,9 @@ interface JQuery { * In addition, the maximum value that can be set to [minDecimals](ui.igNumericEditor#options:minDecimals) and [maxDecimals](ui.igNumericEditor#options:maxDecimals) options can be 15, when editor is in 'double' mode and 7, when in 'float' mode. * * - * * @optionValue New value to be set. */ + igNumericEditor(optionLiteral: 'option', optionName: "dataMode", optionValue: string): void; /** @@ -32219,8 +32165,8 @@ interface JQuery { * If that option is set, then numeric value appears as a string with possible E-power flag. In edit mode the "E" or "e" character can be entered as well. * Notes: The "+" character is not supported in edit mode. * - * */ + igNumericEditor(optionLiteral: 'option', optionName: "scientificFormat"): string; /** @@ -32229,9 +32175,9 @@ interface JQuery { * Notes: The "+" character is not supported in edit mode. * * - * * @optionValue New value to be set. */ + igNumericEditor(optionLiteral: 'option', optionName: "scientificFormat", optionValue: string): void; /** @@ -32351,17 +32297,17 @@ interface JQuery { /** * Gets visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. * - * */ + igNumericEditor(optionLiteral: 'option', optionName: "buttonType"): string; /** * Visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. * * - * * @optionValue New value to be set. */ + igNumericEditor(optionLiteral: 'option', optionName: "buttonType", optionValue: string): void; /** @@ -32464,6 +32410,7 @@ interface JQuery { * Gets/Sets the action when the editor gets focused. The default value is selectAll. * */ + igNumericEditor(optionLiteral: 'option', optionName: "selectionOnFocus"): string; /** @@ -32472,6 +32419,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igNumericEditor(optionLiteral: 'option', optionName: "selectionOnFocus", optionValue: string): void; /** @@ -32506,6 +32454,7 @@ interface JQuery { * Gets/Sets the drop-down list opening orientation when the list gets open. If the option is set to auto the editor has priority to open the drop-down list bottom. If the space is not enough it tries to open the list top. If the space is not enough in both directions then the list gets opened at the bottom of the editor. * */ + igNumericEditor(optionLiteral: 'option', optionName: "dropDownOrientation"): string; /** @@ -32514,6 +32463,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igNumericEditor(optionLiteral: 'option', optionName: "dropDownOrientation", optionValue: string): void; /** @@ -32584,6 +32534,7 @@ interface JQuery { * Gets/Sets the width of the control. * */ + igNumericEditor(optionLiteral: 'option', optionName: "width"): string|number; /** @@ -32592,12 +32543,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igNumericEditor(optionLiteral: 'option', optionName: "width", optionValue: string|number): void; /** * Gets/Sets the height of the control. * */ + igNumericEditor(optionLiteral: 'option', optionName: "height"): string|number; /** @@ -32606,6 +32559,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igNumericEditor(optionLiteral: 'option', optionName: "height", optionValue: string|number): void; /** @@ -32626,6 +32580,7 @@ interface JQuery { * Gets/Sets the representation of null value. In case of default the value for the input is set to null, which makes the input to hold an empty string * */ + igNumericEditor(optionLiteral: 'option', optionName: "nullValue"): string|number; /** @@ -32634,6 +32589,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igNumericEditor(optionLiteral: 'option', optionName: "nullValue", optionValue: string|number): void; /** @@ -33098,6 +33054,7 @@ interface JQuery { * Gets/Sets the horizontal alignment of the text in the editor. * */ + igCurrencyEditor(optionLiteral: 'option', optionName: "textAlign"): string; /** @@ -33106,6 +33063,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igCurrencyEditor(optionLiteral: 'option', optionName: "textAlign", optionValue: string): void; /** @@ -33113,8 +33071,8 @@ interface JQuery { * The range for the specific type follows the numeric type standards, e.g. in .NET Framework [floating-point](https://msdn.microsoft.com/en-us/library/9ahet949.aspx) types and [integral types](https://msdn.microsoft.com/en-us/library/exx3b86w.aspx). * In addition, the maximum value that can be set to [minDecimals](ui.igNumericEditor#options:minDecimals) and [maxDecimals](ui.igNumericEditor#options:maxDecimals) options can be 15, when editor is in 'double' mode and 7, when in 'float' mode. * - * */ + igCurrencyEditor(optionLiteral: 'option', optionName: "dataMode"): string; /** @@ -33123,9 +33081,9 @@ interface JQuery { * In addition, the maximum value that can be set to [minDecimals](ui.igNumericEditor#options:minDecimals) and [maxDecimals](ui.igNumericEditor#options:maxDecimals) options can be 15, when editor is in 'double' mode and 7, when in 'float' mode. * * - * * @optionValue New value to be set. */ + igCurrencyEditor(optionLiteral: 'option', optionName: "dataMode", optionValue: string): void; /** @@ -33191,8 +33149,8 @@ interface JQuery { * If that option is set, then numeric value appears as a string with possible E-power flag. In edit mode the "E" or "e" character can be entered as well. * Notes: The "+" character is not supported in edit mode. * - * */ + igCurrencyEditor(optionLiteral: 'option', optionName: "scientificFormat"): string; /** @@ -33201,9 +33159,9 @@ interface JQuery { * Notes: The "+" character is not supported in edit mode. * * - * * @optionValue New value to be set. */ + igCurrencyEditor(optionLiteral: 'option', optionName: "scientificFormat", optionValue: string): void; /** @@ -33323,17 +33281,17 @@ interface JQuery { /** * Gets visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. * - * */ + igCurrencyEditor(optionLiteral: 'option', optionName: "buttonType"): string; /** * Visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. * * - * * @optionValue New value to be set. */ + igCurrencyEditor(optionLiteral: 'option', optionName: "buttonType", optionValue: string): void; /** @@ -33436,6 +33394,7 @@ interface JQuery { * Gets/Sets the action when the editor gets focused. The default value is selectAll. * */ + igCurrencyEditor(optionLiteral: 'option', optionName: "selectionOnFocus"): string; /** @@ -33444,6 +33403,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igCurrencyEditor(optionLiteral: 'option', optionName: "selectionOnFocus", optionValue: string): void; /** @@ -33478,6 +33438,7 @@ interface JQuery { * Gets/Sets the drop-down list opening orientation when the list gets open. If the option is set to auto the editor has priority to open the drop-down list bottom. If the space is not enough it tries to open the list top. If the space is not enough in both directions then the list gets opened at the bottom of the editor. * */ + igCurrencyEditor(optionLiteral: 'option', optionName: "dropDownOrientation"): string; /** @@ -33486,6 +33447,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igCurrencyEditor(optionLiteral: 'option', optionName: "dropDownOrientation", optionValue: string): void; /** @@ -33556,6 +33518,7 @@ interface JQuery { * Gets/Sets the width of the control. * */ + igCurrencyEditor(optionLiteral: 'option', optionName: "width"): string|number; /** @@ -33564,12 +33527,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igCurrencyEditor(optionLiteral: 'option', optionName: "width", optionValue: string|number): void; /** * Gets/Sets the height of the control. * */ + igCurrencyEditor(optionLiteral: 'option', optionName: "height"): string|number; /** @@ -33578,6 +33543,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igCurrencyEditor(optionLiteral: 'option', optionName: "height", optionValue: string|number): void; /** @@ -33598,6 +33564,7 @@ interface JQuery { * Gets/Sets the representation of null value. In case of default the value for the input is set to null, which makes the input to hold an empty string * */ + igCurrencyEditor(optionLiteral: 'option', optionName: "nullValue"): string|number; /** @@ -33606,6 +33573,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igCurrencyEditor(optionLiteral: 'option', optionName: "nullValue", optionValue: string|number): void; /** @@ -33748,8 +33716,8 @@ interface JQuery { * The range for the specific type follows the numeric type standards, e.g. in .NET Framework [floating-point](https://msdn.microsoft.com/en-us/library/9ahet949.aspx) types and [integral types](https://msdn.microsoft.com/en-us/library/exx3b86w.aspx). * In addition, the maximum value that can be set to [minDecimals](ui.igPercentEditor#options:minDecimals) and [maxDecimals](ui.igPercentEditor#options:maxDecimals) options can be 15, when editor is in 'double' mode and 7, when in 'float' mode. * - * */ + igPercentEditor(optionLiteral: 'option', optionName: "dataMode"): string; /** @@ -33758,9 +33726,9 @@ interface JQuery { * In addition, the maximum value that can be set to [minDecimals](ui.igPercentEditor#options:minDecimals) and [maxDecimals](ui.igPercentEditor#options:maxDecimals) options can be 15, when editor is in 'double' mode and 7, when in 'float' mode. * * - * * @optionValue New value to be set. */ + igPercentEditor(optionLiteral: 'option', optionName: "dataMode", optionValue: string): void; /** @@ -33983,6 +33951,7 @@ interface JQuery { * Gets/Sets the horizontal alignment of the text in the editor. * */ + igPercentEditor(optionLiteral: 'option', optionName: "textAlign"): string; /** @@ -33991,6 +33960,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igPercentEditor(optionLiteral: 'option', optionName: "textAlign", optionValue: string): void; /** @@ -34042,8 +34012,8 @@ interface JQuery { * If that option is set, then numeric value appears as a string with possible E-power flag. In edit mode the "E" or "e" character can be entered as well. * Notes: The "+" character is not supported in edit mode. * - * */ + igPercentEditor(optionLiteral: 'option', optionName: "scientificFormat"): string; /** @@ -34052,9 +34022,9 @@ interface JQuery { * Notes: The "+" character is not supported in edit mode. * * - * * @optionValue New value to be set. */ + igPercentEditor(optionLiteral: 'option', optionName: "scientificFormat", optionValue: string): void; /** @@ -34174,17 +34144,17 @@ interface JQuery { /** * Gets visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. * - * */ + igPercentEditor(optionLiteral: 'option', optionName: "buttonType"): string; /** * Visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. * * - * * @optionValue New value to be set. */ + igPercentEditor(optionLiteral: 'option', optionName: "buttonType", optionValue: string): void; /** @@ -34287,6 +34257,7 @@ interface JQuery { * Gets/Sets the action when the editor gets focused. The default value is selectAll. * */ + igPercentEditor(optionLiteral: 'option', optionName: "selectionOnFocus"): string; /** @@ -34295,6 +34266,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igPercentEditor(optionLiteral: 'option', optionName: "selectionOnFocus", optionValue: string): void; /** @@ -34329,6 +34301,7 @@ interface JQuery { * Gets/Sets the drop-down list opening orientation when the list gets open. If the option is set to auto the editor has priority to open the drop-down list bottom. If the space is not enough it tries to open the list top. If the space is not enough in both directions then the list gets opened at the bottom of the editor. * */ + igPercentEditor(optionLiteral: 'option', optionName: "dropDownOrientation"): string; /** @@ -34337,6 +34310,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igPercentEditor(optionLiteral: 'option', optionName: "dropDownOrientation", optionValue: string): void; /** @@ -34407,6 +34381,7 @@ interface JQuery { * Gets/Sets the width of the control. * */ + igPercentEditor(optionLiteral: 'option', optionName: "width"): string|number; /** @@ -34415,12 +34390,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igPercentEditor(optionLiteral: 'option', optionName: "width", optionValue: string|number): void; /** * Gets/Sets the height of the control. * */ + igPercentEditor(optionLiteral: 'option', optionName: "height"): string|number; /** @@ -34429,6 +34406,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igPercentEditor(optionLiteral: 'option', optionName: "height", optionValue: string|number): void; /** @@ -34449,6 +34427,7 @@ interface JQuery { * Gets/Sets the representation of null value. In case of default the value for the input is set to null, which makes the input to hold an empty string * */ + igPercentEditor(optionLiteral: 'option', optionName: "nullValue"): string|number; /** @@ -34457,6 +34436,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igPercentEditor(optionLiteral: 'option', optionName: "nullValue", optionValue: string|number): void; /** @@ -34565,6 +34545,7 @@ interface JQuery { * Gets visibility of the clear button. That option can be set only on initialization. * */ + igMaskEditor(optionLiteral: 'option', optionName: "buttonType"): string; /** @@ -34573,6 +34554,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igMaskEditor(optionLiteral: 'option', optionName: "buttonType", optionValue: string): void; /** @@ -34625,6 +34607,7 @@ interface JQuery { * It affects the value of the control (value method/option and submitted in forms). It defines what the value should contain from text, unfilled prompts and literals. The default is allText and when used value method/option returns the text entered, all prompts (positions) and literals. * */ + igMaskEditor(optionLiteral: 'option', optionName: "dataMode"): string; /** @@ -34633,6 +34616,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igMaskEditor(optionLiteral: 'option', optionName: "dataMode", optionValue: string): void; /** @@ -34878,19 +34862,14 @@ interface JQuery { * @optionValue New value to be set. */ igMaskEditor(optionLiteral: 'option', optionName: "value", optionValue: any): void; - - /** - */ igMaskEditor(optionLiteral: 'option', optionName: "suppressKeyboard"): boolean; - - /** - */ igMaskEditor(optionLiteral: 'option', optionName: "suppressKeyboard", optionValue: boolean): void; /** * Gets/Sets the horizontal alignment of the text in the editor. * */ + igMaskEditor(optionLiteral: 'option', optionName: "textAlign"): string; /** @@ -34899,6 +34878,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igMaskEditor(optionLiteral: 'option', optionName: "textAlign", optionValue: string): void; /** @@ -34919,6 +34899,7 @@ interface JQuery { * Gets/Sets the action when the editor gets focused. The default value is selectAll. * */ + igMaskEditor(optionLiteral: 'option', optionName: "selectionOnFocus"): string; /** @@ -34927,6 +34908,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igMaskEditor(optionLiteral: 'option', optionName: "selectionOnFocus", optionValue: string): void; /** @@ -35021,6 +35003,7 @@ interface JQuery { * Gets/Sets the width of the control. * */ + igMaskEditor(optionLiteral: 'option', optionName: "width"): string|number; /** @@ -35029,12 +35012,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igMaskEditor(optionLiteral: 'option', optionName: "width", optionValue: string|number): void; /** * Gets/Sets the height of the control. * */ + igMaskEditor(optionLiteral: 'option', optionName: "height"): string|number; /** @@ -35043,6 +35028,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igMaskEditor(optionLiteral: 'option', optionName: "height", optionValue: string|number): void; /** @@ -35079,6 +35065,7 @@ interface JQuery { * Gets/Sets the representation of null value. In case of default the value for the input is set to null, which makes the input to hold an empty string * */ + igMaskEditor(optionLiteral: 'option', optionName: "nullValue"): string|number; /** @@ -35087,6 +35074,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igMaskEditor(optionLiteral: 'option', optionName: "nullValue", optionValue: string|number): void; /** @@ -35148,53 +35136,17 @@ interface JQuery { * @optionValue New value to be set. */ igMaskEditor(optionLiteral: 'option', optionName: "validatorOptions", optionValue: any): void; - - /** - */ igMaskEditor(optionLiteral: 'option', optionName: "dropDownListOpening"): DropDownListOpeningEvent; - - /** - */ igMaskEditor(optionLiteral: 'option', optionName: "dropDownListOpening", optionValue: DropDownListOpeningEvent): void; - - /** - */ igMaskEditor(optionLiteral: 'option', optionName: "dropDownListOpened"): DropDownListOpenedEvent; - - /** - */ igMaskEditor(optionLiteral: 'option', optionName: "dropDownListOpened", optionValue: DropDownListOpenedEvent): void; - - /** - */ igMaskEditor(optionLiteral: 'option', optionName: "dropDownListClosing"): DropDownListClosingEvent; - - /** - */ igMaskEditor(optionLiteral: 'option', optionName: "dropDownListClosing", optionValue: DropDownListClosingEvent): void; - - /** - */ igMaskEditor(optionLiteral: 'option', optionName: "dropDownListClosed"): DropDownListClosedEvent; - - /** - */ igMaskEditor(optionLiteral: 'option', optionName: "dropDownListClosed", optionValue: DropDownListClosedEvent): void; - - /** - */ igMaskEditor(optionLiteral: 'option', optionName: "dropDownItemSelecting"): DropDownItemSelectingEvent; - - /** - */ igMaskEditor(optionLiteral: 'option', optionName: "dropDownItemSelecting", optionValue: DropDownItemSelectingEvent): void; - - /** - */ igMaskEditor(optionLiteral: 'option', optionName: "dropDownItemSelected"): DropDownItemSelectedEvent; - - /** - */ igMaskEditor(optionLiteral: 'option', optionName: "dropDownItemSelected", optionValue: DropDownItemSelectedEvent): void; /** @@ -35447,6 +35399,7 @@ interface JQuery { * "2016-11-11T10:00:00+05:00" * */ + igDateEditor(optionLiteral: 'option', optionName: "dataMode"): string; /** @@ -35458,6 +35411,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igDateEditor(optionLiteral: 'option', optionName: "dataMode", optionValue: string): void; /** @@ -35482,6 +35436,7 @@ interface JQuery { * Gets visibility of the spin and clear buttons. That option can be set only on initialization. Combinations like 'spin,clear' are supported too. * */ + igDateEditor(optionLiteral: 'option', optionName: "buttonType"): string; /** @@ -35490,6 +35445,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igDateEditor(optionLiteral: 'option', optionName: "buttonType", optionValue: string): void; /** @@ -35582,6 +35538,7 @@ interface JQuery { * Gets/Sets the representation of null value. In case of default the value for the input is set to null, which makes the input to hold an empty string * */ + igDateEditor(optionLiteral: 'option', optionName: "nullValue"): string|number|Date; /** @@ -35590,6 +35547,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igDateEditor(optionLiteral: 'option', optionName: "nullValue", optionValue: string|number|Date): void; /** @@ -35747,13 +35705,7 @@ interface JQuery { * @optionValue New value to be set. */ igDateEditor(optionLiteral: 'option', optionName: "toLower", optionValue: boolean): void; - - /** - */ igDateEditor(optionLiteral: 'option', optionName: "suppressKeyboard"): boolean; - - /** - */ igDateEditor(optionLiteral: 'option', optionName: "suppressKeyboard", optionValue: boolean): void; /** @@ -35876,6 +35828,7 @@ interface JQuery { * Gets/Sets the horizontal alignment of the text in the editor. * */ + igDateEditor(optionLiteral: 'option', optionName: "textAlign"): string; /** @@ -35884,6 +35837,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igDateEditor(optionLiteral: 'option', optionName: "textAlign", optionValue: string): void; /** @@ -35904,6 +35858,7 @@ interface JQuery { * Gets/Sets the action when the editor gets focused. The default value is selectAll. * */ + igDateEditor(optionLiteral: 'option', optionName: "selectionOnFocus"): string; /** @@ -35912,6 +35867,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igDateEditor(optionLiteral: 'option', optionName: "selectionOnFocus", optionValue: string): void; /** @@ -35974,6 +35930,7 @@ interface JQuery { * Gets/Sets the width of the control. * */ + igDateEditor(optionLiteral: 'option', optionName: "width"): string|number; /** @@ -35982,12 +35939,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igDateEditor(optionLiteral: 'option', optionName: "width", optionValue: string|number): void; /** * Gets/Sets the height of the control. * */ + igDateEditor(optionLiteral: 'option', optionName: "height"): string|number; /** @@ -35996,6 +35955,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igDateEditor(optionLiteral: 'option', optionName: "height", optionValue: string|number): void; /** @@ -36203,6 +36163,7 @@ interface JQuery { * Gets visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too. * */ + igDatePicker(optionLiteral: 'option', optionName: "buttonType"): string; /** @@ -36211,6 +36172,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igDatePicker(optionLiteral: 'option', optionName: "buttonType", optionValue: string): void; /** @@ -36524,6 +36486,7 @@ interface JQuery { * "2016-11-11T10:00:00+05:00" * */ + igDatePicker(optionLiteral: 'option', optionName: "dataMode"): string; /** @@ -36535,6 +36498,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igDatePicker(optionLiteral: 'option', optionName: "dataMode", optionValue: string): void; /** @@ -36645,6 +36609,7 @@ interface JQuery { * Gets/Sets the representation of null value. In case of default the value for the input is set to null, which makes the input to hold an empty string * */ + igDatePicker(optionLiteral: 'option', optionName: "nullValue"): string|number|Date; /** @@ -36653,6 +36618,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igDatePicker(optionLiteral: 'option', optionName: "nullValue", optionValue: string|number|Date): void; /** @@ -36845,6 +36811,7 @@ interface JQuery { * Gets/Sets the horizontal alignment of the text in the editor. * */ + igDatePicker(optionLiteral: 'option', optionName: "textAlign"): string; /** @@ -36853,6 +36820,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igDatePicker(optionLiteral: 'option', optionName: "textAlign", optionValue: string): void; /** @@ -36873,6 +36841,7 @@ interface JQuery { * Gets/Sets the action when the editor gets focused. The default value is selectAll. * */ + igDatePicker(optionLiteral: 'option', optionName: "selectionOnFocus"): string; /** @@ -36881,6 +36850,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igDatePicker(optionLiteral: 'option', optionName: "selectionOnFocus", optionValue: string): void; /** @@ -36943,6 +36913,7 @@ interface JQuery { * Gets/Sets the width of the control. * */ + igDatePicker(optionLiteral: 'option', optionName: "width"): string|number; /** @@ -36951,12 +36922,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igDatePicker(optionLiteral: 'option', optionName: "width", optionValue: string|number): void; /** * Gets/Sets the height of the control. * */ + igDatePicker(optionLiteral: 'option', optionName: "height"): string|number; /** @@ -36965,6 +36938,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igDatePicker(optionLiteral: 'option', optionName: "height", optionValue: string|number): void; /** @@ -37212,17 +37186,17 @@ interface JQuery { /** * Gets/Sets size of the checkbox based on preset styles.For different sizes, define 'width' and 'height' options instead. * - * */ + igCheckboxEditor(optionLiteral: 'option', optionName: "size"): string; /** * /Sets size of the checkbox based on preset styles.For different sizes, define 'width' and 'height' options instead. * * - * * @optionValue New value to be set. */ + igCheckboxEditor(optionLiteral: 'option', optionName: "size", optionValue: string): void; /** @@ -37268,27 +37242,16 @@ interface JQuery { * @optionValue New value to be set. */ igCheckboxEditor(optionLiteral: 'option', optionName: "readOnly", optionValue: boolean): void; - - /** - */ igCheckboxEditor(optionLiteral: 'option', optionName: "allowNullValue"): boolean; - - /** - */ igCheckboxEditor(optionLiteral: 'option', optionName: "allowNullValue", optionValue: boolean): void; - - /** - */ igCheckboxEditor(optionLiteral: 'option', optionName: "nullValue"): any; - - /** - */ igCheckboxEditor(optionLiteral: 'option', optionName: "nullValue", optionValue: any): void; /** * Gets/Sets the width of the control. * */ + igCheckboxEditor(optionLiteral: 'option', optionName: "width"): string|number; /** @@ -37297,12 +37260,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igCheckboxEditor(optionLiteral: 'option', optionName: "width", optionValue: string|number): void; /** * Gets/Sets the height of the control. * */ + igCheckboxEditor(optionLiteral: 'option', optionName: "height"): string|number; /** @@ -37311,6 +37276,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igCheckboxEditor(optionLiteral: 'option', optionName: "height", optionValue: string|number): void; /** @@ -38000,30 +37966,30 @@ interface IgFunnelChartMethods { /** * Gets array of selected slice items. * - * @param selection Array or selected slice items. - * @return array|object If parameter is undefined, then array of selected items is returned. Otherwise, it returns reference to igFunnelChart. + * @param selection Array or selected slice items. + * @return array|object If parameter is undefined, then array of selected items is returned. Otherwise, it returns reference to igFunnelChart. */ selectedSliceItems(selection?: any[]): any[]; /** * Gets sets array of indexes of selected slices. * - * @param selection Array or selected slice indexes. - * @return array|object If parameter is undefined, then array of selected indexes is returned. Otherwise, it returns reference to igFunnelChart. + * @param selection Array or selected slice indexes. + * @return array|object If parameter is undefined, then array of selected indexes is returned. Otherwise, it returns reference to igFunnelChart. */ selectedSliceIndexes(selection?: any[]): any[]; /** * Checks if slice is selected. * - * @param slice Index of slice or reference to slice-data-item. + * @param slice Index of slice or reference to slice-data-item. */ isSelected(slice: Object): boolean; /** * Toggles selected state of slice. * - * @param slice Index of slice or reference to slice-data-item. + * @param slice Index of slice or reference to slice-data-item. */ toggleSelection(slice: Object): Object; exportVisualData(): void; @@ -38036,14 +38002,14 @@ interface IgFunnelChartMethods { /** * Find index of item within actual data used by chart. * - * @param item The reference to item. + * @param item The reference to item. */ findIndexOfItem(item: Object): number; /** * Get item within actual data used by chart. That is similar to this.getData()[ index ]. * - * @param index Index of data item. + * @param index Index of data item. */ getDataItem(index: Object): Object; @@ -38055,40 +38021,40 @@ interface IgFunnelChartMethods { /** * Adds a new item to the data source and notifies the chart. * - * @param item The item that we want to add to the data source. + * @param item The item that we want to add to the data source. */ addItem(item: Object): Object; /** * Inserts a new item to the data source and notifies the chart. * - * @param item the new item that we want to insert in the data source. - * @param index The index in the data source where the new item will be inserted. + * @param item the new item that we want to insert in the data source. + * @param index The index in the data source where the new item will be inserted. */ insertItem(item: Object, index: number): Object; /** * Deletes an item from the data source and notifies the chart. * - * @param index The index in the data source from where the item will be been removed. + * @param index The index in the data source from where the item will be been removed. */ removeItem(index: number): Object; /** * Updates an item in the data source and notifies the chart. * - * @param index The index of the item in the data source that we want to change. - * @param item The new item object that will be set in the data source. + * @param index The index of the item in the data source that we want to change. + * @param item The new item object that will be set in the data source. */ setItem(index: number, item: Object): Object; /** * Notifies the chart that an item has been set in an associated data source. * - * @param dataSource The data source in which the change happened. - * @param index The index in the items source that has been changed. - * @param newItem the new item that has been set in the collection. - * @param oldItem the old item that has been overwritten in the collection. + * @param dataSource The data source in which the change happened. + * @param index The index in the items source that has been changed. + * @param newItem the new item that has been set in the collection. + * @param oldItem the old item that has been overwritten in the collection. */ notifySetItem(dataSource: Object, index: number, newItem: Object, oldItem: Object): Object; @@ -38096,7 +38062,7 @@ interface IgFunnelChartMethods { * Notifies the chart that the items have been cleared from an associated data source. * It's not necessary to notify more than one target of a change if they share the same items source. * - * @param dataSource The data source in which the change happened. + * @param dataSource The data source in which the change happened. */ notifyClearItems(dataSource: Object): Object; @@ -38104,9 +38070,9 @@ interface IgFunnelChartMethods { * Notifies the target axis or series that an item has been inserted at the specified index in its data source. * It's not necessary to notify more than one target of a change if they share the same items source. * - * @param dataSource The data source in which the change happened. - * @param index The index in the items source where the new item has been inserted. - * @param newItem the new item that has been set in the collection. + * @param dataSource The data source in which the change happened. + * @param index The index in the items source where the new item has been inserted. + * @param newItem the new item that has been set in the collection. */ notifyInsertItem(dataSource: Object, index: number, newItem: Object): Object; @@ -38114,9 +38080,9 @@ interface IgFunnelChartMethods { * Notifies the target axis or series that an item has been removed from the specified index in its data source. * It's not necessary to notify more than one target of a change if they share the same items source. * - * @param dataSource The data source in which the change happened. - * @param index The index in the items source from where the old item has been removed. - * @param oldItem the old item that has been removed from the collection. + * @param dataSource The data source in which the change happened. + * @param index The index in the items source from where the old item has been removed. + * @param oldItem the old item that has been removed from the collection. */ notifyRemoveItem(dataSource: Object, index: number, oldItem: Object): Object; @@ -38292,6 +38258,7 @@ interface JQuery { /** * Gets whether the inner labels are visible. */ + igFunnelChart(optionLiteral: 'option', optionName: "innerLabelVisibility"): string; /** @@ -38299,11 +38266,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igFunnelChart(optionLiteral: 'option', optionName: "innerLabelVisibility", optionValue: string): void; /** * Gets whether the outer labels are visible. */ + igFunnelChart(optionLiteral: 'option', optionName: "outerLabelVisibility"): string; /** @@ -38311,11 +38280,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igFunnelChart(optionLiteral: 'option', optionName: "outerLabelVisibility", optionValue: string): void; /** * Gets which side of the chart the outer labels should appear. */ + igFunnelChart(optionLiteral: 'option', optionName: "outerLabelAlignment"): string; /** @@ -38323,11 +38294,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igFunnelChart(optionLiteral: 'option', optionName: "outerLabelAlignment", optionValue: string): void; /** * Gets the how the heights of the funnel slices should be configured. */ + igFunnelChart(optionLiteral: 'option', optionName: "funnelSliceDisplay"): string; /** @@ -38335,6 +38308,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igFunnelChart(optionLiteral: 'option', optionName: "funnelSliceDisplay", optionValue: string): void; /** @@ -38564,21 +38538,9 @@ interface JQuery { * @optionValue New value to be set. */ igFunnelChart(optionLiteral: 'option', optionName: "pixelScalingRatio", optionValue: number): void; - - /** - */ igFunnelChart(optionLiteral: 'option', optionName: "outerLabelTextColor"): any; - - /** - */ igFunnelChart(optionLiteral: 'option', optionName: "outerLabelTextColor", optionValue: any): void; - - /** - */ igFunnelChart(optionLiteral: 'option', optionName: "textColor"): any; - - /** - */ igFunnelChart(optionLiteral: 'option', optionName: "textColor", optionValue: any): void; /** @@ -38961,6 +38923,7 @@ interface JQuery { * Defines local or remote type of appending rows on demand in igGrid * */ + igGridAppendRowsOnDemand(optionLiteral: 'option', optionName: "type"): string; /** @@ -38969,6 +38932,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridAppendRowsOnDemand(optionLiteral: 'option', optionName: "type", optionValue: string): void; /** @@ -39059,6 +39023,7 @@ interface JQuery { * Denotes the append rows on demand request method * */ + igGridAppendRowsOnDemand(optionLiteral: 'option', optionName: "loadTrigger"): string; /** @@ -39067,6 +39032,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridAppendRowsOnDemand(optionLiteral: 'option', optionName: "loadTrigger", optionValue: string): void; /** @@ -39232,6 +39198,7 @@ interface JQuery { * Controls the initial state * */ + igGridCellMerging(optionLiteral: 'option', optionName: "initialState"): string; /** @@ -39240,6 +39207,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridCellMerging(optionLiteral: 'option', optionName: "initialState", optionValue: string): void; /** @@ -39265,13 +39233,7 @@ interface JQuery { * @optionValue Define event handler function. */ igGridCellMerging(optionLiteral: 'option', optionName: "cellsMerging", optionValue: CellsMergingEvent): void; - - /** - */ igGridCellMerging(optionLiteral: 'option', optionName: "cellsMerged"): CellsMergedEvent; - - /** - */ igGridCellMerging(optionLiteral: 'option', optionName: "cellsMerged", optionValue: CellsMergedEvent): void; igGridCellMerging(options: IgGridCellMerging): JQuery; igGridCellMerging(optionLiteral: 'option', optionName: string): any; @@ -39315,6 +39277,20 @@ interface ColumnFixingEvent { } interface ColumnFixingEventUIParam { + /** + * Gets the columnKey or the columnIndex. + */ + columnIdentifier?: any; + + /** + * Gets whether the header cell has children(use this argument ONLY when multi-column-headers are enabled). + */ + isGroupHeader?: boolean; + + /** + * Gets a reference to the widget. + */ + owner?: any; } interface ColumnFixedEvent { @@ -39322,6 +39298,20 @@ interface ColumnFixedEvent { } interface ColumnFixedEventUIParam { + /** + * Gets the columnKey or the columnIndex. + */ + columnIdentifier?: any; + + /** + * Gets whether header cell has children(use this argument ONLY when multi-column-headers are enabled). + */ + isGroupHeader?: boolean; + + /** + * Gets a reference to the widget. + */ + owner?: any; } interface ColumnUnfixingEvent { @@ -39329,6 +39319,20 @@ interface ColumnUnfixingEvent { } interface ColumnUnfixingEventUIParam { + /** + * Gets the columnKey or the columnIndex. + */ + columnIdentifier?: any; + + /** + * Gets whether header cell has children(use this argument ONLY when multi-column-headers are enabled). + */ + isGroupHeader?: boolean; + + /** + * Gets a reference to the widget. + */ + owner?: any; } interface ColumnUnfixedEvent { @@ -39336,6 +39340,20 @@ interface ColumnUnfixedEvent { } interface ColumnUnfixedEventUIParam { + /** + * Gets the columnKey or the columnIndex. + */ + columnIdentifier?: any; + + /** + * Gets whether header cell has children(use this argument ONLY when multi-column-headers are enabled). + */ + isGroupHeader?: boolean; + + /** + * Gets a reference to the widget. + */ + owner?: any; } interface ColumnFixingRefusedEvent { @@ -39343,6 +39361,25 @@ interface ColumnFixingRefusedEvent { } interface ColumnFixingRefusedEventUIParam { + /** + * Gets the columnKey or the columnIndex. + */ + columnIdentifier?: any; + + /** + * Gets whether header cell has children(use this argument ONLY when multi-column-headers are enabled). + */ + isGroupHeader?: boolean; + + /** + * Gets the error message describing the reason fixing has failed. + */ + errorMessage?: string; + + /** + * Gets a reference to the widget. + */ + owner?: any; } interface ColumnUnfixingRefusedEvent { @@ -39350,6 +39387,25 @@ interface ColumnUnfixingRefusedEvent { } interface ColumnUnfixingRefusedEventUIParam { + /** + * Gets the columnKey or the columnIndex. + */ + columnIdentifier?: any; + + /** + * Gets whether header cell has children(use this argument ONLY when multi-column-headers are enabled). + */ + isGroupHeader?: boolean; + + /** + * Gets the error message describing the reason fixing has failed. + */ + errorMessage?: string; + + /** + * Gets a reference to the widget. + */ + owner?: any; } interface IgGridColumnFixing { @@ -39471,9 +39527,9 @@ interface IgGridColumnFixingMethods { /** * Unfixes a column by specified column identifier - column key or column index. * - * @param colIdentifier An identifier of the column to be unfixed - column index or column key. - * @param target Key of the column where the unfixed column should move to. - * @param after Specifies where the unfixed column should be rendered after or before the target column. This parameter is disregarded if there is no target column specified. + * @param colIdentifier An identifier of the column to be unfixed - column index or column key. + * @param target Key of the column where the unfixed column should move to. + * @param after Specifies where the unfixed column should be rendered after or before the target column. This parameter is disregarded if there is no target column specified. */ unfixColumn(colIdentifier: Object, target?: string, after?: boolean): Object; @@ -39485,38 +39541,38 @@ interface IgGridColumnFixingMethods { /** * If the 'check' argument is set to true, checks whether the heights of fixed and unfixed tables are equal, if not sync them. Similar check is made for heights of table rows. If the clearRowsHeights argument is set to true, clears rows heights before syncing them. * - * @param check If set to true, checks whether the heights of fixed and unfixed tables are equal, if not sync them. If this argument is set to false sync is performed regardless of the current heights. - * @param clearRowsHeights Clears row heigths for all visible rows. + * @param check If set to true, checks whether the heights of fixed and unfixed tables are equal, if not sync them. If this argument is set to false sync is performed regardless of the current heights. + * @param clearRowsHeights Clears row heigths for all visible rows. */ syncHeights(check?: boolean, clearRowsHeights?: boolean): void; /** * Returns whether the column with the specified key is a column group header, when the [multi-column headers](http://www.igniteui.com/help/iggrid-multicolumnheaders-landingpage) feature is used. * - * @param colKey The key of the column to perform the check for. + * @param colKey The key of the column to perform the check for. */ isGroupHeader(colKey: string): boolean; /** * Checks whether column fixing is allowed for the specified columns. It should not be allowed if there is only one visible column in the unfixed area. * - * @param columns Array of columns and/or column identifiers - could be column indexes, column keys, column object or mixed. + * @param columns Array of columns and/or column identifiers - could be column indexes, column keys, column object or mixed. */ checkFixingAllowed(columns: any[]): boolean; /** * Checks whether unfixing is allowed for the specified columns. It should not be allowed if there is only one visible column in the fixed area. * - * @param columns Array of columns and/or column identifiers - could be column indexes, column keys, column object or mixed. + * @param columns Array of columns and/or column identifiers - could be column indexes, column keys, column object or mixed. */ checkUnfixingAllowed(columns: any[]): boolean; /** * Fixes a column by specified column identifier - column index or column key. * - * @param colIdentifier An identifier of the column to be fixed - column index or column key. - * @param target Key of the column where the fixed column should move to. - * @param after Specifies where the fixed column should be moved after or before the target column. This parameter is disregarded if there is no target column specified. + * @param colIdentifier An identifier of the column to be fixed - column index or column key. + * @param target Key of the column where the fixed column should move to. + * @param after Specifies where the fixed column should be moved after or before the target column. This parameter is disregarded if there is no target column specified. */ fixColumn(colIdentifier: Object, target?: string, after?: boolean): Object; @@ -39548,17 +39604,17 @@ interface IgGridColumnFixingMethods { /** * Syncs rows heights between two collections of rows. * - * @param $trs An array of rows of the first(fixed/unfixed) container. - * @param $anotherRows An array of rows of the second(fixed/unfixed) container. + * @param $trs An array of rows of the first(fixed/unfixed) container. + * @param $anotherRows An array of rows of the second(fixed/unfixed) container. */ syncRowsHeights($trs: any[], $anotherRows: any[]): void; /** * Calculates widths of the fixed columns. * - * @param fCols Array of grid columns. If not set then the total width of the fixed columns are returned. - * @param excludeNonDataColumns If set to true do not calculate the width of non-data fixed columns (like the row selector row numbering column). - * @param includeHidden If set to true calculates width of the hidden fixed columns (their initial width before hiding). + * @param fCols Array of grid columns. If not set then the total width of the fixed columns are returned. + * @param excludeNonDataColumns If set to true do not calculate the width of non-data fixed columns (like the row selector row numbering column). + * @param includeHidden If set to true calculates width of the hidden fixed columns (their initial width before hiding). */ getWidthOfFixedColumns(fCols?: any[], excludeNonDataColumns?: boolean, includeHidden?: boolean): number; @@ -39662,6 +39718,7 @@ interface JQuery { * Configures which side the fixed columns of the grid will be rendered on. Check [this topic](http://www.igniteui.com/help/iggrid-columnfixing-configuring#direction) out of more information. * */ + igGridColumnFixing(optionLiteral: 'option', optionName: "fixingDirection"): string; /** @@ -39670,6 +39727,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridColumnFixing(optionLiteral: 'option', optionName: "fixingDirection", optionValue: string): void; /** @@ -39718,6 +39776,7 @@ interface JQuery { * Minimal visible area in pixels for the unfixed columns. If the end user tries to fix a column(or columns), which causes the width of the fixed columns to grow such that the width of visible area of unfixed columns is less than this option then fixing will be canceled. Check [this topic](http://www.igniteui.com/help/iggrid-columnfixing-configuring#non-fixable-min-width) out for more information. * */ + igGridColumnFixing(optionLiteral: 'option', optionName: "minimalVisibleAreaWidth"): string|number; /** @@ -39726,6 +39785,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridColumnFixing(optionLiteral: 'option', optionName: "minimalVisibleAreaWidth", optionValue: string|number): void; /** @@ -39861,6 +39921,30 @@ interface ColumnDragStartEvent { } interface ColumnDragStartEventUIParam { + /** + * Gets the column key of the column being dragged. + */ + columnKey?: string; + + /** + * Gets the column index of the column being dragged. + */ + columnIndex?: number; + + /** + * Gets a reference to the widget. + */ + owner?: string; + + /** + * Gets a reference to the orginal th being dragged. + */ + header?: string; + + /** + * Gets a reference to cloned DOM element that's actually being dragged. + */ + helper?: string; } interface ColumnDragEndEvent { @@ -39868,6 +39952,30 @@ interface ColumnDragEndEvent { } interface ColumnDragEndEventUIParam { + /** + * Gets the column key of the column that was being dragged. + */ + columnKey?: string; + + /** + * Gets the column index of the column that was being dragged. + */ + columnIndex?: number; + + /** + * Gets a reference to the widget. + */ + owner?: string; + + /** + * Gets a reference to the orginal th that was being dragged. + */ + header?: string; + + /** + * Gets a reference to cloned DOM element that was actually being dragged. + */ + helper?: string; } interface ColumnDragCanceledEvent { @@ -39875,6 +39983,30 @@ interface ColumnDragCanceledEvent { } interface ColumnDragCanceledEventUIParam { + /** + * Gets the column key of the column that was being dragged. + */ + columnKey?: string; + + /** + * Gets the column index of the column that was being dragged. + */ + columnIndex?: number; + + /** + * Gets a reference to the widget. + */ + owner?: string; + + /** + * Gets a reference to the orginal th being dragged. + */ + header?: string; + + /** + * Gets a reference to cloned DOM element that was actually being dragged. + */ + helper?: string; } interface ColumnMovingEvent { @@ -39882,6 +40014,25 @@ interface ColumnMovingEvent { } interface ColumnMovingEventUIParam { + /** + * Gets the column key of the column that was being moved. + */ + columnKey?: string; + + /** + * Gets the column index of the column that was being moved. + */ + columnIndex?: number; + + /** + * Gets the new column index of the column that was being moved. + */ + targetIndex?: number; + + /** + * Gets a reference to the widget. + */ + owner?: string; } interface ColumnMovedEvent { @@ -39889,6 +40040,25 @@ interface ColumnMovedEvent { } interface ColumnMovedEventUIParam { + /** + * Gets the column key of the column that was moved. + */ + columnKey?: string; + + /** + * Gets the previous column index of the column that was moved. + */ + oldIndex?: number; + + /** + * Gets the new column index of the column that was being moved. + */ + newIndex?: number; + + /** + * Gets a reference to the widget. + */ + owner?: any; } interface MovingDialogOpeningEvent { @@ -39897,9 +40067,9 @@ interface MovingDialogOpeningEvent { interface MovingDialogOpeningEventUIParam { /** - * Gets a reference to the moving dialog element. This is a jQuery object. + * Gets a reference to the widget. */ - movingDialogElement?: string; + owner?: any; } interface MovingDialogOpenedEvent { @@ -39908,9 +40078,9 @@ interface MovingDialogOpenedEvent { interface MovingDialogOpenedEventUIParam { /** - * Gets a reference to the moving dialog element. This is a jQuery object. + * Gets a reference to the ColumnMoving widget. */ - movingDialogElement?: string; + owner?: any; } interface MovingDialogDraggedEvent { @@ -39919,19 +40089,9 @@ interface MovingDialogDraggedEvent { interface MovingDialogDraggedEventUIParam { /** - * Gets a reference to the moving dialog element. This is a jQuery object. + * Gets a reference to the ColumnMoving widget. */ - movingDialogElement?: string; - - /** - * Gets the original position of the moving dialog div as { top, left } object, relative to the page. - */ - originalPosition?: any; - - /** - * Gets the current position of the moving dialog div as { top, left } object, relative to the page. - */ - position?: any; + owner?: any; } interface MovingDialogClosingEvent { @@ -39940,9 +40100,9 @@ interface MovingDialogClosingEvent { interface MovingDialogClosingEventUIParam { /** - * Gets a reference to the moving dialog element. This is a jQuery object. + * Gets a reference to the ColumnMoving widget. */ - movingDialogElement?: string; + owner?: any; } interface MovingDialogClosedEvent { @@ -39951,9 +40111,9 @@ interface MovingDialogClosedEvent { interface MovingDialogClosedEventUIParam { /** - * Gets a reference to the moving dialog element. This is a jQuery object. + * Gets a reference to the ColumnMoving widget. */ - movingDialogElement?: string; + owner?: any; } interface MovingDialogContentsRenderingEvent { @@ -39962,9 +40122,9 @@ interface MovingDialogContentsRenderingEvent { interface MovingDialogContentsRenderingEventUIParam { /** - * Gets a reference to the Moving Dialog element. This is a jQuery object. + * Gets a reference to the ColumnMoving widget. */ - movingDialog?: string; + owner?: any; } interface MovingDialogContentsRenderedEvent { @@ -39973,9 +40133,9 @@ interface MovingDialogContentsRenderedEvent { interface MovingDialogContentsRenderedEventUIParam { /** - * Gets a reference to the Moving Dialog element. This is a jQuery object. + * Gets a reference to the ColumnMoving widget. */ - movingDialog?: string; + owner?: any; } interface MovingDialogMoveUpButtonPressedEvent { @@ -39984,24 +40144,9 @@ interface MovingDialogMoveUpButtonPressedEvent { interface MovingDialogMoveUpButtonPressedEventUIParam { /** - * Gets a reference to the Moving Dialog element. This is a jQuery object. + * Gets a reference to the ColumnMoving widget. */ - movingDialog?: string; - - /** - * Gets the column key of the column that was being moved. - */ - columnKey?: string; - - /** - * Gets the column index of the column that was being moved. - */ - columnIndex?: number; - - /** - * Gets the new column index of the column that was being moved. - */ - targetIndex?: number; + owner?: any; } interface MovingDialogMoveDownButtonPressedEvent { @@ -40010,24 +40155,9 @@ interface MovingDialogMoveDownButtonPressedEvent { interface MovingDialogMoveDownButtonPressedEventUIParam { /** - * Gets a reference to the Moving Dialog element. This is a jQuery object. + * Gets a reference to the ColumnMoving widget. */ - movingDialog?: string; - - /** - * Gets the column key of the column that was being moved. - */ - columnKey?: string; - - /** - * Gets the column index of the column that was being moved. - */ - columnIndex?: number; - - /** - * Gets the new column index of the column that was being moved. - */ - targetIndex?: number; + owner?: any; } interface MovingDialogDragColumnMovingEvent { @@ -40036,24 +40166,9 @@ interface MovingDialogDragColumnMovingEvent { interface MovingDialogDragColumnMovingEventUIParam { /** - * Gets a reference to the Moving Dialog element. This is a jQuery object. + * Gets a reference to the ColumnMoving widget. */ - movingDialog?: string; - - /** - * Gets the column key of the column that was being moved. - */ - columnKey?: string; - - /** - * Gets the column index of the column that was being moved. - */ - columnIndex?: number; - - /** - * Gets the new column index of the column that was being moved. - */ - targetIndex?: number; + owner?: any; } interface MovingDialogDragColumnMovedEvent { @@ -40062,24 +40177,9 @@ interface MovingDialogDragColumnMovedEvent { interface MovingDialogDragColumnMovedEventUIParam { /** - * Gets a reference to the Moving Dialog element. This is a jQuery object. + * Gets a reference to the ColumnMoving widget. */ - movingDialog?: string; - - /** - * Gets the column key of the column that was being moved. - */ - columnKey?: string; - - /** - * Gets the column index of the column that was being moved. - */ - columnIndex?: number; - - /** - * Gets the new column index of the column that was being moved. - */ - targetIndex?: number; + owner?: any; } interface IgGridColumnMoving { @@ -40358,11 +40458,11 @@ interface IgGridColumnMovingMethods { * Moves a visible column at a specified place, in front or behind a target column or at a target index * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * - * @param column An identifier of the column to be moved. It can be a key, a Multi-Column Header identificator, or an index in a number format. The latter is not supported when the grid contains multi-column headers. - * @param target An identifier of a column where the moved column should move to or an index at which the moved column should be moved to. In the case of a column identifier the column will be moved after it by default. - * @param after Specifies whether the column moved should be moved after or before the target column. - * @param inDom Specifies whether the column moving will be enacted through DOM manipulation or through rerendering of the grid. - * @param callback Specifies a custom function to be called when the column is moved. + * @param column An identifier of the column to be moved. It can be a key, a Multi-Column Header identificator, or an index in a number format. The latter is not supported when the grid contains multi-column headers. + * @param target An identifier of a column where the moved column should move to or an index at which the moved column should be moved to. In the case of a column identifier the column will be moved after it by default. + * @param after Specifies whether the column moved should be moved after or before the target column. + * @param inDom Specifies whether the column moving will be enacted through DOM manipulation or through rerendering of the grid. + * @param callback Specifies a custom function to be called when the column is moved. */ moveColumn(column: Object, target: Object, after?: boolean, inDom?: boolean, callback?: Function): void; } @@ -40392,6 +40492,7 @@ interface JQuery { * Specify the drag-and-drop mode for the feature * */ + igGridColumnMoving(optionLiteral: 'option', optionName: "mode"): string; /** @@ -40400,12 +40501,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridColumnMoving(optionLiteral: 'option', optionName: "mode", optionValue: string): void; /** * Specify the way columns will be rearranged * */ + igGridColumnMoving(optionLiteral: 'option', optionName: "moveType"): string; /** @@ -40414,6 +40517,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridColumnMoving(optionLiteral: 'option', optionName: "moveType", optionValue: string): void; /** @@ -41252,8 +41356,8 @@ interface IgGridFeatureChooserPopoverMethods { /** * Shows the popover for the specified target * - * @param trg The element to show popover for. - * @param content The string to set for the popover to show. + * @param trg The element to show popover for. + * @param content The string to set for the popover to show. */ show(trg?: Element, content?: string): void; @@ -41270,7 +41374,7 @@ interface IgGridFeatureChooserPopoverMethods { /** * Sets the content for the popover container * - * @param newCnt The popover content to set. + * @param newCnt The popover content to set. */ setContent(newCnt: string): void; @@ -41287,7 +41391,7 @@ interface IgGridFeatureChooserPopoverMethods { /** * Sets the popover to specific coordinates. * - * @param pos The popover coordinates in pixels. + * @param pos The popover coordinates in pixels. */ setCoordinates(pos: Object): void; } @@ -41299,50 +41403,43 @@ interface FeatureChooserRenderingEvent { (event: Event, ui: FeatureChooserRenderingEventUIParam): void; } -interface FeatureChooserRenderingEventUIParam { -} +interface FeatureChooserRenderingEventUIParam {} interface FeatureChooserRenderedEvent { (event: Event, ui: FeatureChooserRenderedEventUIParam): void; } -interface FeatureChooserRenderedEventUIParam { -} +interface FeatureChooserRenderedEventUIParam {} interface FeatureChooserDropDownOpeningEvent { (event: Event, ui: FeatureChooserDropDownOpeningEventUIParam): void; } -interface FeatureChooserDropDownOpeningEventUIParam { -} +interface FeatureChooserDropDownOpeningEventUIParam {} interface FeatureChooserDropDownOpenedEvent { (event: Event, ui: FeatureChooserDropDownOpenedEventUIParam): void; } -interface FeatureChooserDropDownOpenedEventUIParam { -} +interface FeatureChooserDropDownOpenedEventUIParam {} interface MenuTogglingEvent { (event: Event, ui: MenuTogglingEventUIParam): void; } -interface MenuTogglingEventUIParam { -} +interface MenuTogglingEventUIParam {} interface FeatureTogglingEvent { (event: Event, ui: FeatureTogglingEventUIParam): void; } -interface FeatureTogglingEventUIParam { -} +interface FeatureTogglingEventUIParam {} interface FeatureToggledEvent { (event: Event, ui: FeatureToggledEventUIParam): void; } -interface FeatureToggledEventUIParam { -} +interface FeatureToggledEventUIParam {} interface IgGridFeatureChooser { dropDownWidth?: any; @@ -41366,28 +41463,28 @@ interface IgGridFeatureChooserMethods { /** * Show feature chooser dialog by the specified column key * - * @param columnKey Key of the column that should be shown. + * @param columnKey Key of the column that should be shown. */ showDropDown(columnKey: string): void; /** * Hide feature chooser dialog by column key * - * @param columnKey Key of the column that should be hidden. + * @param columnKey Key of the column that should be hidden. */ hideDropDown(columnKey: string): void; /** * Get jQuery representation of the div holding dropdown for the specified columnKey * - * @param columnKey Key of the column + * @param columnKey Key of the column */ getDropDownByColumnKey(columnKey: string): void; /** * Show/hide feature chooser dialog by column key * - * @param columnKey Key of the column that should be shown/hidden. + * @param columnKey Key of the column that should be shown/hidden. */ toggleDropDown(columnKey: string): void; destroy(e: Object, args: Object): void; @@ -41409,43 +41506,20 @@ interface JQuery { igGridFeatureChooserPopover(methodName: "target"): Object; igGridFeatureChooserPopover(methodName: "getCoordinates"): Object; igGridFeatureChooserPopover(methodName: "setCoordinates", pos: Object): void; - - /** - */ igGridFeatureChooserPopover(optionLiteral: 'option', optionName: "gridId"): string; - - /** - */ igGridFeatureChooserPopover(optionLiteral: 'option', optionName: "gridId", optionValue: string): void; - - /** - */ igGridFeatureChooserPopover(optionLiteral: 'option', optionName: "targetButton"): any; - - /** - */ igGridFeatureChooserPopover(optionLiteral: 'option', optionName: "targetButton", optionValue: any): void; - - /** - */ igGridFeatureChooserPopover(optionLiteral: 'option', optionName: "closeOnBlur"): boolean; - - /** - */ igGridFeatureChooserPopover(optionLiteral: 'option', optionName: "closeOnBlur", optionValue: boolean): void; - - /** - */ igGridFeatureChooserPopover(optionLiteral: 'option', optionName: "containment"): any; - - /** - */ igGridFeatureChooserPopover(optionLiteral: 'option', optionName: "containment", optionValue: any): void; /** * Controls the direction in which the control shows relative to the target element * */ + igGridFeatureChooserPopover(optionLiteral: 'option', optionName: "direction"): string; /** @@ -41454,6 +41528,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridFeatureChooserPopover(optionLiteral: 'option', optionName: "direction", optionValue: string): void; /** @@ -41476,6 +41551,7 @@ interface JQuery { * Controls the position of the popover according to the target element in case the popover is larger than the target on the side we want to position, if the popover is smaller it should always be in the middle of the visible area * */ + igGridFeatureChooserPopover(optionLiteral: 'option', optionName: "position"): string; /** @@ -41484,12 +41560,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridFeatureChooserPopover(optionLiteral: 'option', optionName: "position", optionValue: string): void; /** * Defines width for the popover. leave null for auto. * */ + igGridFeatureChooserPopover(optionLiteral: 'option', optionName: "width"): number|string; /** @@ -41498,12 +41576,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridFeatureChooserPopover(optionLiteral: 'option', optionName: "width", optionValue: number|string): void; /** * Defines height for the popover. leave null for auto * */ + igGridFeatureChooserPopover(optionLiteral: 'option', optionName: "height"): number|string; /** @@ -41512,12 +41592,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridFeatureChooserPopover(optionLiteral: 'option', optionName: "height", optionValue: number|string): void; /** * Defines width the popover won't go under the value even if no specific one is set. * */ + igGridFeatureChooserPopover(optionLiteral: 'option', optionName: "minWidth"): number|string; /** @@ -41526,12 +41608,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridFeatureChooserPopover(optionLiteral: 'option', optionName: "minWidth", optionValue: number|string): void; /** * Defines width the popover won't exceed even if no specific one is set. * */ + igGridFeatureChooserPopover(optionLiteral: 'option', optionName: "maxWidth"): number|string; /** @@ -41540,12 +41624,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridFeatureChooserPopover(optionLiteral: 'option', optionName: "maxWidth", optionValue: number|string): void; /** * Defines height the popover won't exceed even if no specific one is set. * */ + igGridFeatureChooserPopover(optionLiteral: 'option', optionName: "maxHeight"): number|string; /** @@ -41554,6 +41640,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridFeatureChooserPopover(optionLiteral: 'option', optionName: "maxHeight", optionValue: number|string): void; /** @@ -41574,6 +41661,7 @@ interface JQuery { * The content for the popover container. If left null the content will be get from the target. * */ + igGridFeatureChooserPopover(optionLiteral: 'option', optionName: "contentTemplate"): string|Function; /** @@ -41582,6 +41670,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridFeatureChooserPopover(optionLiteral: 'option', optionName: "contentTemplate", optionValue: string|Function): void; /** @@ -41616,6 +41705,7 @@ interface JQuery { * The event on which the popover will be shown. Predefined values are "mouseenter", "click" and "focus" * */ + igGridFeatureChooserPopover(optionLiteral: 'option', optionName: "showOn"): string; /** @@ -41624,12 +41714,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridFeatureChooserPopover(optionLiteral: 'option', optionName: "showOn", optionValue: string): void; /** * Controls where the popover DOM should be attached to. * */ + igGridFeatureChooserPopover(optionLiteral: 'option', optionName: "appendTo"): string|Object; /** @@ -41638,6 +41730,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridFeatureChooserPopover(optionLiteral: 'option', optionName: "appendTo", optionValue: string|Object): void; /** @@ -41700,77 +41793,23 @@ interface JQuery { igGridFeatureChooser(methodName: "getDropDownByColumnKey", columnKey: string): void; igGridFeatureChooser(methodName: "toggleDropDown", columnKey: string): void; igGridFeatureChooser(methodName: "destroy", e: Object, args: Object): void; - - /** - */ igGridFeatureChooser(optionLiteral: 'option', optionName: "dropDownWidth"): any; - - /** - */ igGridFeatureChooser(optionLiteral: 'option', optionName: "dropDownWidth", optionValue: any): void; - - /** - */ igGridFeatureChooser(optionLiteral: 'option', optionName: "animationDuration"): number; - - /** - */ igGridFeatureChooser(optionLiteral: 'option', optionName: "animationDuration", optionValue: number): void; - - /** - */ igGridFeatureChooser(optionLiteral: 'option', optionName: "featureChooserRendering"): FeatureChooserRenderingEvent; - - /** - */ igGridFeatureChooser(optionLiteral: 'option', optionName: "featureChooserRendering", optionValue: FeatureChooserRenderingEvent): void; - - /** - */ igGridFeatureChooser(optionLiteral: 'option', optionName: "featureChooserRendered"): FeatureChooserRenderedEvent; - - /** - */ igGridFeatureChooser(optionLiteral: 'option', optionName: "featureChooserRendered", optionValue: FeatureChooserRenderedEvent): void; - - /** - */ igGridFeatureChooser(optionLiteral: 'option', optionName: "featureChooserDropDownOpening"): FeatureChooserDropDownOpeningEvent; - - /** - */ igGridFeatureChooser(optionLiteral: 'option', optionName: "featureChooserDropDownOpening", optionValue: FeatureChooserDropDownOpeningEvent): void; - - /** - */ igGridFeatureChooser(optionLiteral: 'option', optionName: "featureChooserDropDownOpened"): FeatureChooserDropDownOpenedEvent; - - /** - */ igGridFeatureChooser(optionLiteral: 'option', optionName: "featureChooserDropDownOpened", optionValue: FeatureChooserDropDownOpenedEvent): void; - - /** - */ igGridFeatureChooser(optionLiteral: 'option', optionName: "menuToggling"): MenuTogglingEvent; - - /** - */ igGridFeatureChooser(optionLiteral: 'option', optionName: "menuToggling", optionValue: MenuTogglingEvent): void; - - /** - */ igGridFeatureChooser(optionLiteral: 'option', optionName: "featureToggling"): FeatureTogglingEvent; - - /** - */ igGridFeatureChooser(optionLiteral: 'option', optionName: "featureToggling", optionValue: FeatureTogglingEvent): void; - - /** - */ igGridFeatureChooser(optionLiteral: 'option', optionName: "featureToggled"): FeatureToggledEvent; - - /** - */ igGridFeatureChooser(optionLiteral: 'option', optionName: "featureToggled", optionValue: FeatureToggledEvent): void; igGridFeatureChooser(options: IgGridFeatureChooser): JQuery; igGridFeatureChooser(optionLiteral: 'option', optionName: string): any; @@ -42590,15 +42629,15 @@ interface IgGridFilteringMethods { /** * Toggle filter row when mode is simple or [advancedModeEditorsVisible](ui.iggridfiltering#options:advancedModeEditorsVisible) is true. Otherwise show/hide advanced dialog. * - * @param event Column key + * @param event Column key */ toggleFilterRowByFeatureChooser(event: string): void; /** * Applies filtering programmatically and updates the UI by default. * - * @param expressions An array of filtering expressions, each one having the format {fieldName: , expr: , cond: , logic: } where fieldName is the key of the column, expr is the actual expression string with which we would like to filter, logic is 'AND' or 'OR', and cond is one of the following strings: "equals", "doesNotEqual", "contains", "doesNotContain", "greaterThan", "lessThan", "greaterThanOrEqualTo", "lessThanOrEqualTo", "true", "false", "null", "notNull", "empty", "notEmpty", "startsWith", "endsWith", "today", "yesterday", "on", "notOn", "thisMonth", "lastMonth", "nextMonth", "before", "after", "thisYear", "lastYear", "nextYear". The difference between the empty and null filtering conditions is that empty includes null, NaN, and undefined, as well as the empty string. - * @param updateUI specifies whether the filter row should be also updated once the grid is filtered + * @param expressions An array of filtering expressions, each one having the format {fieldName: , expr: , cond: , logic: } where fieldName is the key of the column, expr is the actual expression string with which we would like to filter, logic is 'AND' or 'OR', and cond is one of the following strings: "equals", "doesNotEqual", "contains", "doesNotContain", "greaterThan", "lessThan", "greaterThanOrEqualTo", "lessThanOrEqualTo", "true", "false", "null", "notNull", "empty", "notEmpty", "startsWith", "endsWith", "today", "yesterday", "on", "notOn", "thisMonth", "lastMonth", "nextMonth", "before", "after", "thisYear", "lastYear", "nextYear". The difference between the empty and null filtering conditions is that empty includes null, NaN, and undefined, as well as the empty string. + * @param updateUI specifies whether the filter row should be also updated once the grid is filtered * @param addedFromAdvanced */ filter(expressions: any[], updateUI?: boolean, addedFromAdvanced?: boolean): void; @@ -42606,7 +42645,7 @@ interface IgGridFilteringMethods { /** * Check whether filterCondition requires or not filtering expression - e.g. if filterCondition is "lastMonth", "thisMonth", "null", "notNull", "true", "false", etc. then filtering expression is NOT required * - * @param filterCondition filtering condition - e.g. "true", "false", "yesterday", "empty", "null", etc. + * @param filterCondition filtering condition - e.g. "true", "false", "yesterday", "empty", "null", etc. */ requiresFilteringExpression(filterCondition: string): boolean; } @@ -42685,6 +42724,7 @@ interface JQuery { * Type of animations for the column filter dropdowns. * */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDropDownAnimations"): string; /** @@ -42693,6 +42733,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDropDownAnimations", optionValue: string): void; /** @@ -42713,6 +42754,7 @@ interface JQuery { * Width of the column filter dropdowns. * */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDropDownWidth"): string|number; /** @@ -42721,6 +42763,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDropDownWidth", optionValue: string|number): void; /** @@ -42759,6 +42802,7 @@ interface JQuery { * Enable/disable filter icons visibility. * */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDropDownItemIcons"): boolean; /** @@ -42767,6 +42811,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDropDownItemIcons", optionValue: boolean): void; /** @@ -42787,6 +42832,7 @@ interface JQuery { * Type of filtering. Delegates all filtering functionality to the [$.ig.DataSource](ig.datasource). * */ + igGridFiltering(optionLiteral: 'option', optionName: "type"): string; /** @@ -42795,6 +42841,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridFiltering(optionLiteral: 'option', optionName: "type", optionValue: string): void; /** @@ -42815,6 +42862,7 @@ interface JQuery { * Default is 'simple' for non-virtualized grids, and 'advanced' when [virtualization](ui.iggrid#options:virtualization) is enabled. * */ + igGridFiltering(optionLiteral: 'option', optionName: "mode"): string; /** @@ -42823,6 +42871,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridFiltering(optionLiteral: 'option', optionName: "mode", optionValue: string): void; /** @@ -42843,6 +42892,7 @@ interface JQuery { * Location of the advanced filtering button when [advancedModeEditorsVisible](ui.iggridfiltering#options:advancedModeEditorsVisible) is false (i.e. when the button is rendered in the header). * */ + igGridFiltering(optionLiteral: 'option', optionName: "advancedModeHeaderButtonLocation"): string; /** @@ -42851,12 +42901,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridFiltering(optionLiteral: 'option', optionName: "advancedModeHeaderButtonLocation", optionValue: string): void; /** * Default filter dialog width (used for Advanced filtering [mode](ui.iggridfiltering#options:mode)). * */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogWidth"): string|number; /** @@ -42865,12 +42917,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogWidth", optionValue: string|number): void; /** * Default filter dialog height (used for Advanced filtering [mode](ui.iggridfiltering#options:mode)). * */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogHeight"): string|number; /** @@ -42879,12 +42933,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogHeight", optionValue: string|number): void; /** * Width of the filtering condition dropdowns in the advanced filter dialog. * */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogFilterDropDownDefaultWidth"): string|number; /** @@ -42893,12 +42949,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogFilterDropDownDefaultWidth", optionValue: string|number): void; /** * Width of the filtering expression input boxes in the advanced filter dialog. * */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogExprInputDefaultWidth"): string|number; /** @@ -42907,12 +42965,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogExprInputDefaultWidth", optionValue: string|number): void; /** * Width of the column chooser dropdowns in the advanced filter dialog. * */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogColumnDropDownDefaultWidth"): string|number; /** @@ -42921,6 +42981,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogColumnDropDownDefaultWidth", optionValue: string|number): void; /** @@ -42941,6 +43002,7 @@ interface JQuery { * The filtering button for filter dropdowns can be rendered either on the left of the filter editor, or on the right. * */ + igGridFiltering(optionLiteral: 'option', optionName: "filterButtonLocation"): string; /** @@ -42949,6 +43011,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridFiltering(optionLiteral: 'option', optionName: "filterButtonLocation", optionValue: string): void; /** @@ -43061,6 +43124,7 @@ interface JQuery { * Add button width - in the advanced filter dialog. * */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogAddButtonWidth"): string|number; /** @@ -43069,12 +43133,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogAddButtonWidth", optionValue: string|number): void; /** * Width of the Ok and Cancel buttons in the advanced filtering dialogs. * */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogOkCancelButtonWidth"): string|number; /** @@ -43083,6 +43149,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogOkCancelButtonWidth", optionValue: string|number): void; /** @@ -43516,7 +43583,6 @@ interface IgGridColumn { * Width of the column in pixels or percentage. Can also be set as '*', in which case the width auto-size based on the content of the column cells (including the header text).If width is not defined and [defaultColumnWidth](ui.iggrid#options:defaultColumnWidth) is set, it is assumed for all columns. * * - * * Valid values: * "string" The column width can be set in pixels (px), percentage (%) or as '*' in order to auto-size based on the cells and header content. * "number" The column width can be set as a number @@ -44622,7 +44688,7 @@ interface IgGridMethods { /** * Returns whether the column with identifier colKey is fixed * - * @param colKey An identifier of the column which should be checked. It can be a key or visible index. + * @param colKey An identifier of the column which should be checked. It can be a key or visible index. */ isFixedColumn(colKey: Object): boolean; @@ -44634,7 +44700,7 @@ interface IgGridMethods { /** * Returns whether the header identified by colKey is multicolumn header(has children) * - * @param colKey value of the column key + * @param colKey value of the column key */ isGroupHeader(colKey: string): Object; @@ -44646,7 +44712,7 @@ interface IgGridMethods { * recordIndex - index of the data record associated with this element in the current dataView. * columnObject - the column object associated with this element ( if the element is tr this will be null) * - * @param elem The Dom element or jQuery object which can be a TD or TR element from the grid. + * @param elem The Dom element or jQuery object which can be a TD or TR element from the grid. */ getElementInfo(elem: Element): Object; @@ -44708,17 +44774,17 @@ interface IgGridMethods { /** * Returns the cell TD element at the specified location * - * @param x The column index. - * @param y The row index. - * @param isFixed Optional parameter - if true get cell TD at the specified location from the fixed table + * @param x The column index. + * @param y The row index. + * @param isFixed Optional parameter - if true get cell TD at the specified location from the fixed table */ cellAt(x: number, y: number, isFixed: boolean): Element; /** * Returns the cell TD element by row id and column key * - * @param rowId The id of the row. - * @param columnKey The column key. + * @param rowId The id of the row. + * @param columnKey The column key. */ cellById(rowId: Object, columnKey: string): Element; @@ -44750,22 +44816,22 @@ interface IgGridMethods { /** * Returns the row (TR element) at the specified index. jQuery selectors aren't used for performance reasons * - * @param i The row index. + * @param i The row index. */ rowAt(i: number): Element; /** * Returns the row TR element by row id * - * @param rowId The id of the row. - * @param isFixed Specify search in the fixed container. + * @param rowId The id of the row. + * @param isFixed Specify search in the fixed container. */ rowById(rowId: Object, isFixed?: boolean): Element; /** * Returns the fixed row (TR element) at the specified index. jQuery selectors aren't used for performance reasons(in ColumnFixing scenario - only when there is at least one fixed column) * - * @param i The row index. + * @param i The row index. */ fixedRowAt(i: number): Element; @@ -44792,14 +44858,14 @@ interface IgGridMethods { /** * Returns a column object by the specified column key * - * @param key The column key. + * @param key The column key. */ columnByKey(key: string): Object; /** * Returns a column object by the specified header text. If there are multiple matches, returns the first one. * - * @param text The column header text. + * @param text The column header text. */ columnByText(text: string): Object; @@ -44841,8 +44907,8 @@ interface IgGridMethods { * Retrieves a cell value using the row index and the column key. If a primaryKey is defined, rowId is assumed to be the row Key (not index). * If primary key is not defined, then rowId is converted to a number and is used as a row index. * - * @param rowId Row index or row key (primary key). - * @param colKey The column key. + * @param rowId Row index or row key (primary key). + * @param colKey The column key. */ getCellValue(rowId: Object, colKey: string): Object; @@ -44850,32 +44916,32 @@ interface IgGridMethods { * Returns the cell text. If colKey is a number, the index of the column is used (instead of a column name)- does not apply when using a Multi-Row Layout grid. * This is the actual text (or HTML string) for the contents of the cell. * - * @param rowId Row index or row data key (primary key) - * @param colKey Column key. + * @param rowId Row index or row data key (primary key) + * @param colKey Column key. */ getCellText(rowId: Object, colKey: string): string; /** * Sets a new template for a column after initialization and renders the grid if not explicitly disabled. This method will replace any existing explicitly set row template and will build one anew from the column ones. * - * @param col An identifier of the column to set template for (index or key) - * @param tmpl The column template to set - * @param render Should the grid rerender after template is set + * @param col An identifier of the column to set template for (index or key) + * @param tmpl The column template to set + * @param render Should the grid rerender after template is set */ setColumnTemplate(col: Object, tmpl: string, render?: boolean): void; /** * Commits all pending transactions to the client data source. Note that there won't be anything to commit on the UI, since it is updated instantly. In order to rollback the actual UI, a call to dataBind() is required. * - * @param rowId If specified, will commit only that transaction corresponding to the specified record key. + * @param rowId If specified, will commit only that transaction corresponding to the specified record key. */ commit(rowId?: Object): void; /** * Clears the transaction log (delegates to igDataSource). Note that this does not update the UI. In case the UI must be updated, set the second parameter "updateUI" to true, which will trigger a call to dataBind() to re-render the contents. * - * @param rowId If specified, will only rollback the transactions with that row id. - * @param updateUI Whether to update the UI or not. + * @param rowId If specified, will only rollback the transactions with that row id. + * @param updateUI Whether to update the UI or not. */ rollback(rowId?: Object, updateUI?: boolean): any[]; @@ -44883,7 +44949,7 @@ interface IgGridMethods { * Returns a record by a specified key (requires that primaryKey is set in the settings). * That is a wrapper for this.dataSource.findRecordByKey(key). * - * @param key Primary key of the record + * @param key Primary key of the record */ findRecordByKey(key: Object): Object; @@ -44891,7 +44957,7 @@ interface IgGridMethods { * Returns a standalone object (copy) that represents the committed transactions, but detached from the data source. * That is a wrapper for this.dataSource.getDetachedRecord(t). * - * @param t A transaction object. + * @param t A transaction object. */ getDetachedRecord(t: Object): Object; @@ -44916,22 +44982,22 @@ interface IgGridMethods { /** * Invokes an AJAX request to the updateUrl option (if specified) and passes the serialized transaction log (a serialized JSON string) as part of the POST request. * - * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) - * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) + * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) + * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) */ saveChanges(success: Function, error: Function): void; /** * Adds a new row (TR) to the grid, by taking a data row object. Assumes the record will have the primary key. * - * @param rec Identifier/key of row. If missing, then number of rows in grid is used. + * @param rec Identifier/key of row. If missing, then number of rows in grid is used. */ renderNewRow(rec?: string): void; /** * If the data source points to a local JSON array of data, and it is necessary to reset it at runtime, it must be done through this API member instead of the options (options.dataSource) * - * @param dataSource New data source object. + * @param dataSource New data source object. */ dataSourceObject(dataSource: Object): void; @@ -44953,11 +45019,11 @@ interface IgGridMethods { * Moves a visible column at a specified place, in front or behind a target column or at a target index * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * - * @param column An identifier of the column to be moved. It can be a key, a Multi-Column Header identificator, or an index in a number format. The latter is not supported when the grid contains multi-column headers. - * @param target An identifier of a column where the moved column should move to or an index at which the moved column should be moved to. In the case of a column identifier the column will be moved after it by default. - * @param after Specifies whether the column moved should be moved after or before the target column. This parameter is disregarded if there is no target column specified but a target index is used. - * @param inDom Specifies whether the column moving will be enacted through DOM manipulation or through rerendering of the grid. - * @param callback Specifies a custom function to be called when the column is moved. + * @param column An identifier of the column to be moved. It can be a key, a Multi-Column Header identificator, or an index in a number format. The latter is not supported when the grid contains multi-column headers. + * @param target An identifier of a column where the moved column should move to or an index at which the moved column should be moved to. In the case of a column identifier the column will be moved after it by default. + * @param after Specifies whether the column moved should be moved after or before the target column. This parameter is disregarded if there is no target column specified but a target index is used. + * @param inDom Specifies whether the column moving will be enacted through DOM manipulation or through rerendering of the grid. + * @param callback Specifies a custom function to be called when the column is moved. */ moveColumn(column: Object, target: Object, after?: boolean, inDom?: boolean, callback?: Function): void; @@ -44965,8 +45031,8 @@ interface IgGridMethods { * Shows a hidden column. If the column is not hidden the method does nothing. * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * - * @param column An identifier for the column. If a number is provided it will be used as a column index. If a string is provided it will be used as a column key. - * @param callback Specifies a custom function to be called when the column is shown(optional) + * @param column An identifier for the column. If a number is provided it will be used as a column index. If a string is provided it will be used as a column key. + * @param callback Specifies a custom function to be called when the column is shown(optional) */ showColumn(column: Object, callback: Function): void; @@ -44974,41 +45040,41 @@ interface IgGridMethods { * Hides a visible column. If the column is hidden the method does nothing. * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * - * @param column An identifier for the column. If a number is provided it will be used as a column index else if a string is provided it will be used as a column key. - * @param callback Specifies a custom function to be called when the column is hidden(optional) + * @param column An identifier for the column. If a number is provided it will be used as a column index else if a string is provided it will be used as a column key. + * @param callback Specifies a custom function to be called when the column is hidden(optional) */ hideColumn(column: Object, callback: Function): void; /** * Gets unbound values for the specified column key. If key is not specified returns all unboundvalues * - * @param key column key + * @param key column key */ getUnboundValues(key: string): Object; /** * Sets unbound values for the unbound column with the specified key. If removeOldValues is true then values(if any) for the unbound columns are re-set with the new values * - * @param key key of the unbound column - * @param values array of values to be set on unbound values - * @param removeOldValues if true removes current unbound values(if any) for the specified column and apply the new ones specified in parameter values. Otherwise merge current values with the specified in parameter values + * @param key key of the unbound column + * @param values array of values to be set on unbound values + * @param removeOldValues if true removes current unbound values(if any) for the specified column and apply the new ones specified in parameter values. Otherwise merge current values with the specified in parameter values */ setUnboundValues(key: string, values: any[], removeOldValues: Object): void; /** * Sets unbound value for the unbound cell by the specified column key and row primary key. * - * @param col key of the unbound column - * @param rowId primary key value of the row - * @param val value to be set on unbound cell - * @param notToRender if false will re-render the row + * @param col key of the unbound column + * @param rowId primary key value of the row + * @param val value to be set on unbound cell + * @param notToRender if false will re-render the row */ setUnboundValueByPK(col: string, rowId: string, val: Object, notToRender: Object): void; /** * Returns an unbound column with the specified key. If not found returns null * - * @param key a column key + * @param key a column key */ getUnboundColumnByKey(key: string): Object; @@ -45025,7 +45091,7 @@ interface IgGridMethods { /** * Calculates the width of the column so its content to be auto-fitted to the width of the data in it(the content should NOT be shrinked/cutted) * - * @param columnIndex Visible column index + * @param columnIndex Visible column index */ calculateAutoFitColumnWidth(columnIndex: number): number; @@ -45033,8 +45099,8 @@ interface IgGridMethods { * Get visible index by specified column key. If column is not found or is hidden then returns -1. * Note: Method does not count column groups (Multi-Column Headers). * - * @param columnKey columnKey - * @param includeDataSkip Optional parameter - if set to true include non data columns(like expander column, row selectors column, etc.) in calculations + * @param columnKey columnKey + * @param includeDataSkip Optional parameter - if set to true include non data columns(like expander column, row selectors column, etc.) in calculations */ getVisibleIndexByKey(columnKey: string, includeDataSkip: boolean): number; @@ -45048,14 +45114,14 @@ interface IgGridMethods { /** * Scroll to the specified row or specified position(in pixels) * - * @param scrollerPosition An identifier of the vertical scroll position. When it is string then it is interpreted as pixels otherwise it is the row number + * @param scrollerPosition An identifier of the vertical scroll position. When it is string then it is interpreted as pixels otherwise it is the row number */ virtualScrollTo(scrollerPosition: Object): void; /** * Returns column object and visible index for the table cell(TD) which is passed as argument * - * @param $td cell(TD) - either DOM TD element or jQuery object + * @param $td cell(TD) - either DOM TD element or jQuery object */ getColumnByTD($td: Object): Object; @@ -45150,6 +45216,7 @@ interface JQuery { * Defines the grid width in pixels or percents. [Here you can find more info about setting igGrid width](http://www.igniteui.com/help/iggrid-columns-and-layout#width-height). * */ + igGrid(optionLiteral: 'option', optionName: "width"): string|number; /** @@ -45158,12 +45225,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igGrid(optionLiteral: 'option', optionName: "width", optionValue: string|number): void; /** * This is the total height of the grid, including all UI elements - scroll container with data rows, header, footer, filter row - (if any), etc. [Here you can find more info about setting igGrid height](http://www.igniteui.com/help/iggrid-columns-and-layout#width-height). * */ + igGrid(optionLiteral: 'option', optionName: "height"): string|number; /** @@ -45172,6 +45241,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGrid(optionLiteral: 'option', optionName: "height", optionValue: string|number): void; /** @@ -45192,6 +45262,7 @@ interface JQuery { * Used for [row virtualization](ui.iggrid#options:rowVirtualization) in [fixed mode](ui.iggrid#options:virtualizationMode). This is the average value in pixels (default) that will be used to calculate how many rows to render as the end user scrolls. Also all rows' height will be automatically set to this value. * */ + igGrid(optionLiteral: 'option', optionName: "avgRowHeight"): string|number; /** @@ -45200,12 +45271,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igGrid(optionLiteral: 'option', optionName: "avgRowHeight", optionValue: string|number): void; /** * Used for [column virtualization](ui.iggrid#options:columnVirtualization) in [fixed mode](ui.iggrid#options:virtualizationMode). This is the average value in pixels for a column width. * */ + igGrid(optionLiteral: 'option', optionName: "avgColumnWidth"): string|number; /** @@ -45214,12 +45287,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igGrid(optionLiteral: 'option', optionName: "avgColumnWidth", optionValue: string|number): void; /** * Default column width that will be set for all columns, that don't have [column width](ui.iggrid#options:columns.width) defined. * */ + igGrid(optionLiteral: 'option', optionName: "defaultColumnWidth"): string|number; /** @@ -45228,6 +45303,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGrid(optionLiteral: 'option', optionName: "defaultColumnWidth", optionValue: string|number): void; /** @@ -45266,6 +45342,7 @@ interface JQuery { * Determines row virtualization mode. * */ + igGrid(optionLiteral: 'option', optionName: "virtualizationMode"): string; /** @@ -45274,6 +45351,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGrid(optionLiteral: 'option', optionName: "virtualizationMode", optionValue: string): void; /** @@ -45336,6 +45414,7 @@ interface JQuery { * The templating engine that will be used to render the grid [column templates](ui.iggrid#options:columns.template). [Here you can find](http://www.infragistics.com/community/blogs/marina_stoyanova/archive/2014/05/30/using-different-template-engines-with-ignite-ui-controls.aspx) how to use templating engines other than igTemplating and jsRender. * */ + igGrid(optionLiteral: 'option', optionName: "templatingEngine"): string; /** @@ -45344,6 +45423,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGrid(optionLiteral: 'option', optionName: "templatingEngine", optionValue: string): void; /** @@ -45364,6 +45444,7 @@ interface JQuery { * Can be any valid data source accepted by [$.ig.DataSource](ig.datasource), or an instance of an $.ig.DataSource itself * */ + igGrid(optionLiteral: 'option', optionName: "dataSource"): Array|Object|string; /** @@ -45372,6 +45453,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGrid(optionLiteral: 'option', optionName: "dataSource", optionValue: Array|Object|string): void; /** @@ -45638,6 +45720,7 @@ interface JQuery { * Sets gets ability to automatically format text in cells for numeric and date columns. The format patterns and rules for numbers and dates are defined in $.ig.regional.defaults object. [Here column formatting is explained in details](http://www.igniteui.com/help/iggrid-columns-and-layout#column-formatting) * */ + igGrid(optionLiteral: 'option', optionName: "autoFormat"): string|boolean; /** @@ -45646,6 +45729,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGrid(optionLiteral: 'option', optionName: "autoFormat", optionValue: string|boolean): void; /** @@ -45794,6 +45878,7 @@ interface JQuery { * Configures how the feature chooser icon should display on header cells - e.g. to display as gear icon or not. * */ + igGrid(optionLiteral: 'option', optionName: "featureChooserIconDisplay"): string; /** @@ -45802,6 +45887,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGrid(optionLiteral: 'option', optionName: "featureChooserIconDisplay", optionValue: string): void; /** @@ -46201,7 +46287,6 @@ interface IgGridGroupByColumnSettingsSummaries { * allGroupData - array of data records for the group(for the whole data source - not only for the data view) * * - * * Valid values: * "string" the name of the function as a string located in the global window object. * "function" which will be used for calculating the summary value. @@ -46953,7 +47038,6 @@ interface IgGridGroupBy { * Specifies default summaries that will appear when grouping by a column on the bottom of each group as a row.This option has a lower priority than the groupSummaries defined under columnSettings for each column. * All default summaries are defined under $.ig.util.defaultSummaryMethods * - * */ groupSummaries?: any; @@ -47082,17 +47166,17 @@ interface IgGridGroupByMethods { /** * Check whether column with specified key and layout is grouped * - * @param key key of the column - * @param layout layout name + * @param key key of the column + * @param layout layout name */ checkColumnIsGrouped(key: string, layout: string): void; /** * Get grouped data by value for the specific column. NOTE: Before calling this function the data(that is passed as an argument) should be sorted by colKey. * - * @param data data (sorted by colKey) that is used to get the records from. - * @param colKey key of the column for which grouping will be applied. - * @param idval value of the column by which grouping will be applied. + * @param data data (sorted by colKey) that is used to get the records from. + * @param colKey key of the column for which grouping will be applied. + * @param idval value of the column by which grouping will be applied. */ getGroupedData(data: any[], colKey: string, idval?: string): any[]; @@ -47104,31 +47188,31 @@ interface IgGridGroupByMethods { /** * Groups by a column * - * @param key Column Key - group by the column with the specified key - * @param layout layout is an optional parameter. if set it means the grouped column is not in the root level but is a child layout column - * @param sortingDirection if not set it is taken from option defaultSortingDirection + * @param key Column Key - group by the column with the specified key + * @param layout layout is an optional parameter. if set it means the grouped column is not in the root level but is a child layout column + * @param sortingDirection if not set it is taken from option defaultSortingDirection */ groupByColumn(key: string, layout?: string, sortingDirection?: Object): void; /** * Removes the specified column from the group by columns list, executes the group by operation and updates the view. * - * @param key Column Key - ungroup by the column with the specified key - * @param layout Layout is an optional parameter. If set it means the grouped column is not in the root level but is a child layout column. + * @param key Column Key - ungroup by the column with the specified key + * @param layout Layout is an optional parameter. If set it means the grouped column is not in the root level but is a child layout column. */ ungroupByColumn(key: string, layout?: string): void; /** * Expand group row with specified id * - * @param rowId data-id attribute of the group row in the DOM + * @param rowId data-id attribute of the group row in the DOM */ expand(rowId: string): void; /** * Expand group row with specified id * - * @param rowId data-id attribute of the group row in the DOM + * @param rowId data-id attribute of the group row in the DOM */ collapse(rowId: string): void; @@ -47166,6 +47250,7 @@ interface JQuery { * Sets the place in the grid where the GroupBy area will be * */ + igGridGroupBy(optionLiteral: 'option', optionName: "groupByAreaVisibility"): string; /** @@ -47174,6 +47259,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridGroupBy(optionLiteral: 'option', optionName: "groupByAreaVisibility", optionValue: string): void; /** @@ -47194,6 +47280,7 @@ interface JQuery { * Gets when paging is applied and there is at least one grouped column which records should be included in page processing. * */ + igGridGroupBy(optionLiteral: 'option', optionName: "pagingMode"): string; /** @@ -47202,6 +47289,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridGroupBy(optionLiteral: 'option', optionName: "pagingMode", optionValue: string): void; /** @@ -47292,6 +47380,7 @@ interface JQuery { * Default sort order - ascending or descending * */ + igGridGroupBy(optionLiteral: 'option', optionName: "defaultSortingDirection"): string; /** @@ -47300,6 +47389,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridGroupBy(optionLiteral: 'option', optionName: "defaultSortingDirection", optionValue: string): void; /** @@ -47348,6 +47438,7 @@ interface JQuery { * Gets whether the GroupBy operation takes place locally on client-side or remotely on server-side. * */ + igGridGroupBy(optionLiteral: 'option', optionName: "type"): string; /** @@ -47356,6 +47447,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridGroupBy(optionLiteral: 'option', optionName: "type", optionValue: string): void; /** @@ -47670,6 +47762,7 @@ interface JQuery { * Gets width of the GroupBy Dialog * */ + igGridGroupBy(optionLiteral: 'option', optionName: "modalDialogWidth"): string|number; /** @@ -47678,12 +47771,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridGroupBy(optionLiteral: 'option', optionName: "modalDialogWidth", optionValue: string|number): void; /** * Gets height of the GroupBy Dialog * */ + igGridGroupBy(optionLiteral: 'option', optionName: "modalDialogHeight"): string|number; /** @@ -47692,6 +47787,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridGroupBy(optionLiteral: 'option', optionName: "modalDialogHeight", optionValue: string|number): void; /** @@ -47754,6 +47850,7 @@ interface JQuery { * Controls containment behavior for the GroupBy Dialog. * */ + igGridGroupBy(optionLiteral: 'option', optionName: "groupByDialogContainment"): string; /** @@ -47762,6 +47859,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridGroupBy(optionLiteral: 'option', optionName: "groupByDialogContainment", optionValue: string): void; /** @@ -47794,7 +47892,6 @@ interface JQuery { * Gets default summaries that will appear when grouping by a column on the bottom of each group as a row.This option has a lower priority than the groupSummaries defined under columnSettings for each column. * All default summaries are defined under $.ig.util.defaultSummaryMethods * - * */ igGridGroupBy(optionLiteral: 'option', optionName: "groupSummaries"): any; @@ -47803,7 +47900,6 @@ interface JQuery { * All default summaries are defined under $.ig.util.defaultSummaryMethods * * - * * @optionValue New value to be set. */ igGridGroupBy(optionLiteral: 'option', optionName: "groupSummaries", optionValue: any): void; @@ -47812,6 +47908,7 @@ interface JQuery { * Gets the groupSummaries postion inside each group. * */ + igGridGroupBy(optionLiteral: 'option', optionName: "groupSummariesPosition"): string; /** @@ -47820,6 +47917,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridGroupBy(optionLiteral: 'option', optionName: "groupSummariesPosition", optionValue: string): void; /** @@ -48568,9 +48666,9 @@ interface IgGridHidingMethods { * Shows a hidden column. If the column is not hidden the method does nothing. * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * - * @param column An identifier for the column. If a number is provided it will be used as a column index else if a strings is provided it will be used as a column key. - * @param isMultiColumnHeader If it is true then the column is of type multicolumnheader. An identifier for the column should be of type string. - * @param callback Specifies a custom function to be called when the column(s) is shown(optional) + * @param column An identifier for the column. If a number is provided it will be used as a column index else if a strings is provided it will be used as a column key. + * @param isMultiColumnHeader If it is true then the column is of type multicolumnheader. An identifier for the column should be of type string. + * @param callback Specifies a custom function to be called when the column(s) is shown(optional) */ showColumn(column: Object, isMultiColumnHeader?: boolean, callback?: Function): void; @@ -48578,9 +48676,9 @@ interface IgGridHidingMethods { * Hides a visible column. If the column is hidden the method does nothing. * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * - * @param column An identifier for the column. If a number is provided it will be used as a column index else if a strings is provided it will be used as a column key. - * @param isMultiColumnHeader If it is true then the column is of type multicolumnheader. An identifier for the column should be of type string. - * @param callback Specifies a custom function to be called when the column is hidden(optional) + * @param column An identifier for the column. If a number is provided it will be used as a column index else if a strings is provided it will be used as a column key. + * @param isMultiColumnHeader If it is true then the column is of type multicolumnheader. An identifier for the column should be of type string. + * @param callback Specifies a custom function to be called when the column is hidden(optional) */ hideColumn(column: Object, isMultiColumnHeader?: boolean, callback?: Function): void; @@ -48588,8 +48686,8 @@ interface IgGridHidingMethods { * Hides visible columns specified by the array. If the column is hidden the method does nothing. * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * - * @param columns An array of identifiers for the columns. If a number is provided it will be used as a column index else if a strings is provided it will be used as a column key. - * @param callback Specifies a custom function to be called when all columns are hidden(optional) + * @param columns An array of identifiers for the columns. If a number is provided it will be used as a column index else if a strings is provided it will be used as a column key. + * @param callback Specifies a custom function to be called when all columns are hidden(optional) */ hideMultiColumns(columns: any[], callback?: Function): void; @@ -48597,8 +48695,8 @@ interface IgGridHidingMethods { * Show visible columns specified by the array. If the column is shown the method does nothing. * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * - * @param columns An array of identifiers for the columns. If a number is provided it will be used as a column index else if a strings is provided it will be used as a column key. - * @param callback Specifies a custom function to be called when all columns are shown(optional) + * @param columns An array of identifiers for the columns. If a number is provided it will be used as a column index else if a strings is provided it will be used as a column key. + * @param callback Specifies a custom function to be called when all columns are shown(optional) */ showMultiColumns(columns: any[], callback?: Function): void; @@ -49204,7 +49302,6 @@ interface IgHierarchicalGridColumn { * Width of the column in pixels or percentage. Can also be set as '*', in which case the width auto-size based on the content of the column cells (including the header text).If width is not defined and [defaultColumnWidth](ui.ighierarchicalgrid#options:defaultColumnWidth) is set, it is assumed for all columns. * * - * * Valid values: * "string" The column width can be set in pixels (px), percentage (%) or as '*' in order to auto-size based on the cells and header content. * "number" The column width can be set as a number @@ -49512,6 +49609,15 @@ interface RowExpandingEvent { } interface RowExpandingEventUIParam { + /** + * Gets access the hierarchical grid object. + */ + owner?: any; + + /** + * Gets access the row element for the row that's about to be expanded. + */ + parentrow?: string; } interface RowExpandedEvent { @@ -49519,6 +49625,15 @@ interface RowExpandedEvent { } interface RowExpandedEventUIParam { + /** + * Gets access the hierarchical grid object. + */ + owner?: any; + + /** + * Gets access the row element for the row that was expanded. + */ + parentrow?: string; } interface RowCollapsingEvent { @@ -49526,6 +49641,15 @@ interface RowCollapsingEvent { } interface RowCollapsingEventUIParam { + /** + * Gets access the hierarchical grid object. + */ + owner?: any; + + /** + * Gets access the row element for the row that's about to be collapsed. + */ + parentrow?: string; } interface RowCollapsedEvent { @@ -49533,6 +49657,15 @@ interface RowCollapsedEvent { } interface RowCollapsedEventUIParam { + /** + * Gets access the hierarchical grid object. + */ + owner?: any; + + /** + * Gets access the row element for the row that was collapsed. + */ + parentrow?: string; } interface ChildrenPopulatingEvent { @@ -49540,6 +49673,20 @@ interface ChildrenPopulatingEvent { } interface ChildrenPopulatingEventUIParam { + /** + * Gets access the hierarchical grid object. + */ + owner?: any; + + /** + * Gets access the row element for the row that's about to be populated. + */ + parentrow?: string; + + /** + * Gets the data ID of the row. + */ + id?: any; } interface ChildrenPopulatedEvent { @@ -49547,6 +49694,20 @@ interface ChildrenPopulatedEvent { } interface ChildrenPopulatedEventUIParam { + /** + * Gets access the hierarchical grid object. + */ + owner?: any; + + /** + * Gets access the row element for the row that was populated. + */ + parentrow?: string; + + /** + * Gets the data ID of the row. + */ + id?: any; } interface ChildGridRenderedEvent { @@ -49554,21 +49715,33 @@ interface ChildGridRenderedEvent { } interface ChildGridRenderedEventUIParam { + /** + * Gets access the hierarchical grid object. + */ + owner?: any; + + /** + * Gets access the row element for the row that's about to be populated. + */ + parentrow?: string; + + /** + * Gets reference to the child grid. + */ + childgrid?: any; } interface ChildGridCreatingEvent { (event: Event, ui: ChildGridCreatingEventUIParam): void; } -interface ChildGridCreatingEventUIParam { -} +interface ChildGridCreatingEventUIParam {} interface ChildGridCreatedEvent { (event: Event, ui: ChildGridCreatedEventUIParam): void; } -interface ChildGridCreatedEventUIParam { -} +interface ChildGridCreatedEventUIParam {} interface IgHierarchicalGrid { /** @@ -50196,8 +50369,8 @@ interface IgHierarchicalGridMethods { * Expands or collapses (toggles) a parent row * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * - * @param element accepts a dom element, or a jquery wrapped dom element that should be a TR and should specify a parent row - * @param callback Specifies a custom function to be called when parent row is toggled(optional). Takes 2 arguments - first is hierarchical grid object, second is the row element that was toggled + * @param element accepts a dom element, or a jquery wrapped dom element that should be a TR and should specify a parent row + * @param callback Specifies a custom function to be called when parent row is toggled(optional). Takes 2 arguments - first is hierarchical grid object, second is the row element that was toggled */ toggle(element: Element, callback?: Function): void; @@ -50205,15 +50378,15 @@ interface IgHierarchicalGridMethods { * Expands (toggles) a parent row * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * - * @param id accepts a dom element, or a jquery wrapped dom element that should be a TR and should specify a parent row - * @param callback Specifies a custom function to be called when parent row is expanded(optional). Takes 2 arguments first is hierarchical grid object, second is the row element that was expanded + * @param id accepts a dom element, or a jquery wrapped dom element that should be a TR and should specify a parent row + * @param callback Specifies a custom function to be called when parent row is expanded(optional). Takes 2 arguments first is hierarchical grid object, second is the row element that was expanded */ expand(id: Element, callback?: Function): void; /** * Checks if a parent row is expanded or not * - * @param element accepts a dom element, or a jquery wrapped dom element that should be a TR and should specify a parent row + * @param element accepts a dom element, or a jquery wrapped dom element that should be a TR and should specify a parent row */ expanded(element: Element): boolean; @@ -50221,22 +50394,22 @@ interface IgHierarchicalGridMethods { * Collapses a parent row * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * - * @param id accepts a dom element, or a jquery wrapped dom element that should be a TR and should specify a parent row - * @param callback Specifies a custom function to be called when parent row is expanded(optional). Takes 2 arguments - first is hierarchical grid object, second is the row element that was collapsed + * @param id accepts a dom element, or a jquery wrapped dom element that should be a TR and should specify a parent row + * @param callback Specifies a custom function to be called when parent row is expanded(optional). Takes 2 arguments - first is hierarchical grid object, second is the row element that was collapsed */ collapse(id: Element, callback?: Function): void; /** * Checks if a parent row is currently collapsed * - * @param element accepts a dom element, or a jquery wrapped dom element that should be a TR and should specify a parent row + * @param element accepts a dom element, or a jquery wrapped dom element that should be a TR and should specify a parent row */ collapsed(element: Element): boolean; /** * Checks if a parent row is populated with data * - * @param element accepts a dom element, or a jquery wrapped dom element that should be a TR and should specify a parent row + * @param element accepts a dom element, or a jquery wrapped dom element that should be a TR and should specify a parent row */ populated(element: Element): boolean; @@ -50248,15 +50421,15 @@ interface IgHierarchicalGridMethods { /** * Clears the transaction log (delegates to igDataSource). Note that this does not update the UI. In case the UI must be updated, set the second parameter "updateUI" to true, which will trigger a call to dataBind() to re-render the contents. * - * @param rebind Whether to perform a rebind. + * @param rebind Whether to perform a rebind. */ rollback(rebind?: boolean): void; /** * Posts to the settings.updateUrl using $.ajax, by serializing the changes as url params * - * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) - * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) + * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) + * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) */ saveChanges(success: Function, error: Function): void; @@ -50490,6 +50663,7 @@ interface JQuery { * Defines the grid width in pixels or percents. [Here you can find more info about setting igGrid width](http://www.igniteui.com/help/iggrid-columns-and-layout#width-height). * */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "width"): string|number; /** @@ -50498,12 +50672,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "width", optionValue: string|number): void; /** * This is the total height of the grid, including all UI elements - scroll container with data rows, header, footer, filter row - (if any), etc. [Here you can find more info about setting igGrid height](http://www.igniteui.com/help/iggrid-columns-and-layout#width-height). * */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "height"): string|number; /** @@ -50512,6 +50688,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "height", optionValue: string|number): void; /** @@ -50532,6 +50709,7 @@ interface JQuery { * Used for [row virtualization](ui.ighierarchicalgrid#options:rowVirtualization) in [fixed mode](ui.ighierarchicalgrid#options:virtualizationMode). This is the average value in pixels (default) that will be used to calculate how many rows to render as the end user scrolls. Also all rows' height will be automatically set to this value. * */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "avgRowHeight"): string|number; /** @@ -50540,12 +50718,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "avgRowHeight", optionValue: string|number): void; /** * Used for [column virtualization](ui.ighierarchicalgrid#options:columnVirtualization) in [fixed mode](ui.ighierarchicalgrid#options:virtualizationMode). This is the average value in pixels for a column width. * */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "avgColumnWidth"): string|number; /** @@ -50554,12 +50734,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "avgColumnWidth", optionValue: string|number): void; /** * Default column width that will be set for all columns, that don't have [column width](ui.ighierarchicalgrid#options:columns.width) defined. * */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "defaultColumnWidth"): string|number; /** @@ -50568,6 +50750,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "defaultColumnWidth", optionValue: string|number): void; /** @@ -50606,6 +50789,7 @@ interface JQuery { * Determines row virtualization mode. * */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "virtualizationMode"): string; /** @@ -50614,6 +50798,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "virtualizationMode", optionValue: string): void; /** @@ -50676,6 +50861,7 @@ interface JQuery { * The templating engine that will be used to render the grid [column templates](ui.ighierarchicalgrid#options:columns.template). [Here you can find](http://www.infragistics.com/community/blogs/marina_stoyanova/archive/2014/05/30/using-different-template-engines-with-ignite-ui-controls.aspx) how to use templating engines other than igTemplating and jsRender. * */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "templatingEngine"): string; /** @@ -50684,6 +50870,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "templatingEngine", optionValue: string): void; /** @@ -50978,6 +51165,7 @@ interface JQuery { * Sets gets ability to automatically format text in cells for numeric and date columns. The format patterns and rules for numbers and dates are defined in $.ig.regional.defaults object. [Here column formatting is explained in details](http://www.igniteui.com/help/iggrid-columns-and-layout#column-formatting) * */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "autoFormat"): string|boolean; /** @@ -50986,6 +51174,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "autoFormat", optionValue: string|boolean): void; /** @@ -51134,6 +51323,7 @@ interface JQuery { * Configures how the feature chooser icon should display on header cells - e.g. to display as gear icon or not. * */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "featureChooserIconDisplay"): string; /** @@ -51142,6 +51332,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "featureChooserIconDisplay", optionValue: string): void; /** @@ -51686,7 +51877,7 @@ interface IgGridMultiColumnHeadersMethods { * Expands a collapsed group. If the group is expanded, the method does nothing. * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * - * @param groupKey Group key. + * @param groupKey Group key. * @param callback Specifies a custom function to be called when the group is expanded. */ expandGroup(groupKey: string, callback?: Function): void; @@ -52158,14 +52349,14 @@ interface IgGridPagingMethods { /** * Gets/Sets the current page index, delegates data binding and paging to [$.ig.DataSource](ig.datasource). * - * @param index The page index to go to. + * @param index The page index to go to. */ pageIndex(index?: number): number; /** * Gets/Sets the page size. If no parameter is specified, just returns the current page size. * - * @param size The new page size. + * @param size The new page size. */ pageSize(size?: number): number; @@ -52257,6 +52448,7 @@ interface JQuery { * Type of paging. Delegates all paging functionality to the [$.ig.DataSource](ig.datasource). * */ + igGridPaging(optionLiteral: 'option', optionName: "type"): string; /** @@ -52265,6 +52457,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridPaging(optionLiteral: 'option', optionName: "type", optionValue: string): void; /** @@ -52313,6 +52506,7 @@ interface JQuery { * Page size dropdown location, when [showPageSizeDropDown](ui.iggridpaging#options:showPageSizeDropDown) is set to true. Can be rendered above the grid header or inside the pager, next to the page links. * */ + igGridPaging(optionLiteral: 'option', optionName: "pageSizeDropDownLocation"): string; /** @@ -52321,6 +52515,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridPaging(optionLiteral: 'option', optionName: "pageSizeDropDownLocation", optionValue: string): void; /** @@ -52937,8 +53132,8 @@ interface IgGridResizingMethods { /** * Resizes a column to a specified width in pixels, percents or auto if no width is specified. * - * @param column An identifier for the column. If a number is provided it will be used as a columnIndex else if a strings is provided it will be used as a columnKey. - * @param width Width of the column in pixels or percents. If no width or "*" is specified the column will be auto-sized to the width of the data in it (including header and footer cells). + * @param column An identifier for the column. If a number is provided it will be used as a columnIndex else if a strings is provided it will be used as a columnKey. + * @param width Width of the column in pixels or percents. If no width or "*" is specified the column will be auto-sized to the width of the data in it (including header and footer cells). */ resize(column: Object, width?: Object): void; } @@ -53517,6 +53712,7 @@ interface JQuery { * The window's width under which the grid will render its contents vertically. * */ + igGridResponsive(optionLiteral: 'option', optionName: "windowWidthToRenderVertically"): string|number; /** @@ -53525,12 +53721,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridResponsive(optionLiteral: 'option', optionName: "windowWidthToRenderVertically", optionValue: string|number): void; /** * The width of the properties column when vertical rendering is enabled * */ + igGridResponsive(optionLiteral: 'option', optionName: "propertiesColumnWidth"): string|number; /** @@ -53539,12 +53737,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridResponsive(optionLiteral: 'option', optionName: "propertiesColumnWidth", optionValue: string|number): void; /** * The width of the values column when vertical rendering is enabled * */ + igGridResponsive(optionLiteral: 'option', optionName: "valuesColumnWidth"): string|number; /** @@ -53553,6 +53753,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridResponsive(optionLiteral: 'option', optionName: "valuesColumnWidth", optionValue: string|number): void; /** @@ -53951,6 +54152,7 @@ interface JQuery { * Defines width of the row selector`s column in pixels or percentage. * */ + igGridRowSelectors(optionLiteral: 'option', optionName: "rowSelectorColumnWidth"): string|number; /** @@ -53959,6 +54161,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridRowSelectors(optionLiteral: 'option', optionName: "rowSelectorColumnWidth", optionValue: string|number): void; /** @@ -54410,62 +54613,62 @@ interface IgGridSelectionMethods { /** * Selects a cell by row/col * - * @param row Row index - * @param col Column index - * @param isFixed If the cell is part of the fixed or unfixed area of the grid. + * @param row Row index + * @param col Column index + * @param isFixed If the cell is part of the fixed or unfixed area of the grid. */ selectCell(row: number, col: number, isFixed?: boolean): void; /** * Selects a cell by row id/column key * - * @param id Row Id - * @param colKey Column key + * @param id Row Id + * @param colKey Column key */ selectCellById(id: Object, colKey: string): void; /** * Deselects a cell by row/col * - * @param row Row index - * @param col Column index - * @param isFixed If the cell is part of the fixed or unfixed area of the grid. + * @param row Row index + * @param col Column index + * @param isFixed If the cell is part of the fixed or unfixed area of the grid. */ deselectCell(row: number, col: number, isFixed?: boolean): void; /** * Deselects a cell by row id/column key * - * @param id Row Id - * @param colKey Column key + * @param id Row Id + * @param colKey Column key */ deselectCellById(id: Object, colKey: string): void; /** * Selects a row by index * - * @param index Row index + * @param index Row index */ selectRow(index: number): void; /** * Selects a row by row id * - * @param id Row Id + * @param id Row Id */ selectRowById(id: Object): void; /** * Deselects a row by index * - * @param index Row index + * @param index Row index */ deselectRow(index: number): void; /** * Deselects a row by row id * - * @param id Row Id + * @param id Row Id */ deselectRowById(id: Object): void; @@ -54672,6 +54875,7 @@ interface JQuery { * Defines type of the selection. * */ + igGridSelection(optionLiteral: 'option', optionName: "mode"): string; /** @@ -54680,6 +54884,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridSelection(optionLiteral: 'option', optionName: "mode", optionValue: string): void; /** @@ -55360,8 +55565,8 @@ interface IgGridSortingMethods { /** * Sorts the data in a grid column and updates the UI. * - * @param index Column key (string) or index (number) - for multi-row grid only column key can be used. Specifies the column which we want to sort. If the mode is multiple, previous sorting states are not cleared. - * @param direction Specifies sorting direction (ascending or descending) + * @param index Column key (string) or index (number) - for multi-row grid only column key can be used. Specifies the column which we want to sort. If the mode is multiple, previous sorting states are not cleared. + * @param direction Specifies sorting direction (ascending or descending) * @param header */ sortColumn(index: Object, direction: Object, header: Object): void; @@ -55379,8 +55584,8 @@ interface IgGridSortingMethods { /** * Removes sorting for the grid column with the specified columnKey/columnIndex and updates the UI. * - * @param index Column key (string) or index (number) - for multi-row grid only column key can be used. Specifies the column for which we want to remove sorting. If the mode is multiple, previous sorting states are not cleared. - * @param header - if specified client events should be fired + * @param index Column key (string) or index (number) - for multi-row grid only column key can be used. Specifies the column for which we want to remove sorting. If the mode is multiple, previous sorting states are not cleared. + * @param header - if specified client events should be fired */ unsortColumn(index: Object, header: Object): void; @@ -55430,6 +55635,7 @@ interface JQuery { * Defines local or remote sorting operations. * */ + igGridSorting(optionLiteral: 'option', optionName: "type"): string; /** @@ -55438,6 +55644,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridSorting(optionLiteral: 'option', optionName: "type", optionValue: string): void; /** @@ -55514,6 +55721,7 @@ interface JQuery { * Defines single column sorting or multiple column sorting. * */ + igGridSorting(optionLiteral: 'option', optionName: "mode"): string; /** @@ -55522,6 +55730,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridSorting(optionLiteral: 'option', optionName: "mode", optionValue: string): void; /** @@ -55542,6 +55751,7 @@ interface JQuery { * Gets which direction to use on the first click / keydown, if the column is sorted for the first time. * */ + igGridSorting(optionLiteral: 'option', optionName: "firstSortDirection"): string; /** @@ -55550,6 +55760,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridSorting(optionLiteral: 'option', optionName: "firstSortDirection", optionValue: string): void; /** @@ -55652,6 +55863,7 @@ interface JQuery { * Gets width of multiple sorting dialog. * */ + igGridSorting(optionLiteral: 'option', optionName: "modalDialogWidth"): string|number; /** @@ -55660,12 +55872,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridSorting(optionLiteral: 'option', optionName: "modalDialogWidth", optionValue: string|number): void; /** * Gets height of multiple sorting dialog. * */ + igGridSorting(optionLiteral: 'option', optionName: "modalDialogHeight"): string|number; /** @@ -55674,6 +55888,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridSorting(optionLiteral: 'option', optionName: "modalDialogHeight", optionValue: string|number): void; /** @@ -56477,47 +56692,47 @@ interface IgGridSummariesMethods { /** * Toggle drop down * - * @param columnKey toggle drop down for the column with the specified key - * @param event event object. Its data should contain current columnKey, isAnimating, buttonId + * @param columnKey toggle drop down for the column with the specified key + * @param event event object. Its data should contain current columnKey, isAnimating, buttonId */ toggleDropDown(columnKey: string, event: Object): void; /** * Show/Hide dialog * - * @param $dialog jQuery object representation of dropdown div element + * @param $dialog jQuery object representation of dropdown div element */ showHideDialog($dialog: Object): void; /** * Toggle summaries rows * - * @param isToShow Specifies whether to show or not summaries - * @param isInternalCall Optional parameter.Specifies whether this function is called internally by the widget. + * @param isToShow Specifies whether to show or not summaries + * @param isInternalCall Optional parameter.Specifies whether this function is called internally by the widget. */ toggleSummariesRows(isToShow: boolean, isInternalCall: boolean): void; /** * Toggles the checkstate of a checkbox if checkboxMode is not set to off, otherwise does nothing. * - * @param $checkbox Specifies the jQuery object of the checkbox. + * @param $checkbox Specifies the jQuery object of the checkbox. */ toggleCheckstate($checkbox: Object): void; /** * Select/Unselect specified checkbox * - * @param $checkbox Specifies the jQuery object for checkbox - * @param isToSelect Specify whether to select or not checkbox + * @param $checkbox Specifies the jQuery object for checkbox + * @param isToSelect Specify whether to select or not checkbox */ selectCheckBox($checkbox: Object, isToSelect: boolean): void; /** * Summary calculate the whole data for the specified column key, columnMethods and dataType (used when datasource is remote and dataType is date) * - * @param ck ColumnKey - * @param columnMethods Array of column methods objects - * @param data Object which represents result + * @param ck ColumnKey + * @param columnMethods Array of column methods objects + * @param data Object which represents result * represents dataType for the current column * @param dataType */ @@ -56557,6 +56772,7 @@ interface JQuery { * Type of summaries calculating. * */ + igGridSummaries(optionLiteral: 'option', optionName: "type"): string; /** @@ -56565,6 +56781,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridSummaries(optionLiteral: 'option', optionName: "type", optionValue: string): void; /** @@ -56599,6 +56816,7 @@ interface JQuery { * Gets when calculations are made. * */ + igGridSummaries(optionLiteral: 'option', optionName: "calculateRenderMode"): string; /** @@ -56607,6 +56825,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridSummaries(optionLiteral: 'option', optionName: "calculateRenderMode", optionValue: string): void; /** @@ -56759,6 +56978,7 @@ interface JQuery { * Determines when the summary values are calculated when type is local * */ + igGridSummaries(optionLiteral: 'option', optionName: "summaryExecution"): string; /** @@ -56767,6 +56987,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridSummaries(optionLiteral: 'option', optionName: "summaryExecution", optionValue: string): void; /** @@ -56829,6 +57050,7 @@ interface JQuery { * A reference or name of a javascript function - renders summary cell in grid footer.(if not set it is used default render function) It takes 3 parameters - methodName(summary method), columnKey, data(summary data which should be rendered) * */ + igGridSummaries(optionLiteral: 'option', optionName: "renderSummaryCellFunc"): string|Object; /** @@ -56837,6 +57059,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridSummaries(optionLiteral: 'option', optionName: "renderSummaryCellFunc", optionValue: string|Object): void; /** @@ -57154,6 +57377,7 @@ interface JQuery { * Determines the tooltip visibility option * */ + igGridTooltips(optionLiteral: 'option', optionName: "visibility"): string; /** @@ -57162,12 +57386,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridTooltips(optionLiteral: 'option', optionName: "visibility", optionValue: string): void; /** * Controls the tooltip's style * */ + igGridTooltips(optionLiteral: 'option', optionName: "style"): string; /** @@ -57176,6 +57402,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridTooltips(optionLiteral: 'option', optionName: "style", optionValue: string): void; /** @@ -57501,14 +57728,12 @@ interface IgGridUpdatingRowEditDialogOptions { /** * Specifies a template to be rendered against the currently edited record (or up-to-date key-value pairs in the case of not yet created records). It may contain an element decorated with the 'data-render-tmpl' attribute to specify where the control should render the editors template specified in the [editorsTemplate](ui.iggridupdating#options:rowEditDialogOptions.editorsTemplate) option. For custom dialogs, the elements can be decorated with 'data-editor-for-' attributes where columnKey is the key of the column that editor or input will be used to edit. If both dialogTemplate and [dialogTemplateSelector](ui.iggridupdating#options:rowEditDialogOptions.dialogTemplateSelector) are specified, dialogTemplateSelector will be used.The default template is '
'. * - * */ dialogTemplate?: string; /** * Specifies a selector to a template rendered against the currently edited record (or up-to-date key-value pairs in the case of not yet created records). It may contain an element decorated with the 'data-render-tmpl' attribute to specify where the control should render the editors template specified in the [editorsTemplate](ui.iggridupdating#options:rowEditDialogOptions.editorsTemplate) option. For custom dialogs, the elements can be decorated with 'data-editor-for-' attributes where columnKey is the key of the column that editor or input will be used to edit. If both [dialogTemplate](ui.iggridupdating#options:rowEditDialogOptions.dialogTemplate) and dialogTemplateSelector are specified, dialogTemplateSelector will be used.The default template is '
'. * - * */ dialogTemplateSelector?: string; @@ -57853,8 +58078,7 @@ interface DataDirtyEvent { (event: Event, ui: DataDirtyEventUIParam): void; } -interface DataDirtyEventUIParam { -} +interface DataDirtyEventUIParam {} interface GeneratePrimaryKeyValueEvent { (event: Event, ui: GeneratePrimaryKeyValueEventUIParam): void; @@ -58190,9 +58414,9 @@ interface IgGridUpdatingMethods { * Sets a cell value for the specified cell. It also creates a transaction and updates the UI. * If the specified cell is currently in edit mode, the function will set the desired value in the cell's editor instead. * - * @param rowId The primary key of the row the cell is a child of. - * @param colKey The column key of the cell. - * @param value The new value for the cell. + * @param rowId The primary key of the row the cell is a child of. + * @param colKey The column key of the cell. + * @param value The new value for the cell. */ setCellValue(rowId: Object, colKey: string, value: Object): void; @@ -58200,46 +58424,46 @@ interface IgGridUpdatingMethods { * Sets values for specified cells in a row. It also creates a transaction and updates the UI. * If the specified row is currently in edit mode, the function will set the desired values in the row's editors instead. * - * @param rowId The primary key of the row to update. - * @param values Pairs of values in the format { column1Key: value1, column2Key: value2, ... } . + * @param rowId The primary key of the row to update. + * @param values Pairs of values in the format { column1Key: value1, column2Key: value2, ... } . */ updateRow(rowId: Object, values: Object): void; /** * Adds a new row to the grid. It also creates a transaction and updates the UI. * - * @param values Pairs of values in the format { column1Key: value1, column2Key: value2, ... } . + * @param values Pairs of values in the format { column1Key: value1, column2Key: value2, ... } . */ addRow(values: Object): void; /** * Deletes a row from the grid. It also creates a transaction and updates the UI. * - * @param rowId The primary key of the row to delete. + * @param rowId The primary key of the row to delete. */ deleteRow(rowId: Object): void; /** * Starts editing for the row or cell specified (depending on the [editMode](ui.iggridupdating#options:editMode)). * - * @param rowId The row id. - * @param column The column key or index. - * @param raiseEvents Specifies whether or not updating events should be raised for this operation. + * @param rowId The row id. + * @param column The column key or index. + * @param raiseEvents Specifies whether or not updating events should be raised for this operation. */ startEdit(rowId: Object, column: Object, raiseEvents?: boolean): boolean; /** * Starts editing for adding a new row. * - * @param raiseEvents Specifies whether or not updating events should be raised for this operation. + * @param raiseEvents Specifies whether or not updating events should be raised for this operation. */ startAddRowEdit(raiseEvents?: boolean): boolean; /** * Ends the currently active edit mode. * - * @param update Specifies if the edit process should accept the current changes. Default is 'false'. - * @param raiseEvents Specifies whether or not updating events should be raised for this operation. + * @param update Specifies if the edit process should accept the current changes. Default is 'false'. + * @param raiseEvents Specifies whether or not updating events should be raised for this operation. */ endEdit(update?: boolean, raiseEvents?: boolean): boolean; @@ -58256,15 +58480,15 @@ interface IgGridUpdatingMethods { /** * Gets the editor for a column by the column key. That method can be used only after the editor has been created. * - * @param key The key of the column. + * @param key The key of the column. */ editorForKey(key: string): Object; /** * Gets the editor for a column by the cell it resides in. If allowed the function can create the editor if it has not been created yet. * - * @param cell Reference to the jQuery-wrapped TD object of the grid that the editor belongs to. - * @param create Requests to create the editor if it has not been created yet. + * @param cell Reference to the jQuery-wrapped TD object of the grid that the editor belongs to. + * @param create Requests to create the editor if it has not been created yet. */ editorForCell(cell: string, create?: boolean): Object; @@ -58276,7 +58500,7 @@ interface IgGridUpdatingMethods { /** * Shows the delete button for specific row. * - * @param row A jQuery object of the targeted row. + * @param row A jQuery object of the targeted row. */ showDeleteButtonFor(row: Object): void; @@ -58323,6 +58547,7 @@ interface JQuery { * Gets the edit mode. * */ + igGridUpdating(optionLiteral: 'option', optionName: "editMode"): string; /** @@ -58331,6 +58556,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridUpdating(optionLiteral: 'option', optionName: "editMode", optionValue: string): void; /** @@ -58519,6 +58745,7 @@ interface JQuery { * Gets how end-users are able to start edit mode. Possible values: "click", "dblclick", "F2", "enter" and their combinations separated by coma or in array. The keyboard triggers have effect only if the grid cells can receive focus (the grid's [tabIndex](ui.iggrid#options:tabIndex) property should not have a negative value) or Selection is enabled. If "dblclick" is included, then "click" has no effect. * */ + igGridUpdating(optionLiteral: 'option', optionName: "startEditTriggers"): string|Array; /** @@ -58527,6 +58754,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridUpdating(optionLiteral: 'option', optionName: "startEditTriggers", optionValue: string|Array): void; /** @@ -58561,6 +58789,7 @@ interface JQuery { * Sets a custom function to be called when the AJAX request to the URL specified by the [updateUrl](ui.iggrid#options:updateUrl) property succeeds. The function will be called with arguments representing the data returned by the server. * */ + igGridUpdating(optionLiteral: 'option', optionName: "saveChangesSuccessHandler"): Function|string; /** @@ -58569,12 +58798,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridUpdating(optionLiteral: 'option', optionName: "saveChangesSuccessHandler", optionValue: Function|string): void; /** * Sets a custom function to be called when the AJAX request to the URL specified by the [updateUrl](ui.iggrid#options:updateUrl) property fails. The function will be called with arguments representing the data returned by the server. * */ + igGridUpdating(optionLiteral: 'option', optionName: "saveChangesErrorHandler"): Function|string; /** @@ -58583,12 +58814,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridUpdating(optionLiteral: 'option', optionName: "saveChangesErrorHandler", optionValue: Function|string): void; /** * On touch-enabled devices specifies the swipe distance for the delete button to appear. * */ + igGridUpdating(optionLiteral: 'option', optionName: "swipeDistance"): string|number; /** @@ -58597,6 +58830,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igGridUpdating(optionLiteral: 'option', optionName: "swipeDistance", optionValue: string|number): void; /** @@ -58904,85 +59138,73 @@ interface ActionExecutingEvent { (event: Event, ui: ActionExecutingEventUIParam): void; } -interface ActionExecutingEventUIParam { -} +interface ActionExecutingEventUIParam {} interface ActionExecutedEvent { (event: Event, ui: ActionExecutedEventUIParam): void; } -interface ActionExecutedEventUIParam { -} +interface ActionExecutedEventUIParam {} interface ToolbarCollapsingEvent { (event: Event, ui: ToolbarCollapsingEventUIParam): void; } -interface ToolbarCollapsingEventUIParam { -} +interface ToolbarCollapsingEventUIParam {} interface ToolbarCollapsedEvent { (event: Event, ui: ToolbarCollapsedEventUIParam): void; } -interface ToolbarCollapsedEventUIParam { -} +interface ToolbarCollapsedEventUIParam {} interface ToolbarExpandingEvent { (event: Event, ui: ToolbarExpandingEventUIParam): void; } -interface ToolbarExpandingEventUIParam { -} +interface ToolbarExpandingEventUIParam {} interface ToolbarExpandedEvent { (event: Event, ui: ToolbarExpandedEventUIParam): void; } -interface ToolbarExpandedEventUIParam { -} +interface ToolbarExpandedEventUIParam {} interface CutEvent { (event: Event, ui: CutEventUIParam): void; } -interface CutEventUIParam { -} +interface CutEventUIParam {} interface CopyEvent { (event: Event, ui: CopyEventUIParam): void; } -interface CopyEventUIParam { -} +interface CopyEventUIParam {} interface PasteEvent { (event: Event, ui: PasteEventUIParam): void; } -interface PasteEventUIParam { -} +interface PasteEventUIParam {} interface UndoEvent { (event: Event, ui: UndoEventUIParam): void; } -interface UndoEventUIParam { -} +interface UndoEventUIParam {} interface RedoEvent { (event: Event, ui: RedoEventUIParam): void; } -interface RedoEventUIParam { -} +interface RedoEventUIParam {} interface WorkspaceResizedEvent { (event: Event, ui: WorkspaceResizedEventUIParam): void; } -interface WorkspaceResizedEventUIParam { -} +interface WorkspaceResizedEventUIParam {} interface IgHtmlEditor { /** @@ -59213,29 +59435,25 @@ interface ApplyEvent { (event: Event, ui: ApplyEventUIParam): void; } -interface ApplyEventUIParam { -} +interface ApplyEventUIParam {} interface CancelEvent { (event: Event, ui: CancelEventUIParam): void; } -interface CancelEventUIParam { -} +interface CancelEventUIParam {} interface ShowEvent { (event: Event, ui: ShowEventUIParam): void; } -interface ShowEventUIParam { -} +interface ShowEventUIParam {} interface HideEvent { (event: Event, ui: HideEventUIParam): void; } -interface HideEventUIParam { -} +interface HideEventUIParam {} interface IgHtmlEditorPopover { item?: any; @@ -59423,6 +59641,7 @@ interface JQuery { * The width of the html editor. It can be set as a number in pixels, string (px) or percentage (%). * */ + igHtmlEditor(optionLiteral: 'option', optionName: "width"): string|number; /** @@ -59431,12 +59650,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igHtmlEditor(optionLiteral: 'option', optionName: "width", optionValue: string|number): void; /** * The height of the html editor. It can be set as a number in pixels, string (px) or percentage (%). * */ + igHtmlEditor(optionLiteral: 'option', optionName: "height"): string|number; /** @@ -59445,6 +59666,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igHtmlEditor(optionLiteral: 'option', optionName: "height", optionValue: string|number): void; /** @@ -59677,12 +59899,7 @@ interface JQuery { igHtmlEditor(methodName: string, ...methodParams: any[]): any; } interface JQuery { - /** - */ igPathFinder(optionLiteral: 'option', optionName: "items"): any; - - /** - */ igPathFinder(optionLiteral: 'option', optionName: "items", optionValue: any): void; igPathFinder(options: IgPathFinder): JQuery; igPathFinder(optionLiteral: 'option', optionName: string): any; @@ -59693,61 +59910,19 @@ interface JQuery { interface JQuery { igHtmlEditorPopover(methodName: "show", item: Object): void; igHtmlEditorPopover(methodName: "hide"): void; - - /** - */ igHtmlEditorPopover(optionLiteral: 'option', optionName: "item"): any; - - /** - */ igHtmlEditorPopover(optionLiteral: 'option', optionName: "item", optionValue: any): void; - - /** - */ igHtmlEditorPopover(optionLiteral: 'option', optionName: "target"): any; - - /** - */ igHtmlEditorPopover(optionLiteral: 'option', optionName: "target", optionValue: any): void; - - /** - */ igHtmlEditorPopover(optionLiteral: 'option', optionName: "isHidden"): boolean; - - /** - */ igHtmlEditorPopover(optionLiteral: 'option', optionName: "isHidden", optionValue: boolean): void; - - /** - */ igHtmlEditorPopover(optionLiteral: 'option', optionName: "apply"): ApplyEvent; - - /** - */ igHtmlEditorPopover(optionLiteral: 'option', optionName: "apply", optionValue: ApplyEvent): void; - - /** - */ igHtmlEditorPopover(optionLiteral: 'option', optionName: "cancel"): CancelEvent; - - /** - */ igHtmlEditorPopover(optionLiteral: 'option', optionName: "cancel", optionValue: CancelEvent): void; - - /** - */ igHtmlEditorPopover(optionLiteral: 'option', optionName: "show"): ShowEvent; - - /** - */ igHtmlEditorPopover(optionLiteral: 'option', optionName: "show", optionValue: ShowEvent): void; - - /** - */ igHtmlEditorPopover(optionLiteral: 'option', optionName: "hide"): HideEvent; - - /** - */ igHtmlEditorPopover(optionLiteral: 'option', optionName: "hide", optionValue: HideEvent): void; igHtmlEditorPopover(options: IgHtmlEditorPopover): JQuery; igHtmlEditorPopover(optionLiteral: 'option', optionName: string): any; @@ -59758,61 +59933,19 @@ interface JQuery { interface JQuery { igLinkPropertiesDialog(methodName: "show", item: Object): void; igLinkPropertiesDialog(methodName: "hide"): void; - - /** - */ igLinkPropertiesDialog(optionLiteral: 'option', optionName: "item"): any; - - /** - */ igLinkPropertiesDialog(optionLiteral: 'option', optionName: "item", optionValue: any): void; - - /** - */ igLinkPropertiesDialog(optionLiteral: 'option', optionName: "target"): any; - - /** - */ igLinkPropertiesDialog(optionLiteral: 'option', optionName: "target", optionValue: any): void; - - /** - */ igLinkPropertiesDialog(optionLiteral: 'option', optionName: "isHidden"): boolean; - - /** - */ igLinkPropertiesDialog(optionLiteral: 'option', optionName: "isHidden", optionValue: boolean): void; - - /** - */ igLinkPropertiesDialog(optionLiteral: 'option', optionName: "apply"): ApplyEvent; - - /** - */ igLinkPropertiesDialog(optionLiteral: 'option', optionName: "apply", optionValue: ApplyEvent): void; - - /** - */ igLinkPropertiesDialog(optionLiteral: 'option', optionName: "cancel"): CancelEvent; - - /** - */ igLinkPropertiesDialog(optionLiteral: 'option', optionName: "cancel", optionValue: CancelEvent): void; - - /** - */ igLinkPropertiesDialog(optionLiteral: 'option', optionName: "show"): ShowEvent; - - /** - */ igLinkPropertiesDialog(optionLiteral: 'option', optionName: "show", optionValue: ShowEvent): void; - - /** - */ igLinkPropertiesDialog(optionLiteral: 'option', optionName: "hide"): HideEvent; - - /** - */ igLinkPropertiesDialog(optionLiteral: 'option', optionName: "hide", optionValue: HideEvent): void; igLinkPropertiesDialog(options: IgLinkPropertiesDialog): JQuery; igLinkPropertiesDialog(optionLiteral: 'option', optionName: string): any; @@ -59823,61 +59956,19 @@ interface JQuery { interface JQuery { igTablePropertiesDialog(methodName: "show", item: Object): void; igTablePropertiesDialog(methodName: "hide"): void; - - /** - */ igTablePropertiesDialog(optionLiteral: 'option', optionName: "item"): any; - - /** - */ igTablePropertiesDialog(optionLiteral: 'option', optionName: "item", optionValue: any): void; - - /** - */ igTablePropertiesDialog(optionLiteral: 'option', optionName: "target"): any; - - /** - */ igTablePropertiesDialog(optionLiteral: 'option', optionName: "target", optionValue: any): void; - - /** - */ igTablePropertiesDialog(optionLiteral: 'option', optionName: "isHidden"): boolean; - - /** - */ igTablePropertiesDialog(optionLiteral: 'option', optionName: "isHidden", optionValue: boolean): void; - - /** - */ igTablePropertiesDialog(optionLiteral: 'option', optionName: "apply"): ApplyEvent; - - /** - */ igTablePropertiesDialog(optionLiteral: 'option', optionName: "apply", optionValue: ApplyEvent): void; - - /** - */ igTablePropertiesDialog(optionLiteral: 'option', optionName: "cancel"): CancelEvent; - - /** - */ igTablePropertiesDialog(optionLiteral: 'option', optionName: "cancel", optionValue: CancelEvent): void; - - /** - */ igTablePropertiesDialog(optionLiteral: 'option', optionName: "show"): ShowEvent; - - /** - */ igTablePropertiesDialog(optionLiteral: 'option', optionName: "show", optionValue: ShowEvent): void; - - /** - */ igTablePropertiesDialog(optionLiteral: 'option', optionName: "hide"): HideEvent; - - /** - */ igTablePropertiesDialog(optionLiteral: 'option', optionName: "hide", optionValue: HideEvent): void; igTablePropertiesDialog(options: IgTablePropertiesDialog): JQuery; igTablePropertiesDialog(optionLiteral: 'option', optionName: string): any; @@ -59888,61 +59979,19 @@ interface JQuery { interface JQuery { igImagePropertiesDialog(methodName: "show", item: Object): void; igImagePropertiesDialog(methodName: "hide"): void; - - /** - */ igImagePropertiesDialog(optionLiteral: 'option', optionName: "item"): any; - - /** - */ igImagePropertiesDialog(optionLiteral: 'option', optionName: "item", optionValue: any): void; - - /** - */ igImagePropertiesDialog(optionLiteral: 'option', optionName: "target"): any; - - /** - */ igImagePropertiesDialog(optionLiteral: 'option', optionName: "target", optionValue: any): void; - - /** - */ igImagePropertiesDialog(optionLiteral: 'option', optionName: "isHidden"): boolean; - - /** - */ igImagePropertiesDialog(optionLiteral: 'option', optionName: "isHidden", optionValue: boolean): void; - - /** - */ igImagePropertiesDialog(optionLiteral: 'option', optionName: "apply"): ApplyEvent; - - /** - */ igImagePropertiesDialog(optionLiteral: 'option', optionName: "apply", optionValue: ApplyEvent): void; - - /** - */ igImagePropertiesDialog(optionLiteral: 'option', optionName: "cancel"): CancelEvent; - - /** - */ igImagePropertiesDialog(optionLiteral: 'option', optionName: "cancel", optionValue: CancelEvent): void; - - /** - */ igImagePropertiesDialog(optionLiteral: 'option', optionName: "show"): ShowEvent; - - /** - */ igImagePropertiesDialog(optionLiteral: 'option', optionName: "show", optionValue: ShowEvent): void; - - /** - */ igImagePropertiesDialog(optionLiteral: 'option', optionName: "hide"): HideEvent; - - /** - */ igImagePropertiesDialog(optionLiteral: 'option', optionName: "hide", optionValue: HideEvent): void; igImagePropertiesDialog(options: IgImagePropertiesDialog): JQuery; igImagePropertiesDialog(optionLiteral: 'option', optionName: string): any; @@ -60338,6 +60387,7 @@ interface JQuery { * Gets/Sets height of the layout container. * */ + igLayoutManager(optionLiteral: 'option', optionName: "height"): string|number; /** @@ -60346,6 +60396,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igLayoutManager(optionLiteral: 'option', optionName: "height", optionValue: string|number): void; /** @@ -60416,6 +60467,7 @@ interface JQuery { * Gets/Sets width of the layout container. * */ + igLayoutManager(optionLiteral: 'option', optionName: "width"): string|number; /** @@ -60424,6 +60476,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igLayoutManager(optionLiteral: 'option', optionName: "width", optionValue: string|number): void; /** @@ -60970,21 +61023,21 @@ interface IgLinearGaugeMethods { /** * Adds a new range to the linear gauge. * - * @param value The range object to be added. + * @param value The range object to be added. */ addRange(value: Object): void; /** * Removes a range from the linear gauge. * - * @param value A JS object with properties set as follows: name: nameOfTheRangeToRemove, remove: true + * @param value A JS object with properties set as follows: name: nameOfTheRangeToRemove, remove: true */ removeRange(value: Object): void; /** * Updates the specified range of the linear gauge. * - * @param value The range object to be updated. + * @param value The range object to be updated. */ updateRange(value: Object): void; @@ -61043,6 +61096,7 @@ interface JQuery { /** * The width of the gauge. It can be set as a number in pixels, string (px) or percentage (%). */ + igLinearGauge(optionLiteral: 'option', optionName: "width"): string|number; /** @@ -61050,11 +61104,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igLinearGauge(optionLiteral: 'option', optionName: "width", optionValue: string|number): void; /** * The height of the gauge. It can be set as a number in pixels, string (px) or percentage (%). */ + igLinearGauge(optionLiteral: 'option', optionName: "height"): string|number; /** @@ -61062,6 +61118,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igLinearGauge(optionLiteral: 'option', optionName: "height", optionValue: string|number): void; /** @@ -61103,6 +61160,7 @@ interface JQuery { /** * Gets the orientation of the scale. */ + igLinearGauge(optionLiteral: 'option', optionName: "orientation"): string; /** @@ -61110,6 +61168,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igLinearGauge(optionLiteral: 'option', optionName: "orientation", optionValue: string): void; /** @@ -61179,6 +61238,7 @@ interface JQuery { /** * Gets the shape to use when rendering the needle from a number of options. */ + igLinearGauge(optionLiteral: 'option', optionName: "needleShape"): string; /** @@ -61186,6 +61246,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igLinearGauge(optionLiteral: 'option', optionName: "needleShape", optionValue: string): void; /** @@ -62957,34 +63018,34 @@ interface IgMapMethods { /** * Adds a new item to the data source and notifies the map. * - * @param item The item that we want to add to the data source. - * @param targetName The name of the series bound to the data source. + * @param item The item that we want to add to the data source. + * @param targetName The name of the series bound to the data source. */ addItem(item: Object, targetName: string): void; /** * Inserts a new item to the data source and notifies the map. * - * @param item the new item that we want to insert in the data source. - * @param index The index in the data source where the new item will be inserted. - * @param targetName The name of the series bound to the data source. + * @param item the new item that we want to insert in the data source. + * @param index The index in the data source where the new item will be inserted. + * @param targetName The name of the series bound to the data source. */ insertItem(item: Object, index: number, targetName: string): void; /** * Deletes an item from the data source and notifies the map. * - * @param index The index in the data source from where the item will be been removed. - * @param targetName The name of the series bound to the data source. + * @param index The index in the data source from where the item will be been removed. + * @param targetName The name of the series bound to the data source. */ removeItem(index: number, targetName: string): void; /** * Updates an item in the data source and notifies the map. * - * @param index The index of the item in the data source that we want to change. - * @param item The new item object that will be set in the data source. - * @param targetName The name of the series bound to the data source. + * @param index The index of the item in the data source that we want to change. + * @param item The new item object that will be set in the data source. + * @param targetName The name of the series bound to the data source. */ setItem(index: number, item: Object, targetName: string): void; @@ -63125,8 +63186,8 @@ interface IgMapMethods { /** * Indicates that a series should render, even though no option has been modified that would normally cause it to refresh. * - * @param targetName The name of the series to render. - * @param animate Whether the change should be animated, if possible. + * @param targetName The name of the series to render. + * @param animate Whether the change should be animated, if possible. */ renderSeries(targetName: string, animate: boolean): void; } @@ -63305,6 +63366,7 @@ interface JQuery { /** * The width of the map. It can be set as a number in pixels, string (px) or percentage (%). */ + igMap(optionLiteral: 'option', optionName: "width"): string|number; /** @@ -63312,11 +63374,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igMap(optionLiteral: 'option', optionName: "width", optionValue: string|number): void; /** * The height of the map. It can be set as a number in pixels, string (px) or percentage (%). */ + igMap(optionLiteral: 'option', optionName: "height"): string|number; /** @@ -63324,6 +63388,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igMap(optionLiteral: 'option', optionName: "height", optionValue: string|number): void; /** @@ -63401,6 +63466,7 @@ interface JQuery { /** * Gets the current Map's crosshair visibility override. */ + igMap(optionLiteral: 'option', optionName: "crosshairVisibility"): string; /** @@ -63408,6 +63474,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igMap(optionLiteral: 'option', optionName: "crosshairVisibility", optionValue: string): void; /** @@ -63441,6 +63508,7 @@ interface JQuery { /** * Gets the DefaultInteraction property. The default interaction state defines the map's response to mouse events. */ + igMap(optionLiteral: 'option', optionName: "defaultInteraction"): string; /** @@ -63448,11 +63516,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igMap(optionLiteral: 'option', optionName: "defaultInteraction", optionValue: string): void; /** * Gets the current Map's DragModifier property. */ + igMap(optionLiteral: 'option', optionName: "dragModifier"): string; /** @@ -63460,11 +63530,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igMap(optionLiteral: 'option', optionName: "dragModifier", optionValue: string): void; /** * Gets the current Map's PanModifier property. */ + igMap(optionLiteral: 'option', optionName: "panModifier"): string; /** @@ -63472,6 +63544,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igMap(optionLiteral: 'option', optionName: "panModifier", optionValue: string): void; /** @@ -63536,6 +63609,7 @@ interface JQuery { * The response to user panning and zooming: whether to update the view immediately while the user action is happening, or to defer the update to after the user action is complete. The user action will be an action such as a mouse drag which causes panning and/or zooming to occur. * */ + igMap(optionLiteral: 'option', optionName: "windowResponse"): string; /** @@ -63544,6 +63618,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igMap(optionLiteral: 'option', optionName: "windowResponse", optionValue: string): void; /** @@ -64315,7 +64390,6 @@ interface IgNotifier { * Controls the positioning mode of messages. Setting a mode will override the default behavior which is auto.Note: Inline element uses a block container as is always placed after the target. * * - * * Valid values: * "auto" Uses popover for info and warning messages and inline for errors and success. * "popover" Displays messages in a configurable popover. @@ -64489,8 +64563,8 @@ interface IgNotifierMethods { /** * Triggers a notification with a certain state and optional message. The [notifyLevel](ui.ignotifier#options:notifyLevel) option determines if the notification will be displayed. * - * @param state The state to show notification for. - * @param message Optional message to show, overrides defaults. + * @param state The state to show notification for. + * @param message Optional message to show, overrides defaults. */ notify(state: Object, message?: string): void; @@ -64517,8 +64591,8 @@ interface IgNotifierMethods { /** * Shows the popover for the specified target * - * @param trg The element to show popover for. - * @param content The string to set for the popover to show. + * @param trg The element to show popover for. + * @param content The string to set for the popover to show. */ show(trg?: Element, content?: string): void; @@ -64535,7 +64609,7 @@ interface IgNotifierMethods { /** * Sets the content for the popover container * - * @param newCnt The popover content to set. + * @param newCnt The popover content to set. */ setContent(newCnt: string): void; @@ -64552,7 +64626,7 @@ interface IgNotifierMethods { /** * Sets the popover to specific coordinates. * - * @param pos The popover coordinates in pixels. + * @param pos The popover coordinates in pixels. */ setCoordinates(pos: Object): void; } @@ -64578,6 +64652,7 @@ interface JQuery { * Gets/Sets the current state of the igNotifier messages. State controls what CSS classes are applied to the messages and target and has interactions with other options as well. * */ + igNotifier(optionLiteral: 'option', optionName: "state"): string; /** @@ -64586,12 +64661,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igNotifier(optionLiteral: 'option', optionName: "state", optionValue: string): void; /** * Controls the level of notifications shown by automatic and manual messages using the [notify](ui.ignotifier#methods:notify) method. Use [show](ui.ignotifier#methods:show) to ignore the level. * */ + igNotifier(optionLiteral: 'option', optionName: "notifyLevel"): string; /** @@ -64600,12 +64677,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igNotifier(optionLiteral: 'option', optionName: "notifyLevel", optionValue: string): void; /** * Controls where the popover DOM should be attached to (only applies to popovers). * */ + igNotifier(optionLiteral: 'option', optionName: "appendTo"): string|Object; /** @@ -64614,22 +64693,23 @@ interface JQuery { * * @optionValue New value to be set. */ + igNotifier(optionLiteral: 'option', optionName: "appendTo", optionValue: string|Object): void; /** * Controls the positioning mode of messages. Setting a mode will override the default behavior which is auto.Note: Inline element uses a block container as is always placed after the target. * - * */ + igNotifier(optionLiteral: 'option', optionName: "mode"): string; /** * Controls the positioning mode of messages. Setting a mode will override the default behavior which is auto.Note: Inline element uses a block container as is always placed after the target. * * - * * @optionValue New value to be set. */ + igNotifier(optionLiteral: 'option', optionName: "mode", optionValue: string): void; /** @@ -64678,6 +64758,7 @@ interface JQuery { * Gets/Sets the content for the popover container. Templated with parameters by default: {0} - icon container class, {1} - the icon class and {2} - message text. * */ + igNotifier(optionLiteral: 'option', optionName: "contentTemplate"): string|Function; /** @@ -64686,6 +64767,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igNotifier(optionLiteral: 'option', optionName: "contentTemplate", optionValue: string|Function): void; /** @@ -64706,6 +64788,7 @@ interface JQuery { * Sets the event on which the notification will be shown. Predefined values are "mouseenter", "click" and "focus" * */ + igNotifier(optionLiteral: 'option', optionName: "showOn"): string; /** @@ -64714,6 +64797,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igNotifier(optionLiteral: 'option', optionName: "showOn", optionValue: string): void; /** @@ -64774,6 +64858,7 @@ interface JQuery { * Controls the direction in which the control shows relative to the target element * */ + igNotifier(optionLiteral: 'option', optionName: "direction"): string; /** @@ -64782,6 +64867,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igNotifier(optionLiteral: 'option', optionName: "direction", optionValue: string): void; /** @@ -64804,6 +64890,7 @@ interface JQuery { * Controls the position of the popover according to the target element in case the popover is larger than the target on the side we want to position, if the popover is smaller it should always be in the middle of the visible area * */ + igNotifier(optionLiteral: 'option', optionName: "position"): string; /** @@ -64812,12 +64899,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igNotifier(optionLiteral: 'option', optionName: "position", optionValue: string): void; /** * Defines width for the popover. leave null for auto. * */ + igNotifier(optionLiteral: 'option', optionName: "width"): number|string; /** @@ -64826,12 +64915,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igNotifier(optionLiteral: 'option', optionName: "width", optionValue: number|string): void; /** * Defines height for the popover. leave null for auto * */ + igNotifier(optionLiteral: 'option', optionName: "height"): number|string; /** @@ -64840,12 +64931,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igNotifier(optionLiteral: 'option', optionName: "height", optionValue: number|string): void; /** * Defines width the popover won't go under the value even if no specific one is set. * */ + igNotifier(optionLiteral: 'option', optionName: "minWidth"): number|string; /** @@ -64854,12 +64947,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igNotifier(optionLiteral: 'option', optionName: "minWidth", optionValue: number|string): void; /** * Defines width the popover won't exceed even if no specific one is set. * */ + igNotifier(optionLiteral: 'option', optionName: "maxWidth"): number|string; /** @@ -64868,12 +64963,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igNotifier(optionLiteral: 'option', optionName: "maxWidth", optionValue: number|string): void; /** * Defines height the popover won't exceed even if no specific one is set. * */ + igNotifier(optionLiteral: 'option', optionName: "maxHeight"): number|string; /** @@ -64882,6 +64979,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igNotifier(optionLiteral: 'option', optionName: "maxHeight", optionValue: number|string): void; /** @@ -65929,17 +66027,14 @@ interface JQuery { igPivotDataSelector(methodName: "update"): void; igPivotDataSelector(methodName: "destroy"): void; - /** - */ igPivotDataSelector(optionLiteral: 'option', optionName: "width"): string|number; - /** - */ igPivotDataSelector(optionLiteral: 'option', optionName: "width", optionValue: string|number): void; /** * This is the total height of the grid, including all UI elements - scroll container with data rows, header, footer, filter row - (if any), etc. */ + igPivotDataSelector(optionLiteral: 'option', optionName: "height"): string|number; /** @@ -65947,6 +66042,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igPivotDataSelector(optionLiteral: 'option', optionName: "height", optionValue: string|number): void; /** @@ -67581,17 +67677,14 @@ interface JQuery { igPivotGrid(methodName: "appliedLevelSortDirections"): any[]; igPivotGrid(methodName: "destroy"): void; - /** - */ igPivotGrid(optionLiteral: 'option', optionName: "width"): string|number; - /** - */ igPivotGrid(optionLiteral: 'option', optionName: "width", optionValue: string|number): void; /** * This is the total height of the grid. */ + igPivotGrid(optionLiteral: 'option', optionName: "height"): string|number; /** @@ -67599,6 +67692,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igPivotGrid(optionLiteral: 'option', optionName: "height", optionValue: string|number): void; /** @@ -67836,6 +67930,7 @@ interface JQuery { /** * Gets the default sort behavior for the levels if no sort behavior is specified in an item from the levelSortDirections option. */ + igPivotGrid(optionLiteral: 'option', optionName: "defaultLevelSortBehavior"): string; /** @@ -67843,6 +67938,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igPivotGrid(optionLiteral: 'option', optionName: "defaultLevelSortBehavior", optionValue: string): void; /** @@ -69293,20 +69389,12 @@ interface JQuery { igPivotView(methodName: "splitter"): Object; igPivotView(methodName: "destroy"): void; - /** - */ igPivotView(optionLiteral: 'option', optionName: "width"): string|number; - /** - */ igPivotView(optionLiteral: 'option', optionName: "width", optionValue: string|number): void; - /** - */ igPivotView(optionLiteral: 'option', optionName: "height"): string|number; - /** - */ igPivotView(optionLiteral: 'option', optionName: "height", optionValue: string|number): void; /** @@ -69556,8 +69644,8 @@ interface IgPopoverMethods { /** * Shows the popover for the specified target * - * @param trg The element to show popover for. - * @param content The string to set for the popover to show. + * @param trg The element to show popover for. + * @param content The string to set for the popover to show. */ show(trg?: Element, content?: string): void; @@ -69574,7 +69662,7 @@ interface IgPopoverMethods { /** * Sets the content for the popover container * - * @param newCnt The popover content to set. + * @param newCnt The popover content to set. */ setContent(newCnt: string): void; @@ -69591,7 +69679,7 @@ interface IgPopoverMethods { /** * Sets the popover to specific coordinates. * - * @param pos The popover coordinates in pixels. + * @param pos The popover coordinates in pixels. */ setCoordinates(pos: Object): void; } @@ -69629,6 +69717,7 @@ interface JQuery { * Controls the direction in which the control shows relative to the target element * */ + igPopover(optionLiteral: 'option', optionName: "direction"): string; /** @@ -69637,6 +69726,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igPopover(optionLiteral: 'option', optionName: "direction", optionValue: string): void; /** @@ -69659,6 +69749,7 @@ interface JQuery { * Controls the position of the popover according to the target element in case the popover is larger than the target on the side we want to position, if the popover is smaller it should always be in the middle of the visible area * */ + igPopover(optionLiteral: 'option', optionName: "position"): string; /** @@ -69667,12 +69758,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igPopover(optionLiteral: 'option', optionName: "position", optionValue: string): void; /** * Defines width for the popover. leave null for auto. * */ + igPopover(optionLiteral: 'option', optionName: "width"): number|string; /** @@ -69681,12 +69774,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igPopover(optionLiteral: 'option', optionName: "width", optionValue: number|string): void; /** * Defines height for the popover. leave null for auto * */ + igPopover(optionLiteral: 'option', optionName: "height"): number|string; /** @@ -69695,12 +69790,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igPopover(optionLiteral: 'option', optionName: "height", optionValue: number|string): void; /** * Defines width the popover won't go under the value even if no specific one is set. * */ + igPopover(optionLiteral: 'option', optionName: "minWidth"): number|string; /** @@ -69709,12 +69806,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igPopover(optionLiteral: 'option', optionName: "minWidth", optionValue: number|string): void; /** * Defines width the popover won't exceed even if no specific one is set. * */ + igPopover(optionLiteral: 'option', optionName: "maxWidth"): number|string; /** @@ -69723,12 +69822,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igPopover(optionLiteral: 'option', optionName: "maxWidth", optionValue: number|string): void; /** * Defines height the popover won't exceed even if no specific one is set. * */ + igPopover(optionLiteral: 'option', optionName: "maxHeight"): number|string; /** @@ -69737,6 +69838,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igPopover(optionLiteral: 'option', optionName: "maxHeight", optionValue: number|string): void; /** @@ -69757,6 +69859,7 @@ interface JQuery { * The content for the popover container. If left null the content will be get from the target. * */ + igPopover(optionLiteral: 'option', optionName: "contentTemplate"): string|Function; /** @@ -69765,6 +69868,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igPopover(optionLiteral: 'option', optionName: "contentTemplate", optionValue: string|Function): void; /** @@ -69799,6 +69903,7 @@ interface JQuery { * The event on which the popover will be shown. Predefined values are "mouseenter", "click" and "focus" * */ + igPopover(optionLiteral: 'option', optionName: "showOn"): string; /** @@ -69807,6 +69912,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igPopover(optionLiteral: 'option', optionName: "showOn", optionValue: string): void; /** @@ -69827,6 +69933,7 @@ interface JQuery { * Controls where the popover DOM should be attached to. * */ + igPopover(optionLiteral: 'option', optionName: "appendTo"): string|Object; /** @@ -69835,6 +69942,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igPopover(optionLiteral: 'option', optionName: "appendTo", optionValue: string|Object): void; /** @@ -70499,6 +70607,7 @@ interface JQuery { /** * The width of the gauge. It can be set as a number in pixels, string (px) or percentage (%). */ + igRadialGauge(optionLiteral: 'option', optionName: "width"): string|number; /** @@ -70506,11 +70615,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igRadialGauge(optionLiteral: 'option', optionName: "width", optionValue: string|number): void; /** * The height of the gauge. It can be set as a number in pixels, string (px) or percentage (%). */ + igRadialGauge(optionLiteral: 'option', optionName: "height"): string|number; /** @@ -70518,6 +70629,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igRadialGauge(optionLiteral: 'option', optionName: "height", optionValue: string|number): void; /** @@ -70659,6 +70771,7 @@ interface JQuery { /** * Gets the direction in which the scale sweeps around the center from the start angle to end angle. */ + igRadialGauge(optionLiteral: 'option', optionName: "scaleSweepDirection"): string; /** @@ -70666,6 +70779,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igRadialGauge(optionLiteral: 'option', optionName: "scaleSweepDirection", optionValue: string): void; /** @@ -70747,6 +70861,7 @@ interface JQuery { /** * Gets the shape to use when rendering the needle from a number of options. */ + igRadialGauge(optionLiteral: 'option', optionName: "needleShape"): string; /** @@ -70754,6 +70869,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igRadialGauge(optionLiteral: 'option', optionName: "needleShape", optionValue: string): void; /** @@ -70869,6 +70985,7 @@ interface JQuery { /** * Gets the shape to use for the needle cap. */ + igRadialGauge(optionLiteral: 'option', optionName: "needlePivotShape"): string; /** @@ -70876,6 +70993,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igRadialGauge(optionLiteral: 'option', optionName: "needlePivotShape", optionValue: string): void; /** @@ -71195,6 +71313,7 @@ interface JQuery { /** * Gets the oversweep shape to use for the excess fill area for the scale. */ + igRadialGauge(optionLiteral: 'option', optionName: "scaleOversweepShape"): string; /** @@ -71202,6 +71321,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igRadialGauge(optionLiteral: 'option', optionName: "scaleOversweepShape", optionValue: string): void; /** @@ -71231,6 +71351,7 @@ interface JQuery { /** * Gets the type of shape to use for the backing of the gauge. */ + igRadialGauge(optionLiteral: 'option', optionName: "backingShape"): string; /** @@ -71238,6 +71359,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igRadialGauge(optionLiteral: 'option', optionName: "backingShape", optionValue: string): void; /** @@ -71259,6 +71381,7 @@ interface JQuery { /** * Gets the strategy to use for omitting labels if the first and last label have the same value. */ + igRadialGauge(optionLiteral: 'option', optionName: "duplicateLabelOmissionStrategy"): string; /** @@ -71266,6 +71389,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igRadialGauge(optionLiteral: 'option', optionName: "duplicateLabelOmissionStrategy", optionValue: string): void; /** @@ -72258,13 +72382,7 @@ interface JQuery { * @optionValue New value to be set. */ igRadialMenu(optionLiteral: 'option', optionName: "wedgePaddingInDegrees", optionValue: number): void; - - /** - */ igRadialMenu(optionLiteral: 'option', optionName: "pixelScalingRatio"): number; - - /** - */ igRadialMenu(optionLiteral: 'option', optionName: "pixelScalingRatio", optionValue: number): void; /** @@ -72489,7 +72607,7 @@ interface IgRatingMethods { /** * Gets reference to [igValidator](ui.igvalidator) used by igRating. * - * @param destroy Request to destroy validator. + * @param destroy Request to destroy validator. */ validator(destroy?: boolean): Object; @@ -72501,16 +72619,16 @@ interface IgRatingMethods { /** * Gets/Sets (selected) value. * - * @param val New value which is rendered with selected css. - * @return number|object If parameter is not 'number', then exact value rendered with selected css is returned. Otherwise, reference to igRating is returned. + * @param val New value which is rendered with selected css. + * @return number|object If parameter is not 'number', then exact value rendered with selected css is returned. Otherwise, reference to igRating is returned. */ value(val: number): number|Object; /** * Gets/Sets hover value. * - * @param val New value which will be rendered with hover css when rating gets mouse. - * @return number|object If parameter is not "number", then last value which was rendered with hover css is returned. Otherwise, reference to igRating is returned. + * @param val New value which will be rendered with hover css when rating gets mouse. + * @return number|object If parameter is not "number", then last value which was rendered with hover css is returned. Otherwise, reference to igRating is returned. */ valueHover(val?: number): number|Object; @@ -72562,6 +72680,7 @@ interface JQuery { * Gets/Sets value (selected votes or percent). If the value is of type string, it should be suitable for parsing to number. According to [valueAsPercent](ui.igrating#options:valueAsPercent) options the value is used as number of selected votes or as a percent of the votes. * */ + igRating(optionLiteral: 'option', optionName: "value"): number|string; /** @@ -72570,12 +72689,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igRating(optionLiteral: 'option', optionName: "value", optionValue: number|string): void; /** * Gets/Sets value-hover (hovered votes or percent of hovered votes). The default is same as value. If the value is of type string, it should be suitable for parsing to number. According to [valueAsPercent](ui.igrating#options:valueAsPercent) options the valueHover is used as number of hovered votes or as a percent of the hovered votes. * */ + igRating(optionLiteral: 'option', optionName: "valueHover"): number|string; /** @@ -72584,6 +72705,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igRating(optionLiteral: 'option', optionName: "valueHover", optionValue: number|string): void; /** @@ -72686,6 +72808,7 @@ interface JQuery { * Gets/Sets precision. Precision of value and valueHover. * */ + igRating(optionLiteral: 'option', optionName: "precision"): string; /** @@ -72694,6 +72817,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igRating(optionLiteral: 'option', optionName: "precision", optionValue: string): void; /** @@ -73444,15 +73568,15 @@ interface IgSchedulerMethods { /** * Deletes appointment from the appointment collection * - * @param appointment appointment + * @param appointment appointment */ deleteAppointment(appointment: Object): Object; /** * Deletes appointment from the appointment collection * - * @param appointment appointment - * @param updateAppoinment updateAppoinment + * @param appointment appointment + * @param updateAppoinment updateAppoinment */ editAppointment(appointment: Object, updateAppoinment: Object): Object; @@ -73520,6 +73644,7 @@ interface JQuery { * Gets/Sets current view mode in the Scheduler. If this options is not defined, then the first defined view in the views property is taken. * */ + igScheduler(optionLiteral: 'option', optionName: "viewMode"): string; /** @@ -73528,6 +73653,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igScheduler(optionLiteral: 'option', optionName: "viewMode", optionValue: string): void; /** @@ -73548,6 +73674,7 @@ interface JQuery { * Gets/Sets the width of the control. * */ + igScheduler(optionLiteral: 'option', optionName: "width"): string|number; /** @@ -73556,12 +73683,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igScheduler(optionLiteral: 'option', optionName: "width", optionValue: string|number): void; /** * Gets/Sets the height of the control. * */ + igScheduler(optionLiteral: 'option', optionName: "height"): string|number; /** @@ -73570,6 +73699,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igScheduler(optionLiteral: 'option', optionName: "height", optionValue: string|number): void; /** @@ -73852,6 +73982,35 @@ interface ScrollingEvent { } interface ScrollingEventUIParam { + /** + * Gets a reference to the igScroll. + */ + owner?: any; + + /** + * Gets if the content is scrolled by the arrows. 0 - none used, -1 - Arrow Up/Left, 1 - Arrow Down/Right. + */ + smallIncrement?: number; + + /** + * Gets if the content is scrolled by the scrollbar track areas. 0 - none used, -1 - Scrolled Up/Left, 1 - Scrolled Down/Right. + */ + bigIncrement?: number; + + /** + * Gets which axis is being used to scroll - horizontal(true) or vertical(false). + */ + horizontal?: boolean; + + /** + * Gets how much the content will be scrolled horizontally. + */ + stepX?: number; + + /** + * Gets how much the content will be scrolled vertically. + */ + stepY?: number; } interface ScrolledEvent { @@ -73859,6 +74018,25 @@ interface ScrolledEvent { } interface ScrolledEventUIParam { + /** + * Gets a reference to the igScroll. + */ + owner?: any; + + /** + * Gets if the content is scrolled by the arrows. 0 - none used, -1 - Arrow Up/Left, 1 - Arrow Down/Right. + */ + smallIncrement?: number; + + /** + * Gets if the content is scrolled by the scrollbar track areas. 0 - none used, -1 - Scrolled Up/Left, 1 - Scrolled Down/Right. + */ + bigIncrement?: number; + + /** + * Gets which axis is being used to scroll - horizontal(true) or vertical(false). + */ + horizontal?: boolean; } interface ThumbDragStartEvent { @@ -73866,6 +74044,15 @@ interface ThumbDragStartEvent { } interface ThumbDragStartEventUIParam { + /** + * Gets a reference to the igScroll. + */ + owner?: any; + + /** + * Gets which axis is being used to scroll - horizontal(true) or vertical(false). + */ + horizontal?: boolean; } interface ThumbDragMoveEvent { @@ -73873,6 +74060,25 @@ interface ThumbDragMoveEvent { } interface ThumbDragMoveEventUIParam { + /** + * Gets a reference to the igScroll. + */ + owner?: any; + + /** + * Gets which scrollbar thumb is being used - horizontal(true) or vertical(false). + */ + horizontal?: boolean; + + /** + * Gets how much the content will be scrolled horizontally. + */ + stepX?: number; + + /** + * Gets how much the content will be scrolled vertically. + */ + stepY?: number; } interface ThumbDragEndEvent { @@ -73880,6 +74086,15 @@ interface ThumbDragEndEvent { } interface ThumbDragEndEventUIParam { + /** + * Gets a reference to the igScroll. + */ + owner?: any; + + /** + * Gets which scrollbar thumb is being used - horizontal(true) or vertical(false). + */ + horizontal?: boolean; } interface ResizingEvent { @@ -74150,6 +74365,7 @@ interface JQuery { * Sets or gets what type of scrollbars should be using the igScroll (on all environments). * */ + igScroll(optionLiteral: 'option', optionName: "scrollbarType"): string; /** @@ -74158,6 +74374,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igScroll(optionLiteral: 'option', optionName: "scrollbarType", optionValue: string): void; /** @@ -74663,43 +74880,37 @@ interface StartEvent { (event: Event, ui: StartEventUIParam): void; } -interface StartEventUIParam { -} +interface StartEventUIParam {} interface SlideEvent { (event: Event, ui: SlideEventUIParam): void; } -interface SlideEventUIParam { -} +interface SlideEventUIParam {} interface StopEvent { (event: Event, ui: StopEventUIParam): void; } -interface StopEventUIParam { -} +interface StopEventUIParam {} interface ChangeEvent { (event: Event, ui: ChangeEventUIParam): void; } -interface ChangeEventUIParam { -} +interface ChangeEventUIParam {} interface BookmarkHitEvent { (event: Event, ui: BookmarkHitEventUIParam): void; } -interface BookmarkHitEventUIParam { -} +interface BookmarkHitEventUIParam {} interface BookmarkClickEvent { (event: Event, ui: BookmarkClickEventUIParam): void; } -interface BookmarkClickEventUIParam { -} +interface BookmarkClickEventUIParam {} interface IgSlider { /** @@ -74890,8 +75101,7 @@ interface CaptureEvent { (event: Event, ui: CaptureEventUIParam): void; } -interface CaptureEventUIParam { -} +interface CaptureEventUIParam {} interface MouseWrapper { cancel?: string; @@ -74944,17 +75154,17 @@ interface IgResponsiveContainerMethods { /** * Removes a callback from the callbacks collection. * - * @param callbackId The callback id to remove. + * @param callbackId The callback id to remove. */ removeCallback(callbackId: number): void; /** * Adds a callback to the callback collection. * - * @param callback The function to call when requirements are met. - * @param owner The owner object of the function. - * @param reactionStep The sensitivity of the size change recognition. - * @param reactionDirection The dimensions the changes of which to be traced. + * @param callback The function to call when requirements are met. + * @param owner The owner object of the function. + * @param reactionStep The sensitivity of the size change recognition. + * @param reactionDirection The dimensions the changes of which to be traced. */ addCallback(callback: Function, owner: Object, reactionStep: number, reactionDirection: Object): void; } @@ -74969,21 +75179,9 @@ interface JQuery { igLoading(methodName: "hide"): void; igLoading(methodName: "refreshPos"): void; igLoading(methodName: "destroy"): void; - - /** - */ igLoading(optionLiteral: 'option', optionName: "cssClass"): any; - - /** - */ igLoading(optionLiteral: 'option', optionName: "cssClass", optionValue: any): void; - - /** - */ igLoading(optionLiteral: 'option', optionName: "includeVerticalOffset"): boolean; - - /** - */ igLoading(optionLiteral: 'option', optionName: "includeVerticalOffset", optionValue: boolean): void; igLoading(options: IgLoading): JQuery; igLoading(optionLiteral: 'option', optionName: string): any; @@ -75186,77 +75384,23 @@ interface JQuery { igProgressBar(methodName: "widget"): void; igProgressBar(methodName: "destroy"): void; igProgressBar(methodName: "value", newValue: Object): void; - - /** - */ igProgressBar(optionLiteral: 'option', optionName: "animate"): boolean; - - /** - */ igProgressBar(optionLiteral: 'option', optionName: "animate", optionValue: boolean): void; - - /** - */ igProgressBar(optionLiteral: 'option', optionName: "animateTimeout"): number; - - /** - */ igProgressBar(optionLiteral: 'option', optionName: "animateTimeout", optionValue: number): void; - - /** - */ igProgressBar(optionLiteral: 'option', optionName: "max"): number; - - /** - */ igProgressBar(optionLiteral: 'option', optionName: "max", optionValue: number): void; - - /** - */ igProgressBar(optionLiteral: 'option', optionName: "min"): number; - - /** - */ igProgressBar(optionLiteral: 'option', optionName: "min", optionValue: number): void; - - /** - */ igProgressBar(optionLiteral: 'option', optionName: "orientation"): string; - - /** - */ igProgressBar(optionLiteral: 'option', optionName: "orientation", optionValue: string): void; - - /** - */ igProgressBar(optionLiteral: 'option', optionName: "value"): number; - - /** - */ igProgressBar(optionLiteral: 'option', optionName: "value", optionValue: number): void; - - /** - */ igProgressBar(optionLiteral: 'option', optionName: "width"): string; - - /** - */ igProgressBar(optionLiteral: 'option', optionName: "width", optionValue: string): void; - - /** - */ igProgressBar(optionLiteral: 'option', optionName: "height"): string; - - /** - */ igProgressBar(optionLiteral: 'option', optionName: "height", optionValue: string): void; - - /** - */ igProgressBar(optionLiteral: 'option', optionName: "range"): boolean; - - /** - */ igProgressBar(optionLiteral: 'option', optionName: "range", optionValue: boolean): void; /** @@ -75270,21 +75414,9 @@ interface JQuery { * @optionValue New value to be set. */ igProgressBar(optionLiteral: 'option', optionName: "queue", optionValue: boolean): void; - - /** - */ igProgressBar(optionLiteral: 'option', optionName: "endValue"): number; - - /** - */ igProgressBar(optionLiteral: 'option', optionName: "endValue", optionValue: number): void; - - /** - */ igProgressBar(optionLiteral: 'option', optionName: "change"): ChangeEvent; - - /** - */ igProgressBar(optionLiteral: 'option', optionName: "change", optionValue: ChangeEvent): void; igProgressBar(options: IgProgressBar): JQuery; igProgressBar(optionLiteral: 'option', optionName: string): any; @@ -75296,77 +75428,23 @@ interface JQuery { igButton(methodName: "setTitle", title: Object): void; igButton(methodName: "widget"): void; igButton(methodName: "destroy"): void; - - /** - */ igButton(optionLiteral: 'option', optionName: "width"): any; - - /** - */ igButton(optionLiteral: 'option', optionName: "width", optionValue: any): void; - - /** - */ igButton(optionLiteral: 'option', optionName: "height"): any; - - /** - */ igButton(optionLiteral: 'option', optionName: "height", optionValue: any): void; - - /** - */ igButton(optionLiteral: 'option', optionName: "link"): IgButtonLink; - - /** - */ igButton(optionLiteral: 'option', optionName: "link", optionValue: IgButtonLink): void; - - /** - */ igButton(optionLiteral: 'option', optionName: "labelText"): string; - - /** - */ igButton(optionLiteral: 'option', optionName: "labelText", optionValue: string): void; - - /** - */ igButton(optionLiteral: 'option', optionName: "centerLabel"): boolean; - - /** - */ igButton(optionLiteral: 'option', optionName: "centerLabel", optionValue: boolean): void; - - /** - */ igButton(optionLiteral: 'option', optionName: "css"): any; - - /** - */ igButton(optionLiteral: 'option', optionName: "css", optionValue: any): void; - - /** - */ igButton(optionLiteral: 'option', optionName: "onlyIcons"): boolean; - - /** - */ igButton(optionLiteral: 'option', optionName: "onlyIcons", optionValue: boolean): void; - - /** - */ igButton(optionLiteral: 'option', optionName: "icons"): IgButtonIcons; - - /** - */ igButton(optionLiteral: 'option', optionName: "icons", optionValue: IgButtonIcons): void; - - /** - */ igButton(optionLiteral: 'option', optionName: "title"): boolean; - - /** - */ igButton(optionLiteral: 'option', optionName: "title", optionValue: boolean): void; igButton(options: IgButton): JQuery; igButton(optionLiteral: 'option', optionName: string): any; @@ -75376,21 +75454,9 @@ interface JQuery { } interface JQuery { igTooltip(methodName: "destroy"): void; - - /** - */ igTooltip(optionLiteral: 'option', optionName: "text"): string; - - /** - */ igTooltip(optionLiteral: 'option', optionName: "text", optionValue: string): void; - - /** - */ igTooltip(optionLiteral: 'option', optionName: "arrowLocation"): string; - - /** - */ igTooltip(optionLiteral: 'option', optionName: "arrowLocation", optionValue: string): void; igTooltip(options: IgTooltip): JQuery; igTooltip(optionLiteral: 'option', optionName: string): any; @@ -75400,61 +75466,19 @@ interface JQuery { } interface JQuery { mouseWrapper(methodName: "destroy"): void; - - /** - */ mouseWrapper(optionLiteral: 'option', optionName: "cancel"): string; - - /** - */ mouseWrapper(optionLiteral: 'option', optionName: "cancel", optionValue: string): void; - - /** - */ mouseWrapper(optionLiteral: 'option', optionName: "distance"): number; - - /** - */ mouseWrapper(optionLiteral: 'option', optionName: "distance", optionValue: number): void; - - /** - */ mouseWrapper(optionLiteral: 'option', optionName: "delay"): number; - - /** - */ mouseWrapper(optionLiteral: 'option', optionName: "delay", optionValue: number): void; - - /** - */ mouseWrapper(optionLiteral: 'option', optionName: "start"): StartEvent; - - /** - */ mouseWrapper(optionLiteral: 'option', optionName: "start", optionValue: StartEvent): void; - - /** - */ mouseWrapper(optionLiteral: 'option', optionName: "drag"): DragEvent; - - /** - */ mouseWrapper(optionLiteral: 'option', optionName: "drag", optionValue: DragEvent): void; - - /** - */ mouseWrapper(optionLiteral: 'option', optionName: "stop"): StopEvent; - - /** - */ mouseWrapper(optionLiteral: 'option', optionName: "stop", optionValue: StopEvent): void; - - /** - */ mouseWrapper(optionLiteral: 'option', optionName: "capture"): CaptureEvent; - - /** - */ mouseWrapper(optionLiteral: 'option', optionName: "capture", optionValue: CaptureEvent): void; mouseWrapper(options: MouseWrapper): JQuery; mouseWrapper(optionLiteral: 'option', optionName: string): any; @@ -75862,14 +75886,14 @@ interface IgSparklineMethods { /** * Find index of item within actual data used by chart. * - * @param item The reference to item. + * @param item The reference to item. */ findIndexOfItem(item: Object): number; /** * Get item within actual data used by chart. That is similar to this.getData()[ index ]. * - * @param index Index of data item. + * @param index Index of data item. */ getDataItem(index: Object): Object; @@ -75881,40 +75905,40 @@ interface IgSparklineMethods { /** * Adds a new item to the data source and notifies the chart. * - * @param item The item that we want to add to the data source. + * @param item The item that we want to add to the data source. */ addItem(item: Object): Object; /** * Inserts a new item to the data source and notifies the chart. * - * @param item the new item that we want to insert in the data source. - * @param index The index in the data source where the new item will be inserted. + * @param item the new item that we want to insert in the data source. + * @param index The index in the data source where the new item will be inserted. */ insertItem(item: Object, index: number): Object; /** * Deletes an item from the data source and notifies the chart. * - * @param index The index in the data source from where the item will be been removed. + * @param index The index in the data source from where the item will be been removed. */ removeItem(index: number): Object; /** * Updates an item in the data source and notifies the chart. * - * @param index The index of the item in the data source that we want to change. - * @param item The new item object that will be set in the data source. + * @param index The index of the item in the data source that we want to change. + * @param item The new item object that will be set in the data source. */ setItem(index: number, item: Object): Object; /** * Notifies the chart that an item has been set in an associated data source. * - * @param dataSource The data source in which the change happened. - * @param index The index in the items source that has been changed. - * @param newItem the new item that has been set in the collection. - * @param oldItem the old item that has been overwritten in the collection. + * @param dataSource The data source in which the change happened. + * @param index The index in the items source that has been changed. + * @param newItem the new item that has been set in the collection. + * @param oldItem the old item that has been overwritten in the collection. */ notifySetItem(dataSource: Object, index: number, newItem: Object, oldItem: Object): Object; @@ -75922,7 +75946,7 @@ interface IgSparklineMethods { * Notifies the chart that the items have been cleared from an associated data source. * It's not necessary to notify more than one target of a change if they share the same items source. * - * @param dataSource The data source in which the change happened. + * @param dataSource The data source in which the change happened. */ notifyClearItems(dataSource: Object): Object; @@ -75930,9 +75954,9 @@ interface IgSparklineMethods { * Notifies the target axis or series that an item has been inserted at the specified index in its data source. * It's not necessary to notify more than one target of a change if they share the same items source. * - * @param dataSource The data source in which the change happened. - * @param index The index in the items source where the new item has been inserted. - * @param newItem the new item that has been set in the collection. + * @param dataSource The data source in which the change happened. + * @param index The index in the items source where the new item has been inserted. + * @param newItem the new item that has been set in the collection. */ notifyInsertItem(dataSource: Object, index: number, newItem: Object): Object; @@ -75940,9 +75964,9 @@ interface IgSparklineMethods { * Notifies the target axis or series that an item has been removed from the specified index in its data source. * It's not necessary to notify more than one target of a change if they share the same items source. * - * @param dataSource The data source in which the change happened. - * @param index The index in the items source from where the old item has been removed. - * @param oldItem the old item that has been removed from the collection. + * @param dataSource The data source in which the change happened. + * @param index The index in the items source from where the old item has been removed. + * @param oldItem the old item that has been removed from the collection. */ notifyRemoveItem(dataSource: Object, index: number, oldItem: Object): Object; @@ -75985,6 +76009,7 @@ interface JQuery { /** * The width of the sparkline. It can be set as a number in pixels, string (px) or percentage (%). */ + igSparkline(optionLiteral: 'option', optionName: "width"): string|number; /** @@ -75992,11 +76017,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igSparkline(optionLiteral: 'option', optionName: "width", optionValue: string|number): void; /** * The height of the sparkline. It can be set as a number in pixels, string (px) or percentage (%). */ + igSparkline(optionLiteral: 'option', optionName: "height"): string|number; /** @@ -76004,6 +76031,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igSparkline(optionLiteral: 'option', optionName: "height", optionValue: string|number): void; /** @@ -76153,6 +76181,7 @@ interface JQuery { /** * Gets the display state of the horizontal axis. */ + igSparkline(optionLiteral: 'option', optionName: "horizontalAxisVisibility"): string; /** @@ -76160,11 +76189,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igSparkline(optionLiteral: 'option', optionName: "horizontalAxisVisibility", optionValue: string): void; /** * Gets the display state of the vertical axis. */ + igSparkline(optionLiteral: 'option', optionName: "verticalAxisVisibility"): string; /** @@ -76172,11 +76203,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igSparkline(optionLiteral: 'option', optionName: "verticalAxisVisibility", optionValue: string): void; /** * Gets the marker visibility of the sparkline. */ + igSparkline(optionLiteral: 'option', optionName: "markerVisibility"): string; /** @@ -76184,11 +76217,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igSparkline(optionLiteral: 'option', optionName: "markerVisibility", optionValue: string): void; /** * Gets the negative marker visibility of the sparkline. */ + igSparkline(optionLiteral: 'option', optionName: "negativeMarkerVisibility"): string; /** @@ -76196,11 +76231,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igSparkline(optionLiteral: 'option', optionName: "negativeMarkerVisibility", optionValue: string): void; /** * Gets the first marker visibility of the sparkline. */ + igSparkline(optionLiteral: 'option', optionName: "firstMarkerVisibility"): string; /** @@ -76208,11 +76245,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igSparkline(optionLiteral: 'option', optionName: "firstMarkerVisibility", optionValue: string): void; /** * Gets the last marker visibility of the sparkline. */ + igSparkline(optionLiteral: 'option', optionName: "lastMarkerVisibility"): string; /** @@ -76220,11 +76259,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igSparkline(optionLiteral: 'option', optionName: "lastMarkerVisibility", optionValue: string): void; /** * Gets the low marker visibility of the sparkline. */ + igSparkline(optionLiteral: 'option', optionName: "lowMarkerVisibility"): string; /** @@ -76232,11 +76273,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igSparkline(optionLiteral: 'option', optionName: "lowMarkerVisibility", optionValue: string): void; /** * Gets the high marker visibility of the sparkline. */ + igSparkline(optionLiteral: 'option', optionName: "highMarkerVisibility"): string; /** @@ -76244,11 +76287,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igSparkline(optionLiteral: 'option', optionName: "highMarkerVisibility", optionValue: string): void; /** * Gets the normal range visibility of the sparkline. */ + igSparkline(optionLiteral: 'option', optionName: "normalRangeVisibility"): string; /** @@ -76256,6 +76301,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igSparkline(optionLiteral: 'option', optionName: "normalRangeVisibility", optionValue: string): void; /** @@ -76381,6 +76427,7 @@ interface JQuery { /** * Gets the type of trendline used by the sparkline. */ + igSparkline(optionLiteral: 'option', optionName: "trendLineType"): string; /** @@ -76388,6 +76435,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igSparkline(optionLiteral: 'option', optionName: "trendLineType", optionValue: string): void; /** @@ -76441,6 +76489,7 @@ interface JQuery { /** * Gets the display type of the sparkline. */ + igSparkline(optionLiteral: 'option', optionName: "displayType"): string; /** @@ -76448,11 +76497,13 @@ interface JQuery { * * @optionValue New value to be set. */ + igSparkline(optionLiteral: 'option', optionName: "displayType", optionValue: string): void; /** * Gets the way null values are interpreted. */ + igSparkline(optionLiteral: 'option', optionName: "unknownValuePlotting"): string; /** @@ -76460,6 +76511,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igSparkline(optionLiteral: 'option', optionName: "unknownValuePlotting", optionValue: string): void; /** @@ -77241,6 +77293,7 @@ interface JQuery { * Gets/Sets the width of the container. * */ + igSplitter(optionLiteral: 'option', optionName: "width"): string|number; /** @@ -77249,12 +77302,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igSplitter(optionLiteral: 'option', optionName: "width", optionValue: string|number): void; /** * Gets/Sets the height of the container. * */ + igSplitter(optionLiteral: 'option', optionName: "height"): string|number; /** @@ -77263,12 +77318,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igSplitter(optionLiteral: 'option', optionName: "height", optionValue: string|number): void; /** * Gets the orientation of the splitter. * */ + igSplitter(optionLiteral: 'option', optionName: "orientation"): string; /** @@ -77277,6 +77334,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igSplitter(optionLiteral: 'option', optionName: "orientation", optionValue: string): void; /** @@ -77518,111 +77576,6 @@ interface ActiveWorksheetChangedEventUIParam { newActiveWorksheetName?: string; } -interface EditModeExitingEvent { - (event: Event, ui: EditModeExitingEventUIParam): void; -} - -interface EditModeExitingEventUIParam { - /** - * Gets a reference to the spreadsheet widget. - */ - owner?: any; - - /** - * Get or set a boolean indicating whether the changes will be made to the cell's value when edit mode ends. - */ - acceptChanges?: boolean; - - /** - * Get a boolean indicating if the edit mode is being forced to exit edit mode in which case it cannot be cancelled. - */ - canCancel?: boolean; - - /** - * Gets the cell for which the control is exiting edit mode. - */ - cell?: string; -} - -interface EditModeExitedEvent { - (event: Event, ui: EditModeExitedEventUIParam): void; -} - -interface EditModeExitedEventUIParam { - /** - * Gets a reference to the spreadsheet widget. - */ - owner?: any; - - /** - * Gets the cell for which the control has exited edit mode. - */ - cell?: string; -} - -interface EditModeEnteringEvent { - (event: Event, ui: EditModeEnteringEventUIParam): void; -} - -interface EditModeEnteringEventUIParam { - /** - * Gets a reference to the spreadsheet widget. - */ - owner?: any; - - /** - * Gets the cell for which the control is going into edit mode. - */ - cell?: string; -} - -interface EditModeEnteredEvent { - (event: Event, ui: EditModeEnteredEventUIParam): void; -} - -interface EditModeEnteredEventUIParam { - /** - * Gets a reference to the spreadsheet widget. - */ - owner?: any; - - /** - * Gets the cell for which the control has entered edit mode. - */ - cell?: string; -} - -interface EditModeValidationErrorEvent { - (event: Event, ui: EditModeValidationErrorEventUIParam): void; -} - -interface EditModeValidationErrorEventUIParam { - /** - * Gets a reference to the spreadsheet widget. - */ - owner?: any; - - /** - * Get or set the [action](ig.spreadsheet.SpreadsheetEditModeValidationErrorAction) to take in response to the failed validation. - */ - action?: string; - - /** - * Get a boolean indicating whether the cell is allowed to stay in edit mode. - */ - canStayInEditMode?: boolean; - - /** - * Gets the cell for which the control is in edit mode. - */ - cell?: string; - - /** - * Get the [rule](ig.excel.DataValidationRule) which failed validation. - */ - validationRule?: string; -} - interface EditRangePasswordNeededEvent { (event: Event, ui: EditRangePasswordNeededEventUIParam): void; } @@ -77779,7 +77732,6 @@ interface IgSpreadsheet { * navigated when Shift + Enter are pressed. * * - * * Valid values: * "down" The cell below should be activated. * "right" The cell to the right should be activated @@ -77788,24 +77740,12 @@ interface IgSpreadsheet { */ enterKeyNavigationDirection?: string; - /** - * Returns or sets the number of decimal places by which a whole number typed in during edit mode should be adjusted when isFixedDecimalEnabled is true - * - */ - fixedDecimalPlaceCount?: number; - /** * Returns or sets a boolean indicating whether the adjacent cell indicated by the enterKeyNavigationDirection should be navigated to when the enter key is pressed. * */ isEnterKeyNavigationEnabled?: boolean; - /** - * Returns or sets a boolean indicating whether a fixed decimal place is automatically added when a whole number is entered while in edit mode. - * - */ - isFixedDecimalEnabled?: boolean; - /** * Returns or sets a boolean indicating if the formula bar is displayed within the Spreadsheet. * @@ -77895,35 +77835,6 @@ interface IgSpreadsheet { */ activeWorksheetChanged?: ActiveWorksheetChangedEvent; - /** - * Invoked when the Spreadsheet is about to end the in-place editing of the activeCell. - */ - editModeExiting?: EditModeExitingEvent; - - /** - * Invoked when the Spreadsheet has ended the in-place editing of the activeCell. - */ - editModeExited?: EditModeExitedEvent; - - /** - * Invoked when the Spreadsheet is about to start in-place editing of the activeCell. - */ - editModeEntering?: EditModeEnteringEvent; - - /** - * Invoked when the Spreadsheet has started in-place editing of the activeCell. - */ - editModeEntered?: EditModeEnteredEvent; - - /** - * Invoked when the Spreadsheet is exiting edit mode and the new value for the activeCell is not valid based on the criteria of that cell's ig.excel.DataValidationRule. - * The EditModeValidationError is raised while exiting edit mode if the new value for the activeCell is not valid based on the criteria of that cell's ig.excel.DataValidationRule. - * Since the rule needs to evaluate the value of the cell and potentially other cell's in the Worksheet, the value is first applied to the cell(s) and then is validated. By default if the event is not handled and the - * showErrorMessageForInvalidValue is true, a message box will be displayed to the end user to determine what action to take. One can handle this event and specify the action that should - * be taken using the action.Note: The validation rule will not be evaluated if edit mode is being cancelled such as when the user presses Escape to cancel edit.Note: The action will default to AcceptChange if the ShowErrorMessageForInvalidValue of the validationRule is false; otherwise it will default to ShowPrompt.Note: Like Microsoft Excel, only the validation rule of the active cell is considered even if the update is affecting other cells in the selection. - */ - editModeValidationError?: EditModeValidationErrorEvent; - /** * Invoked when the Spreadsheet is performing an operation on a protected Worksheet and there is a single range that may be unlocked to allow the operation to be performed. */ @@ -77971,23 +77882,13 @@ interface IgSpreadsheetMethods { /** * Returns an object used to get the formatting of the activeCell and where modifications are applied to the entire active selection. - * Any changes made to this object will affect all the objects in the selection. So for example, the - * Font.Name may return "Arial" because the active cell has that as its resolved font name even though the other - * cells are using a different font but if you set the Font.Name of this object to "Arial" then all the objects - * affected by the selection will have their Font.Name updated to that value. + * Any changes made to this object will affect all the objects in the selection. So for example, the + * Font.Name may return "Arial" because the active cell has that as its resolved font name even though the other + * cells are using a different font but if you set the Font.Name of this object to "Arial" then all the objects + * affected by the selection will have their Font.Name updated to that value. */ getActiveSelectionCellRangeFormat(): Object; - /** - * Returns an enumeration used to indicate the current edit mode state. - */ - getCellEditMode(): Object; - - /** - * Returns a boolean indicating if the control is currently editing the value of the activeCell. - */ - getIsInEditMode(): boolean; - /** * Returns a boolean indicating if the user is currently editing the name of the active worksheet. */ @@ -78030,8 +77931,6 @@ interface JQuery { igSpreadsheet(methodName: "getActivePane"): Object; igSpreadsheet(methodName: "getActiveSelection"): Object; igSpreadsheet(methodName: "getActiveSelectionCellRangeFormat"): Object; - igSpreadsheet(methodName: "getCellEditMode"): Object; - igSpreadsheet(methodName: "getIsInEditMode"): boolean; igSpreadsheet(methodName: "getIsRenamingWorksheet"): boolean; igSpreadsheet(methodName: "getPanes"): void; igSpreadsheet(methodName: "executeAction", action: Object): boolean; @@ -78043,6 +77942,7 @@ interface JQuery { * The width of the spreadsheet. It can be set as a number in pixels, string (px) or percentage (%). * */ + igSpreadsheet(optionLiteral: 'option', optionName: "width"): string|number; /** @@ -78051,12 +77951,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igSpreadsheet(optionLiteral: 'option', optionName: "width", optionValue: string|number): void; /** * The height of the spreadsheet. It can be set as a number in pixels, string (px) or percentage (%). * */ + igSpreadsheet(optionLiteral: 'option', optionName: "height"): string|number; /** @@ -78065,6 +77967,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igSpreadsheet(optionLiteral: 'option', optionName: "height", optionValue: string|number): void; /** @@ -78177,8 +78080,8 @@ interface JQuery { * Returns an enumeration indicating the direction of the cell adjacent to the activeCell that should be activated when the enter key is pressed.This property is only used if the isEnterKeyNavigationEnabled is set to true. Also, the reverse direction is * navigated when Shift + Enter are pressed. * - * */ + igSpreadsheet(optionLiteral: 'option', optionName: "enterKeyNavigationDirection"): string; /** @@ -78186,25 +78089,11 @@ interface JQuery { * navigated when Shift + Enter are pressed. * * - * * @optionValue New value to be set. */ + igSpreadsheet(optionLiteral: 'option', optionName: "enterKeyNavigationDirection", optionValue: string): void; - /** - * Returns the number of decimal places by which a whole number typed in during edit mode should be adjusted when isFixedDecimalEnabled is true - * - */ - igSpreadsheet(optionLiteral: 'option', optionName: "fixedDecimalPlaceCount"): number; - - /** - * Returns or sets the number of decimal places by which a whole number typed in during edit mode should be adjusted when isFixedDecimalEnabled is true - * - * - * @optionValue New value to be set. - */ - igSpreadsheet(optionLiteral: 'option', optionName: "fixedDecimalPlaceCount", optionValue: number): void; - /** * Returns a boolean indicating whether the adjacent cell indicated by the enterKeyNavigationDirection should be navigated to when the enter key is pressed. * @@ -78219,20 +78108,6 @@ interface JQuery { */ igSpreadsheet(optionLiteral: 'option', optionName: "isEnterKeyNavigationEnabled", optionValue: boolean): void; - /** - * Returns a boolean indicating whether a fixed decimal place is automatically added when a whole number is entered while in edit mode. - * - */ - igSpreadsheet(optionLiteral: 'option', optionName: "isFixedDecimalEnabled"): boolean; - - /** - * Returns or sets a boolean indicating whether a fixed decimal place is automatically added when a whole number is entered while in edit mode. - * - * - * @optionValue New value to be set. - */ - igSpreadsheet(optionLiteral: 'option', optionName: "isFixedDecimalEnabled", optionValue: boolean): void; - /** * Returns a boolean indicating if the formula bar is displayed within the Spreadsheet. * @@ -78301,6 +78176,7 @@ interface JQuery { * Returns a value indicating how the selection is updated when interacting with the cells via the mouse or keyboard. * */ + igSpreadsheet(optionLiteral: 'option', optionName: "selectionMode"): string; /** @@ -78309,6 +78185,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igSpreadsheet(optionLiteral: 'option', optionName: "selectionMode", optionValue: string): void; /** @@ -78429,74 +78306,6 @@ interface JQuery { */ igSpreadsheet(optionLiteral: 'option', optionName: "activeWorksheetChanged", optionValue: ActiveWorksheetChangedEvent): void; - /** - * Invoked when the Spreadsheet is about to end the in-place editing of the activeCell. - */ - igSpreadsheet(optionLiteral: 'option', optionName: "editModeExiting"): EditModeExitingEvent; - - /** - * Invoked when the Spreadsheet is about to end the in-place editing of the activeCell. - * - * @optionValue New value to be set. - */ - igSpreadsheet(optionLiteral: 'option', optionName: "editModeExiting", optionValue: EditModeExitingEvent): void; - - /** - * Invoked when the Spreadsheet has ended the in-place editing of the activeCell. - */ - igSpreadsheet(optionLiteral: 'option', optionName: "editModeExited"): EditModeExitedEvent; - - /** - * Invoked when the Spreadsheet has ended the in-place editing of the activeCell. - * - * @optionValue New value to be set. - */ - igSpreadsheet(optionLiteral: 'option', optionName: "editModeExited", optionValue: EditModeExitedEvent): void; - - /** - * Invoked when the Spreadsheet is about to start in-place editing of the activeCell. - */ - igSpreadsheet(optionLiteral: 'option', optionName: "editModeEntering"): EditModeEnteringEvent; - - /** - * Invoked when the Spreadsheet is about to start in-place editing of the activeCell. - * - * @optionValue New value to be set. - */ - igSpreadsheet(optionLiteral: 'option', optionName: "editModeEntering", optionValue: EditModeEnteringEvent): void; - - /** - * Invoked when the Spreadsheet has started in-place editing of the activeCell. - */ - igSpreadsheet(optionLiteral: 'option', optionName: "editModeEntered"): EditModeEnteredEvent; - - /** - * Invoked when the Spreadsheet has started in-place editing of the activeCell. - * - * @optionValue New value to be set. - */ - igSpreadsheet(optionLiteral: 'option', optionName: "editModeEntered", optionValue: EditModeEnteredEvent): void; - - /** - * Invoked when the Spreadsheet is exiting edit mode and the new value for the activeCell is not valid based on the criteria of that cell's ig.excel.DataValidationRule. - * The EditModeValidationError is raised while exiting edit mode if the new value for the activeCell is not valid based on the criteria of that cell's ig.excel.DataValidationRule. - * Since the rule needs to evaluate the value of the cell and potentially other cell's in the Worksheet, the value is first applied to the cell(s) and then is validated. By default if the event is not handled and the - * showErrorMessageForInvalidValue is true, a message box will be displayed to the end user to determine what action to take. One can handle this event and specify the action that should - * be taken using the action.Note: The validation rule will not be evaluated if edit mode is being cancelled such as when the user presses Escape to cancel edit.Note: The action will default to AcceptChange if the ShowErrorMessageForInvalidValue of the validationRule is false; otherwise it will default to ShowPrompt.Note: Like Microsoft Excel, only the validation rule of the active cell is considered even if the update is affecting other cells in the selection. - */ - igSpreadsheet(optionLiteral: 'option', optionName: "editModeValidationError"): EditModeValidationErrorEvent; - - /** - * Invoked when the Spreadsheet is exiting edit mode and the new value for the activeCell is not valid based on the criteria of that cell's ig.excel.DataValidationRule. - * The EditModeValidationError is raised while exiting edit mode if the new value for the activeCell is not valid based on the criteria of that cell's ig.excel.DataValidationRule. - * Since the rule needs to evaluate the value of the cell and potentially other cell's in the Worksheet, the value is first applied to the cell(s) and then is validated. By default if the event is not handled and the - * showErrorMessageForInvalidValue is true, a message box will be displayed to the end user to determine what action to take. One can handle this event and specify the action that should - * be taken using the action.Note: The validation rule will not be evaluated if edit mode is being cancelled such as when the user presses Escape to cancel edit.Note: The action will default to AcceptChange if the ShowErrorMessageForInvalidValue of the validationRule is false; otherwise it will default to ShowPrompt.Note: Like Microsoft Excel, only the validation rule of the active cell is considered even if the update is affecting other cells in the selection. - * - * @optionValue New value to be set. - */ - igSpreadsheet(optionLiteral: 'option', optionName: "editModeValidationError", optionValue: EditModeValidationErrorEvent): void; - /** * Invoked when the Spreadsheet is performing an operation on a protected Worksheet and there is a single range that may be unlocked to allow the operation to be performed. */ @@ -79143,6 +78952,7 @@ interface JQuery { /** * * */ + igTileManager(optionLiteral: 'option', optionName: "width"): string|number; /** @@ -79150,12 +78960,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igTileManager(optionLiteral: 'option', optionName: "width", optionValue: string|number): void; /** * Gets/Sets the height of the container. * */ + igTileManager(optionLiteral: 'option', optionName: "height"): string|number; /** @@ -79164,12 +78976,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igTileManager(optionLiteral: 'option', optionName: "height", optionValue: string|number): void; /** * Gets/Sets the width of each column in the container. * */ + igTileManager(optionLiteral: 'option', optionName: "columnWidth"): string|number; /** @@ -79178,12 +78992,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igTileManager(optionLiteral: 'option', optionName: "columnWidth", optionValue: string|number): void; /** * Gets/Sets the height of each column in the container. * */ + igTileManager(optionLiteral: 'option', optionName: "columnHeight"): string|number; /** @@ -79192,12 +79008,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igTileManager(optionLiteral: 'option', optionName: "columnHeight", optionValue: string|number): void; /** * Gets/Sets the columns count in the container. * */ + igTileManager(optionLiteral: 'option', optionName: "cols"): number; /** @@ -79206,12 +79024,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igTileManager(optionLiteral: 'option', optionName: "cols", optionValue: number): void; /** * Gets/Sets the rows count in the container. * */ + igTileManager(optionLiteral: 'option', optionName: "rows"): number; /** @@ -79220,6 +79040,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTileManager(optionLiteral: 'option', optionName: "rows", optionValue: number): void; /** @@ -79272,6 +79093,7 @@ interface JQuery { * Gets/Sets the tiles configurations. Every tile is described by rowSpan, colSpan, rowIndex and colIndex. * */ + igTileManager(optionLiteral: 'option', optionName: "items"): Object; /** @@ -79280,6 +79102,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTileManager(optionLiteral: 'option', optionName: "items", optionValue: Object): void; /** @@ -79300,6 +79123,7 @@ interface JQuery { * Gets/Sets the content of the tiles in minimized state. * */ + igTileManager(optionLiteral: 'option', optionName: "minimizedState"): string; /** @@ -79308,12 +79132,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igTileManager(optionLiteral: 'option', optionName: "minimizedState", optionValue: string): void; /** * Gets/Sets the content of the tiles in maximized state. * */ + igTileManager(optionLiteral: 'option', optionName: "maximizedState"): string; /** @@ -79322,12 +79148,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igTileManager(optionLiteral: 'option', optionName: "maximizedState", optionValue: string): void; /** * Gets/Sets the index of which items configuration will be used for positioning and sizing of the maximized tile. * */ + igTileManager(optionLiteral: 'option', optionName: "maximizedTileIndex"): number; /** @@ -79336,12 +79164,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igTileManager(optionLiteral: 'option', optionName: "maximizedTileIndex", optionValue: number): void; /** * Gets/Sets how many columns to be displayed in the right panel when the tiles are minimized. * */ + igTileManager(optionLiteral: 'option', optionName: "rightPanelCols"): number; /** @@ -79350,12 +79180,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igTileManager(optionLiteral: 'option', optionName: "rightPanelCols", optionValue: number): void; /** * Gets/Sets the width of the minimized tiles in the right panel. * */ + igTileManager(optionLiteral: 'option', optionName: "rightPanelTilesWidth"): number; /** @@ -79364,12 +79196,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igTileManager(optionLiteral: 'option', optionName: "rightPanelTilesWidth", optionValue: number): void; /** * Gets/Sets the height of the minimized tiles in the right panel. * */ + igTileManager(optionLiteral: 'option', optionName: "rightPanelTilesHeight"): number; /** @@ -79378,6 +79212,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTileManager(optionLiteral: 'option', optionName: "rightPanelTilesHeight", optionValue: number): void; /** @@ -79454,6 +79289,7 @@ interface JQuery { * Property in the response which specifies where the data records array will be held (if the response is wrapped). See [$.ig.DataSource responseDataKey](ig.datasource#options:settings.responseDataKey). * */ + igTileManager(optionLiteral: 'option', optionName: "responseDataKey"): string; /** @@ -79462,12 +79298,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igTileManager(optionLiteral: 'option', optionName: "responseDataKey", optionValue: string): void; /** * Explicitly set data source type (such as "json"). Please refer to the documentation of [$.ig.DataSource type](ig.datasource#options:settings.type) and its type property. * */ + igTileManager(optionLiteral: 'option', optionName: "responseDataType"): string; /** @@ -79476,6 +79314,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTileManager(optionLiteral: 'option', optionName: "responseDataType", optionValue: string): void; /** @@ -79737,64 +79576,55 @@ interface ToolbarButtonClickEvent { (event: Event, ui: ToolbarButtonClickEventUIParam): void; } -interface ToolbarButtonClickEventUIParam { -} +interface ToolbarButtonClickEventUIParam {} interface ToolbarComboOpeningEvent { (event: Event, ui: ToolbarComboOpeningEventUIParam): void; } -interface ToolbarComboOpeningEventUIParam { -} +interface ToolbarComboOpeningEventUIParam {} interface ToolbarComboSelectedEvent { (event: Event, ui: ToolbarComboSelectedEventUIParam): void; } -interface ToolbarComboSelectedEventUIParam { -} +interface ToolbarComboSelectedEventUIParam {} interface ToolbarCustomItemClickEvent { (event: Event, ui: ToolbarCustomItemClickEventUIParam): void; } -interface ToolbarCustomItemClickEventUIParam { -} +interface ToolbarCustomItemClickEventUIParam {} interface ItemRemovedEvent { (event: Event, ui: ItemRemovedEventUIParam): void; } -interface ItemRemovedEventUIParam { -} +interface ItemRemovedEventUIParam {} interface ItemAddedEvent { (event: Event, ui: ItemAddedEventUIParam): void; } -interface ItemAddedEventUIParam { -} +interface ItemAddedEventUIParam {} interface ItemDisableEvent { (event: Event, ui: ItemDisableEventUIParam): void; } -interface ItemDisableEventUIParam { -} +interface ItemDisableEventUIParam {} interface ItemEnabledEvent { (event: Event, ui: ItemEnabledEventUIParam): void; } -interface ItemEnabledEventUIParam { -} +interface ItemEnabledEventUIParam {} interface WindowResizedEvent { (event: Event, ui: WindowResizedEventUIParam): void; } -interface WindowResizedEventUIParam { -} +interface WindowResizedEventUIParam {} interface IgToolbar { /** @@ -80703,7 +80533,6 @@ interface IgTreeDragAndDropSettings { * Gets the containment for the drag helper. The area inside of which thehelper is contained would be scrollable while dragging. * * - * * Valid values: * "boolean" If set to false, then the draggable elements will be contained in their window. * "selector" The draggable element will be contained to the bounding box of the first element found by the selector. If no element is found, no containment will be set. @@ -81423,59 +81252,59 @@ interface IgTreeMethods { /** * Toggles the checkstate of a node if checkboxMode is not set to off, otherwise does nothing. * - * @param node Specifies the node element the checkbox of which would be toggled. - * @param event Indicates the browser event which triggered this action, if this is not an API call. + * @param node Specifies the node element the checkbox of which would be toggled. + * @param event Indicates the browser event which triggered this action, if this is not an API call. */ toggleCheckstate(node: Object, event?: Object): void; /** * Toggles the collapse/expand state for the specified node. * - * @param node Specifies the node element the checkbox of which would be toggled. - * @param event Indicates the browser event which triggered this action, if this is not an API call. + * @param node Specifies the node element the checkbox of which would be toggled. + * @param event Indicates the browser event which triggered this action, if this is not an API call. */ toggle(node: Object, event?: Object): void; /** * Expands the tree down to the specified node and selects the node if specified. * - * @param node Specifies the node element down to which the tree would be expanded. - * @param toSelect Specifies the whether to select the node after expanding to it. + * @param node Specifies the node element down to which the tree would be expanded. + * @param toSelect Specifies the whether to select the node after expanding to it. */ expandToNode(node: Object, toSelect?: boolean): void; /** * Expands the specified node. * - * @param node Specifies the node element to expand. + * @param node Specifies the node element to expand. */ expand(node: Object): void; /** * Collapses the specified node. * - * @param node Specifies the node element to collapse. + * @param node Specifies the node element to collapse. */ collapse(node: Object): void; /** * Retrieves the parent node element of the specified node element. * - * @param node Specifies the jQuery selected node element to collapse. + * @param node Specifies the jQuery selected node element to collapse. */ parentNode(node: Object): Object; /** * Retrieves the jQuery element of the node with the specified path. * - * @param nodePath Specifies the path to the required node. + * @param nodePath Specifies the path to the required node. */ nodeByPath(nodePath: string): Object; /** * Retrieves the jQuery element of the node with the specified value. * - * @param value Specifies the value of the required node. + * @param value Specifies the value of the required node. */ nodesByValue(value: string): Object; @@ -81497,15 +81326,15 @@ interface IgTreeMethods { /** * Selects a node. * - * @param node Specifies the node element to be selected. - * @param event Indicates the browser event which triggered this action, if this is not an API call. + * @param node Specifies the node element to be selected. + * @param event Indicates the browser event which triggered this action, if this is not an API call. */ select(node: Object, event?: Object): void; /** * Deselects the specified node. * - * @param node Specifies the node element to be deselected. + * @param node Specifies the node element to be deselected. */ deselect(node: Object): void; @@ -81522,104 +81351,104 @@ interface IgTreeMethods { /** * Retrieves all node objects with the specified text (case sensitive). * - * @param text The text to search for. - * @param parent The node element to start the search from. If not specified then search would start from the root of the tree. + * @param text The text to search for. + * @param parent The node element to start the search from. If not specified then search would start from the root of the tree. */ findNodesByText(text: string, parent?: Object): any[]; /** * Retrieves all node objects for the immediate children of the specified parent with the specified text (case sensitive). * - * @param text The text to search for. - * @param parent The node element the children of which would be searched. + * @param text The text to search for. + * @param parent The node element the children of which would be searched. */ findImmediateNodesByText(text: string, parent?: Object): any[]; /** * Retrieves the n-th jQuery node element child of the specified parent. * - * @param index Specifies the index the node at which to be retrieved. - * @param parent The parent node element to start the search from. + * @param index Specifies the index the node at which to be retrieved. + * @param parent The parent node element to start the search from. */ nodeByIndex(index: number, parent?: Object): Object; /** * Retrieves a node object for the specified node element. * - * @param element Specifies the node element. + * @param element Specifies the node element. */ nodeFromElement(element: Object): Object; /** * Retrieves a node object collection of the immediate children of the provided node element. * - * @param parent Specifies the node element. + * @param parent Specifies the node element. */ children(parent: Object): any[]; /** * Retrieves a node object collection of the immediate children of the node with the provided path. * - * @param path Specifies the path of the node the children of which are to be retrieved. + * @param path Specifies the path of the node the children of which are to be retrieved. */ childrenByPath(path: string): any[]; /** * Returns true if the provided node element is selected and false otherwise. * - * @param node Specifies the node element. + * @param node Specifies the node element. */ isSelected(node: Object): boolean; /** * Returns true if the provided node element is expanded and false otherwise. * - * @param node Specifies the node element. + * @param node Specifies the node element. */ isExpanded(node: Object): boolean; /** * Returns true if the provided node element has its checkbox checkstate checked and false otherwise. * - * @param node Specifies the node element. + * @param node Specifies the node element. */ isChecked(node: Object): boolean; /** * Returns the specified node checkstate. * - * @param node Specifies the node element. + * @param node Specifies the node element. */ checkState(node: Object): string; /** * Adds a new array of nodes to the tree. New nodes are appended to the root or to a specified parent node, at a specified index. * - * @param node Specifies the data used to create the new nodeс. - * @param parent Specifies the element of the parent node the nodes are to be appended to. - * @param nodeIndex Specifies the index at which the nodes to be inserted. + * @param node Specifies the data used to create the new nodeс. + * @param parent Specifies the element of the parent node the nodes are to be appended to. + * @param nodeIndex Specifies the index at which the nodes to be inserted. */ addNode(node: Object, parent?: Object, nodeIndex?: number): void; /** * Removes the node with with the specified path and all of its children. * - * @param path Specifies the path of the node to be removed. + * @param path Specifies the path of the node to be removed. */ removeAt(path: string): void; /** * Removing all the nodes with the specified value. * - * @param value Specifies the value of the nodes to be removed. + * @param value Specifies the value of the nodes to be removed. */ removeNodesByValue(value: string): void; /** * Performs a UI update on the provided node element with the provided data. * - * @param element Specifies the node to be updated. - * @param data Specifies the new data item the node would update according to. + * @param element Specifies the node to be updated. + * @param data Specifies the new data item the node would update according to. */ applyChangesToNode(element: Object, data: Object): void; @@ -81631,7 +81460,7 @@ interface IgTreeMethods { /** * Returns the data for the node with specified path. * - * @param path Specifies the node path for which the data is returned. + * @param path Specifies the node path for which the data is returned. */ nodeDataFor(path: string): Object; @@ -81683,6 +81512,7 @@ interface JQuery { * Gets/Sets the width of the control container. * */ + igTree(optionLiteral: 'option', optionName: "width"): string|number; /** @@ -81691,12 +81521,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igTree(optionLiteral: 'option', optionName: "width", optionValue: string|number): void; /** * Gets/Sets how the height of of the control container. * */ + igTree(optionLiteral: 'option', optionName: "height"): string|number; /** @@ -81705,12 +81537,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igTree(optionLiteral: 'option', optionName: "height", optionValue: string|number): void; /** * Gets the behavior and type of the checkboxes rendered for the tree nodes. Can be set only at initialization. * */ + igTree(optionLiteral: 'option', optionName: "checkboxMode"): string; /** @@ -81719,6 +81553,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTree(optionLiteral: 'option', optionName: "checkboxMode", optionValue: string): void; /** @@ -81753,6 +81588,7 @@ interface JQuery { * Gets/Sets the image url applied to all parent nodes. * */ + igTree(optionLiteral: 'option', optionName: "parentNodeImageUrl"): string; /** @@ -81761,12 +81597,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igTree(optionLiteral: 'option', optionName: "parentNodeImageUrl", optionValue: string): void; /** * Gets/Sets the CSS class applied to all parent nodes. * */ + igTree(optionLiteral: 'option', optionName: "parentNodeImageClass"): string; /** @@ -81775,12 +81613,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igTree(optionLiteral: 'option', optionName: "parentNodeImageClass", optionValue: string): void; /** * Gets/Sets the tooltip applied to all parent node images. * */ + igTree(optionLiteral: 'option', optionName: "parentNodeImageTooltip"): string; /** @@ -81789,12 +81629,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igTree(optionLiteral: 'option', optionName: "parentNodeImageTooltip", optionValue: string): void; /** * Gets/Sets the image url applied to all leaf nodes. * */ + igTree(optionLiteral: 'option', optionName: "leafNodeImageUrl"): string; /** @@ -81803,12 +81645,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igTree(optionLiteral: 'option', optionName: "leafNodeImageUrl", optionValue: string): void; /** * Gets/Sets the CSS class applied to all leaf nodes. * */ + igTree(optionLiteral: 'option', optionName: "leafNodeImageClass"): string; /** @@ -81817,12 +81661,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igTree(optionLiteral: 'option', optionName: "leafNodeImageClass", optionValue: string): void; /** * Gets/Sets the tooltip applied to all leaf node images. * */ + igTree(optionLiteral: 'option', optionName: "leafNodeImageTooltip"): string; /** @@ -81831,6 +81677,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTree(optionLiteral: 'option', optionName: "leafNodeImageTooltip", optionValue: string): void; /** @@ -81881,6 +81728,7 @@ interface JQuery { * Gets/Sets a remote URL accepted by [$.ig.DataSource](ig.datasource) in order to request data from it. * */ + igTree(optionLiteral: 'option', optionName: "dataSourceUrl"): string; /** @@ -81889,12 +81737,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igTree(optionLiteral: 'option', optionName: "dataSourceUrl", optionValue: string): void; /** * Gets the type of the data source. Delegates the value to [$.ig.DataSource.settings.type](ig.datasource#options:settings.type). Explicitly set data source type (such as "json"). Please refer to the documentation of $.ig.DataSource.settings.type. * */ + igTree(optionLiteral: 'option', optionName: "dataSourceType"): string; /** @@ -81903,12 +81753,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igTree(optionLiteral: 'option', optionName: "dataSourceType", optionValue: string): void; /** * Gets the JSON key at which a remote data source will write the data. Delegates the value to [$.ig.DataSource.settings.responseDataKey](ig.datasource#options:settings.responseDataKey). Please refer to the documentation of $.ig.DataSource.settings.responseDataKey. * */ + igTree(optionLiteral: 'option', optionName: "responseDataKey"): string; /** @@ -81917,12 +81769,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igTree(optionLiteral: 'option', optionName: "responseDataKey", optionValue: string): void; /** * Gets the data type of the remote data source response. Delegates the value to [$.ig.DataSource.settings.responseDataType](ig.datasource#options:settings.responseDataType). Please refer to the documentation of $.ig.DataSource.settings.responseDataType. * */ + igTree(optionLiteral: 'option', optionName: "responseDataType"): string; /** @@ -81931,6 +81785,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTree(optionLiteral: 'option', optionName: "responseDataType", optionValue: string): void; /** @@ -82437,9 +82292,9 @@ interface IgTreeGridColumnFixingMethods { /** * Unfixes a column by specified column identifier - column key or column index. * - * @param colIdentifier An identifier of the column to be unfixed - column index or column key. - * @param target Key of the column where the unfixed column should move to. - * @param after Specifies where the unfixed column should be rendered after or before the target column. This parameter is disregarded if there is no target column specified. + * @param colIdentifier An identifier of the column to be unfixed - column index or column key. + * @param target Key of the column where the unfixed column should move to. + * @param after Specifies where the unfixed column should be rendered after or before the target column. This parameter is disregarded if there is no target column specified. */ unfixColumn(colIdentifier: Object, target?: string, after?: boolean): Object; @@ -82451,38 +82306,38 @@ interface IgTreeGridColumnFixingMethods { /** * If the 'check' argument is set to true, checks whether the heights of fixed and unfixed tables are equal, if not sync them. Similar check is made for heights of table rows. If the clearRowsHeights argument is set to true, clears rows heights before syncing them. * - * @param check If set to true, checks whether the heights of fixed and unfixed tables are equal, if not sync them. If this argument is set to false sync is performed regardless of the current heights. - * @param clearRowsHeights Clears row heigths for all visible rows. + * @param check If set to true, checks whether the heights of fixed and unfixed tables are equal, if not sync them. If this argument is set to false sync is performed regardless of the current heights. + * @param clearRowsHeights Clears row heigths for all visible rows. */ syncHeights(check?: boolean, clearRowsHeights?: boolean): void; /** * Returns whether the column with the specified key is a column group header, when the [multi-column headers](http://www.igniteui.com/help/iggrid-multicolumnheaders-landingpage) feature is used. * - * @param colKey The key of the column to perform the check for. + * @param colKey The key of the column to perform the check for. */ isGroupHeader(colKey: string): boolean; /** * Checks whether column fixing is allowed for the specified columns. It should not be allowed if there is only one visible column in the unfixed area. * - * @param columns Array of columns and/or column identifiers - could be column indexes, column keys, column object or mixed. + * @param columns Array of columns and/or column identifiers - could be column indexes, column keys, column object or mixed. */ checkFixingAllowed(columns: any[]): boolean; /** * Checks whether unfixing is allowed for the specified columns. It should not be allowed if there is only one visible column in the fixed area. * - * @param columns Array of columns and/or column identifiers - could be column indexes, column keys, column object or mixed. + * @param columns Array of columns and/or column identifiers - could be column indexes, column keys, column object or mixed. */ checkUnfixingAllowed(columns: any[]): boolean; /** * Fixes a column by specified column identifier - column index or column key. * - * @param colIdentifier An identifier of the column to be fixed - column index or column key. - * @param target Key of the column where the fixed column should move to. - * @param after Specifies where the fixed column should be moved after or before the target column. This parameter is disregarded if there is no target column specified. + * @param colIdentifier An identifier of the column to be fixed - column index or column key. + * @param target Key of the column where the fixed column should move to. + * @param after Specifies where the fixed column should be moved after or before the target column. This parameter is disregarded if there is no target column specified. */ fixColumn(colIdentifier: Object, target?: string, after?: boolean): Object; @@ -82514,17 +82369,17 @@ interface IgTreeGridColumnFixingMethods { /** * Syncs rows heights between two collections of rows. * - * @param $trs An array of rows of the first(fixed/unfixed) container. - * @param $anotherRows An array of rows of the second(fixed/unfixed) container. + * @param $trs An array of rows of the first(fixed/unfixed) container. + * @param $anotherRows An array of rows of the second(fixed/unfixed) container. */ syncRowsHeights($trs: any[], $anotherRows: any[]): void; /** * Calculates widths of the fixed columns. * - * @param fCols Array of grid columns. If not set then the total width of the fixed columns are returned. - * @param excludeNonDataColumns If set to true do not calculate the width of non-data fixed columns (like the row selector row numbering column). - * @param includeHidden If set to true calculates width of the hidden fixed columns (their initial width before hiding). + * @param fCols Array of grid columns. If not set then the total width of the fixed columns are returned. + * @param excludeNonDataColumns If set to true do not calculate the width of non-data fixed columns (like the row selector row numbering column). + * @param includeHidden If set to true calculates width of the hidden fixed columns (their initial width before hiding). */ getWidthOfFixedColumns(fCols?: any[], excludeNonDataColumns?: boolean, includeHidden?: boolean): number; } @@ -82623,6 +82478,7 @@ interface JQuery { * Configures which side the fixed columns of the grid will be rendered on. Check [this topic](http://www.igniteui.com/help/iggrid-columnfixing-configuring#direction) out of more information. * */ + igTreeGridColumnFixing(optionLiteral: 'option', optionName: "fixingDirection"): string; /** @@ -82631,6 +82487,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGridColumnFixing(optionLiteral: 'option', optionName: "fixingDirection", optionValue: string): void; /** @@ -82679,6 +82536,7 @@ interface JQuery { * Minimal visible area in pixels for the unfixed columns. If the end user tries to fix a column(or columns), which causes the width of the fixed columns to grow such that the width of visible area of unfixed columns is less than this option then fixing will be canceled. Check [this topic](http://www.igniteui.com/help/iggrid-columnfixing-configuring#non-fixable-min-width) out for more information. * */ + igTreeGridColumnFixing(optionLiteral: 'option', optionName: "minimalVisibleAreaWidth"): string|number; /** @@ -82687,6 +82545,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGridColumnFixing(optionLiteral: 'option', optionName: "minimalVisibleAreaWidth", optionValue: string|number): void; /** @@ -83065,11 +82924,11 @@ interface IgTreeGridColumnMovingMethods { * Moves a visible column at a specified place, in front or behind a target column or at a target index * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * - * @param column An identifier of the column to be moved. It can be a key, a Multi-Column Header identificator, or an index in a number format. The latter is not supported when the grid contains multi-column headers. - * @param target An identifier of a column where the moved column should move to or an index at which the moved column should be moved to. In the case of a column identifier the column will be moved after it by default. - * @param after Specifies whether the column moved should be moved after or before the target column. - * @param inDom Specifies whether the column moving will be enacted through DOM manipulation or through rerendering of the grid. - * @param callback Specifies a custom function to be called when the column is moved. + * @param column An identifier of the column to be moved. It can be a key, a Multi-Column Header identificator, or an index in a number format. The latter is not supported when the grid contains multi-column headers. + * @param target An identifier of a column where the moved column should move to or an index at which the moved column should be moved to. In the case of a column identifier the column will be moved after it by default. + * @param after Specifies whether the column moved should be moved after or before the target column. + * @param inDom Specifies whether the column moving will be enacted through DOM manipulation or through rerendering of the grid. + * @param callback Specifies a custom function to be called when the column is moved. */ moveColumn(column: Object, target: Object, after?: boolean, inDom?: boolean, callback?: Function): void; } @@ -83099,6 +82958,7 @@ interface JQuery { * Specify the drag-and-drop mode for the feature * */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "mode"): string; /** @@ -83107,12 +82967,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "mode", optionValue: string): void; /** * Specify the way columns will be rearranged * */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "moveType"): string; /** @@ -83121,6 +82983,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "moveType", optionValue: string): void; /** @@ -84142,15 +84005,15 @@ interface IgTreeGridFilteringMethods { /** * Toggle filter row when mode is simple or [advancedModeEditorsVisible](ui.iggridfiltering#options:advancedModeEditorsVisible) is true. Otherwise show/hide advanced dialog. * - * @param event Column key + * @param event Column key */ toggleFilterRowByFeatureChooser(event: string): void; /** * Applies filtering programmatically and updates the UI by default. * - * @param expressions An array of filtering expressions, each one having the format {fieldName: , expr: , cond: , logic: } where fieldName is the key of the column, expr is the actual expression string with which we would like to filter, logic is 'AND' or 'OR', and cond is one of the following strings: "equals", "doesNotEqual", "contains", "doesNotContain", "greaterThan", "lessThan", "greaterThanOrEqualTo", "lessThanOrEqualTo", "true", "false", "null", "notNull", "empty", "notEmpty", "startsWith", "endsWith", "today", "yesterday", "on", "notOn", "thisMonth", "lastMonth", "nextMonth", "before", "after", "thisYear", "lastYear", "nextYear". The difference between the empty and null filtering conditions is that empty includes null, NaN, and undefined, as well as the empty string. - * @param updateUI specifies whether the filter row should be also updated once the grid is filtered + * @param expressions An array of filtering expressions, each one having the format {fieldName: , expr: , cond: , logic: } where fieldName is the key of the column, expr is the actual expression string with which we would like to filter, logic is 'AND' or 'OR', and cond is one of the following strings: "equals", "doesNotEqual", "contains", "doesNotContain", "greaterThan", "lessThan", "greaterThanOrEqualTo", "lessThanOrEqualTo", "true", "false", "null", "notNull", "empty", "notEmpty", "startsWith", "endsWith", "today", "yesterday", "on", "notOn", "thisMonth", "lastMonth", "nextMonth", "before", "after", "thisYear", "lastYear", "nextYear". The difference between the empty and null filtering conditions is that empty includes null, NaN, and undefined, as well as the empty string. + * @param updateUI specifies whether the filter row should be also updated once the grid is filtered * @param addedFromAdvanced */ filter(expressions: any[], updateUI?: boolean, addedFromAdvanced?: boolean): void; @@ -84158,7 +84021,7 @@ interface IgTreeGridFilteringMethods { /** * Check whether filterCondition requires or not filtering expression - e.g. if filterCondition is "lastMonth", "thisMonth", "null", "notNull", "true", "false", etc. then filtering expression is NOT required * - * @param filterCondition filtering condition - e.g. "true", "false", "yesterday", "empty", "null", etc. + * @param filterCondition filtering condition - e.g. "true", "false", "yesterday", "empty", "null", etc. */ requiresFilteringExpression(filterCondition: string): boolean; } @@ -84335,6 +84198,7 @@ interface JQuery { * Type of animations for the column filter dropdowns. * */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDropDownAnimations"): string; /** @@ -84343,6 +84207,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDropDownAnimations", optionValue: string): void; /** @@ -84363,6 +84228,7 @@ interface JQuery { * Width of the column filter dropdowns. * */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDropDownWidth"): string|number; /** @@ -84371,6 +84237,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDropDownWidth", optionValue: string|number): void; /** @@ -84409,6 +84276,7 @@ interface JQuery { * Enable/disable filter icons visibility. * */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDropDownItemIcons"): boolean; /** @@ -84417,6 +84285,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDropDownItemIcons", optionValue: boolean): void; /** @@ -84437,6 +84306,7 @@ interface JQuery { * Type of filtering. Delegates all filtering functionality to the [$.ig.DataSource](ig.datasource). * */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "type"): string; /** @@ -84445,6 +84315,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "type", optionValue: string): void; /** @@ -84465,6 +84336,7 @@ interface JQuery { * Default is 'simple' for non-virtualized grids, and 'advanced' when [virtualization](ui.iggrid#options:virtualization) is enabled. * */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "mode"): string; /** @@ -84473,6 +84345,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "mode", optionValue: string): void; /** @@ -84493,6 +84366,7 @@ interface JQuery { * Location of the advanced filtering button when [advancedModeEditorsVisible](ui.iggridfiltering#options:advancedModeEditorsVisible) is false (i.e. when the button is rendered in the header). * */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "advancedModeHeaderButtonLocation"): string; /** @@ -84501,12 +84375,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "advancedModeHeaderButtonLocation", optionValue: string): void; /** * Default filter dialog width (used for Advanced filtering [mode](ui.iggridfiltering#options:mode)). * */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogWidth"): string|number; /** @@ -84515,12 +84391,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogWidth", optionValue: string|number): void; /** * Default filter dialog height (used for Advanced filtering [mode](ui.iggridfiltering#options:mode)). * */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogHeight"): string|number; /** @@ -84529,12 +84407,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogHeight", optionValue: string|number): void; /** * Width of the filtering condition dropdowns in the advanced filter dialog. * */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogFilterDropDownDefaultWidth"): string|number; /** @@ -84543,12 +84423,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogFilterDropDownDefaultWidth", optionValue: string|number): void; /** * Width of the filtering expression input boxes in the advanced filter dialog. * */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogExprInputDefaultWidth"): string|number; /** @@ -84557,12 +84439,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogExprInputDefaultWidth", optionValue: string|number): void; /** * Width of the column chooser dropdowns in the advanced filter dialog. * */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogColumnDropDownDefaultWidth"): string|number; /** @@ -84571,6 +84455,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogColumnDropDownDefaultWidth", optionValue: string|number): void; /** @@ -84591,6 +84476,7 @@ interface JQuery { * The filtering button for filter dropdowns can be rendered either on the left of the filter editor, or on the right. * */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterButtonLocation"): string; /** @@ -84599,6 +84485,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterButtonLocation", optionValue: string): void; /** @@ -84711,6 +84598,7 @@ interface JQuery { * Add button width - in the advanced filter dialog. * */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogAddButtonWidth"): string|number; /** @@ -84719,12 +84607,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogAddButtonWidth", optionValue: string|number): void; /** * Width of the Ok and Cancel buttons in the advanced filtering dialogs. * */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogOkCancelButtonWidth"): string|number; /** @@ -84733,6 +84623,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogOkCancelButtonWidth", optionValue: string|number): void; /** @@ -85309,9 +85200,9 @@ interface IgTreeGridHidingMethods { * Shows a hidden column. If the column is not hidden the method does nothing. * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * - * @param column An identifier for the column. If a number is provided it will be used as a column index else if a strings is provided it will be used as a column key. - * @param isMultiColumnHeader If it is true then the column is of type multicolumnheader. An identifier for the column should be of type string. - * @param callback Specifies a custom function to be called when the column(s) is shown(optional) + * @param column An identifier for the column. If a number is provided it will be used as a column index else if a strings is provided it will be used as a column key. + * @param isMultiColumnHeader If it is true then the column is of type multicolumnheader. An identifier for the column should be of type string. + * @param callback Specifies a custom function to be called when the column(s) is shown(optional) */ showColumn(column: Object, isMultiColumnHeader?: boolean, callback?: Function): void; @@ -85319,9 +85210,9 @@ interface IgTreeGridHidingMethods { * Hides a visible column. If the column is hidden the method does nothing. * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * - * @param column An identifier for the column. If a number is provided it will be used as a column index else if a strings is provided it will be used as a column key. - * @param isMultiColumnHeader If it is true then the column is of type multicolumnheader. An identifier for the column should be of type string. - * @param callback Specifies a custom function to be called when the column is hidden(optional) + * @param column An identifier for the column. If a number is provided it will be used as a column index else if a strings is provided it will be used as a column key. + * @param isMultiColumnHeader If it is true then the column is of type multicolumnheader. An identifier for the column should be of type string. + * @param callback Specifies a custom function to be called when the column is hidden(optional) */ hideColumn(column: Object, isMultiColumnHeader?: boolean, callback?: Function): void; @@ -85329,8 +85220,8 @@ interface IgTreeGridHidingMethods { * Hides visible columns specified by the array. If the column is hidden the method does nothing. * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * - * @param columns An array of identifiers for the columns. If a number is provided it will be used as a column index else if a strings is provided it will be used as a column key. - * @param callback Specifies a custom function to be called when all columns are hidden(optional) + * @param columns An array of identifiers for the columns. If a number is provided it will be used as a column index else if a strings is provided it will be used as a column key. + * @param callback Specifies a custom function to be called when all columns are hidden(optional) */ hideMultiColumns(columns: any[], callback?: Function): void; @@ -85338,8 +85229,8 @@ interface IgTreeGridHidingMethods { * Show visible columns specified by the array. If the column is shown the method does nothing. * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * - * @param columns An array of identifiers for the columns. If a number is provided it will be used as a column index else if a strings is provided it will be used as a column key. - * @param callback Specifies a custom function to be called when all columns are shown(optional) + * @param columns An array of identifiers for the columns. If a number is provided it will be used as a column index else if a strings is provided it will be used as a column key. + * @param callback Specifies a custom function to be called when all columns are shown(optional) */ showMultiColumns(columns: any[], callback?: Function): void; @@ -85933,7 +85824,7 @@ interface IgTreeGrid { * Specifies the foreign key value in the data source to treat as the root level once the grid is data bound. Defaults to -1 (which includes the entire data source) * */ - foreignKeyRootValue?: number; + foreignKeyRootValue?: number|string; /** * Specify whether to render non-data column which contains expander indicators @@ -85971,11 +85862,6 @@ interface IgTreeGrid { */ dataSourceSettings?: IgTreeGridDataSourceSettings; - /** - * This option is inherited from a parent widget and it's not applicable for the igTreeGrid. - */ - restSettings?: any; - /** * Defines the grid width in pixels or percents. [Here you can find more info about setting igGrid width](http://www.igniteui.com/help/iggrid-columns-and-layout#width-height). * @@ -86246,6 +86132,12 @@ interface IgTreeGrid { */ updateUrl?: string; + /** + * Settings related to REST compliant update routines. + * + */ + restSettings?: IgGridRestSettings; + /** * Enables/disables rendering of alternating row styles (odd and even rows receive different styling). * @@ -86463,8 +86355,8 @@ interface IgTreeGridMethods { /** * Clears the transaction log (delegates to igDataSource). Note that this does not update the UI. In case the UI must be updated, set the second parameter "updateUI" to true, which will trigger a call to dataBind() to re-render the contents. * - * @param rowId If specified, will only rollback the transactions with that row id. - * @param updateUI Whether to update the UI or not. + * @param rowId If specified, will only rollback the transactions with that row id. + * @param updateUI Whether to update the UI or not. */ rollback(rowId?: Object, updateUI?: boolean): any[]; @@ -86476,32 +86368,32 @@ interface IgTreeGridMethods { /** * Toggle row by specified row or row identifier * - * @param row jQuery table row object or a row id. - * @param callback Specifies a custom function to be called when row is expanded/collapsed. The callback has 4 arguments- a reference to the current context(this), object that holds 2 properties(unfixedRow - DOM representation of the unfixed row, fixedRow - DOM representation of the fixed row, if there is no fixed columns it is undefined), reference to the dataRecord, expand - specifies whether row is expanded + * @param row jQuery table row object or a row id. + * @param callback Specifies a custom function to be called when row is expanded/collapsed. The callback has 4 arguments- a reference to the current context(this), object that holds 2 properties(unfixedRow - DOM representation of the unfixed row, fixedRow - DOM representation of the fixed row, if there is no fixed columns it is undefined), reference to the dataRecord, expand - specifies whether row is expanded */ toggleRow(row: Object, callback?: Function): void; /** * Expands a parent row by specified row or row identifier * - * @param row jQuery table row object or a row id. - * @param callback Specifies a custom function to be called when row is expanded/collapsed. The callback has 4 arguments- a reference to the current context(this), object that holds 2 properties(unfixedRow - DOM representation of the unfixed row, fixedRow - DOM representation of the fixed row, if there is no fixed columns it is undefined), reference to the dataRecord, expand - specifies whether row is expanded + * @param row jQuery table row object or a row id. + * @param callback Specifies a custom function to be called when row is expanded/collapsed. The callback has 4 arguments- a reference to the current context(this), object that holds 2 properties(unfixedRow - DOM representation of the unfixed row, fixedRow - DOM representation of the fixed row, if there is no fixed columns it is undefined), reference to the dataRecord, expand - specifies whether row is expanded */ expandRow(row: Object, callback?: Function): void; /** * Collapses a parent row by specified row or row identifier * - * @param row jQuery table row object, raw DOM row object or a row id. - * @param callback Specifies a custom function to be called when row is expanded/collapsed. The callback has 4 arguments- a reference to the current context(this), object that holds 2 properties(unfixedRow - DOM representation of the unfixed row, fixedRow - DOM representation of the fixed row, if there is no fixed columns it is undefined), reference to the dataRecord, expand - specifies whether row is expanded + * @param row jQuery table row object, raw DOM row object or a row id. + * @param callback Specifies a custom function to be called when row is expanded/collapsed. The callback has 4 arguments- a reference to the current context(this), object that holds 2 properties(unfixedRow - DOM representation of the unfixed row, fixedRow - DOM representation of the fixed row, if there is no fixed columns it is undefined), reference to the dataRecord, expand - specifies whether row is expanded */ collapseRow(row: Object, callback?: Function): void; /** * Adds a new row (TR) to the grid as a child of a specific row, by taking a data row object. Assumes the record will have the primary key. * - * @param rec The data row JavaScript object. - * @param parentId Identifier/key of the targeted parent row. If missing, then the new row is rendered to the bottom of the grid. + * @param rec The data row JavaScript object. + * @param parentId Identifier/key of the targeted parent row. If missing, then the new row is rendered to the bottom of the grid. */ renderNewChild(rec: Object, parentId?: string): void; @@ -86534,7 +86426,7 @@ interface IgTreeGridMethods { /** * Returns whether the column with identifier colKey is fixed * - * @param colKey An identifier of the column which should be checked. It can be a key or visible index. + * @param colKey An identifier of the column which should be checked. It can be a key or visible index. */ isFixedColumn(colKey: Object): boolean; @@ -86546,7 +86438,7 @@ interface IgTreeGridMethods { /** * Returns whether the header identified by colKey is multicolumn header(has children) * - * @param colKey value of the column key + * @param colKey value of the column key */ isGroupHeader(colKey: string): Object; @@ -86558,7 +86450,7 @@ interface IgTreeGridMethods { * recordIndex - index of the data record associated with this element in the current dataView. * columnObject - the column object associated with this element ( if the element is tr this will be null) * - * @param elem The Dom element or jQuery object which can be a TD or TR element from the grid. + * @param elem The Dom element or jQuery object which can be a TD or TR element from the grid. */ getElementInfo(elem: Element): Object; @@ -86620,17 +86512,17 @@ interface IgTreeGridMethods { /** * Returns the cell TD element at the specified location * - * @param x The column index. - * @param y The row index. - * @param isFixed Optional parameter - if true get cell TD at the specified location from the fixed table + * @param x The column index. + * @param y The row index. + * @param isFixed Optional parameter - if true get cell TD at the specified location from the fixed table */ cellAt(x: number, y: number, isFixed: boolean): Element; /** * Returns the cell TD element by row id and column key * - * @param rowId The id of the row. - * @param columnKey The column key. + * @param rowId The id of the row. + * @param columnKey The column key. */ cellById(rowId: Object, columnKey: string): Element; @@ -86662,22 +86554,22 @@ interface IgTreeGridMethods { /** * Returns the row (TR element) at the specified index. jQuery selectors aren't used for performance reasons * - * @param i The row index. + * @param i The row index. */ rowAt(i: number): Element; /** * Returns the row TR element by row id * - * @param rowId The id of the row. - * @param isFixed Specify search in the fixed container. + * @param rowId The id of the row. + * @param isFixed Specify search in the fixed container. */ rowById(rowId: Object, isFixed?: boolean): Element; /** * Returns the fixed row (TR element) at the specified index. jQuery selectors aren't used for performance reasons(in ColumnFixing scenario - only when there is at least one fixed column) * - * @param i The row index. + * @param i The row index. */ fixedRowAt(i: number): Element; @@ -86704,14 +86596,14 @@ interface IgTreeGridMethods { /** * Returns a column object by the specified column key * - * @param key The column key. + * @param key The column key. */ columnByKey(key: string): Object; /** * Returns a column object by the specified header text. If there are multiple matches, returns the first one. * - * @param text The column header text. + * @param text The column header text. */ columnByText(text: string): Object; @@ -86753,8 +86645,8 @@ interface IgTreeGridMethods { * Retrieves a cell value using the row index and the column key. If a primaryKey is defined, rowId is assumed to be the row Key (not index). * If primary key is not defined, then rowId is converted to a number and is used as a row index. * - * @param rowId Row index or row key (primary key). - * @param colKey The column key. + * @param rowId Row index or row key (primary key). + * @param colKey The column key. */ getCellValue(rowId: Object, colKey: string): Object; @@ -86762,24 +86654,24 @@ interface IgTreeGridMethods { * Returns the cell text. If colKey is a number, the index of the column is used (instead of a column name)- does not apply when using a Multi-Row Layout grid. * This is the actual text (or HTML string) for the contents of the cell. * - * @param rowId Row index or row data key (primary key) - * @param colKey Column key. + * @param rowId Row index or row data key (primary key) + * @param colKey Column key. */ getCellText(rowId: Object, colKey: string): string; /** * Sets a new template for a column after initialization and renders the grid if not explicitly disabled. This method will replace any existing explicitly set row template and will build one anew from the column ones. * - * @param col An identifier of the column to set template for (index or key) - * @param tmpl The column template to set - * @param render Should the grid rerender after template is set + * @param col An identifier of the column to set template for (index or key) + * @param tmpl The column template to set + * @param render Should the grid rerender after template is set */ setColumnTemplate(col: Object, tmpl: string, render?: boolean): void; /** * Commits all pending transactions to the client data source. Note that there won't be anything to commit on the UI, since it is updated instantly. In order to rollback the actual UI, a call to dataBind() is required. * - * @param rowId If specified, will commit only that transaction corresponding to the specified record key. + * @param rowId If specified, will commit only that transaction corresponding to the specified record key. */ commit(rowId?: Object): void; @@ -86787,7 +86679,7 @@ interface IgTreeGridMethods { * Returns a record by a specified key (requires that primaryKey is set in the settings). * That is a wrapper for this.dataSource.findRecordByKey(key). * - * @param key Primary key of the record + * @param key Primary key of the record */ findRecordByKey(key: Object): Object; @@ -86795,7 +86687,7 @@ interface IgTreeGridMethods { * Returns a standalone object (copy) that represents the committed transactions, but detached from the data source. * That is a wrapper for this.dataSource.getDetachedRecord(t). * - * @param t A transaction object. + * @param t A transaction object. */ getDetachedRecord(t: Object): Object; @@ -86820,22 +86712,22 @@ interface IgTreeGridMethods { /** * Invokes an AJAX request to the updateUrl option (if specified) and passes the serialized transaction log (a serialized JSON string) as part of the POST request. * - * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) - * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) + * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) + * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) */ saveChanges(success: Function, error: Function): void; /** * Adds a new row (TR) to the grid, by taking a data row object. Assumes the record will have the primary key. * - * @param rec Identifier/key of row. If missing, then number of rows in grid is used. + * @param rec Identifier/key of row. If missing, then number of rows in grid is used. */ renderNewRow(rec?: string): void; /** * If the data source points to a local JSON array of data, and it is necessary to reset it at runtime, it must be done through this API member instead of the options (options.dataSource) * - * @param dataSource New data source object. + * @param dataSource New data source object. */ dataSourceObject(dataSource: Object): void; @@ -86850,11 +86742,11 @@ interface IgTreeGridMethods { * Moves a visible column at a specified place, in front or behind a target column or at a target index * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * - * @param column An identifier of the column to be moved. It can be a key, a Multi-Column Header identificator, or an index in a number format. The latter is not supported when the grid contains multi-column headers. - * @param target An identifier of a column where the moved column should move to or an index at which the moved column should be moved to. In the case of a column identifier the column will be moved after it by default. - * @param after Specifies whether the column moved should be moved after or before the target column. This parameter is disregarded if there is no target column specified but a target index is used. - * @param inDom Specifies whether the column moving will be enacted through DOM manipulation or through rerendering of the grid. - * @param callback Specifies a custom function to be called when the column is moved. + * @param column An identifier of the column to be moved. It can be a key, a Multi-Column Header identificator, or an index in a number format. The latter is not supported when the grid contains multi-column headers. + * @param target An identifier of a column where the moved column should move to or an index at which the moved column should be moved to. In the case of a column identifier the column will be moved after it by default. + * @param after Specifies whether the column moved should be moved after or before the target column. This parameter is disregarded if there is no target column specified but a target index is used. + * @param inDom Specifies whether the column moving will be enacted through DOM manipulation or through rerendering of the grid. + * @param callback Specifies a custom function to be called when the column is moved. */ moveColumn(column: Object, target: Object, after?: boolean, inDom?: boolean, callback?: Function): void; @@ -86862,8 +86754,8 @@ interface IgTreeGridMethods { * Shows a hidden column. If the column is not hidden the method does nothing. * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * - * @param column An identifier for the column. If a number is provided it will be used as a column index. If a string is provided it will be used as a column key. - * @param callback Specifies a custom function to be called when the column is shown(optional) + * @param column An identifier for the column. If a number is provided it will be used as a column index. If a string is provided it will be used as a column key. + * @param callback Specifies a custom function to be called when the column is shown(optional) */ showColumn(column: Object, callback: Function): void; @@ -86871,41 +86763,41 @@ interface IgTreeGridMethods { * Hides a visible column. If the column is hidden the method does nothing. * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * - * @param column An identifier for the column. If a number is provided it will be used as a column index else if a string is provided it will be used as a column key. - * @param callback Specifies a custom function to be called when the column is hidden(optional) + * @param column An identifier for the column. If a number is provided it will be used as a column index else if a string is provided it will be used as a column key. + * @param callback Specifies a custom function to be called when the column is hidden(optional) */ hideColumn(column: Object, callback: Function): void; /** * Gets unbound values for the specified column key. If key is not specified returns all unboundvalues * - * @param key column key + * @param key column key */ getUnboundValues(key: string): Object; /** * Sets unbound values for the unbound column with the specified key. If removeOldValues is true then values(if any) for the unbound columns are re-set with the new values * - * @param key key of the unbound column - * @param values array of values to be set on unbound values - * @param removeOldValues if true removes current unbound values(if any) for the specified column and apply the new ones specified in parameter values. Otherwise merge current values with the specified in parameter values + * @param key key of the unbound column + * @param values array of values to be set on unbound values + * @param removeOldValues if true removes current unbound values(if any) for the specified column and apply the new ones specified in parameter values. Otherwise merge current values with the specified in parameter values */ setUnboundValues(key: string, values: any[], removeOldValues: Object): void; /** * Sets unbound value for the unbound cell by the specified column key and row primary key. * - * @param col key of the unbound column - * @param rowId primary key value of the row - * @param val value to be set on unbound cell - * @param notToRender if false will re-render the row + * @param col key of the unbound column + * @param rowId primary key value of the row + * @param val value to be set on unbound cell + * @param notToRender if false will re-render the row */ setUnboundValueByPK(col: string, rowId: string, val: Object, notToRender: Object): void; /** * Returns an unbound column with the specified key. If not found returns null * - * @param key a column key + * @param key a column key */ getUnboundColumnByKey(key: string): Object; @@ -86922,7 +86814,7 @@ interface IgTreeGridMethods { /** * Calculates the width of the column so its content to be auto-fitted to the width of the data in it(the content should NOT be shrinked/cutted) * - * @param columnIndex Visible column index + * @param columnIndex Visible column index */ calculateAutoFitColumnWidth(columnIndex: number): number; @@ -86930,8 +86822,8 @@ interface IgTreeGridMethods { * Get visible index by specified column key. If column is not found or is hidden then returns -1. * Note: Method does not count column groups (Multi-Column Headers). * - * @param columnKey columnKey - * @param includeDataSkip Optional parameter - if set to true include non data columns(like expander column, row selectors column, etc.) in calculations + * @param columnKey columnKey + * @param includeDataSkip Optional parameter - if set to true include non data columns(like expander column, row selectors column, etc.) in calculations */ getVisibleIndexByKey(columnKey: string, includeDataSkip: boolean): number; @@ -86945,14 +86837,14 @@ interface IgTreeGridMethods { /** * Scroll to the specified row or specified position(in pixels) * - * @param scrollerPosition An identifier of the vertical scroll position. When it is string then it is interpreted as pixels otherwise it is the row number + * @param scrollerPosition An identifier of the vertical scroll position. When it is string then it is interpreted as pixels otherwise it is the row number */ virtualScrollTo(scrollerPosition: Object): void; /** * Returns column object and visible index for the table cell(TD) which is passed as argument * - * @param $td cell(TD) - either DOM TD element or jQuery object + * @param $td cell(TD) - either DOM TD element or jQuery object */ getColumnByTD($td: Object): Object; } @@ -87139,7 +87031,8 @@ interface JQuery { * Gets the foreign key value in the data source to treat as the root level once the grid is data bound. Defaults to -1 (which includes the entire data source) * */ - igTreeGrid(optionLiteral: 'option', optionName: "foreignKeyRootValue"): number; + + igTreeGrid(optionLiteral: 'option', optionName: "foreignKeyRootValue"): number|string; /** * Sets the foreign key value in the data source to treat as the root level once the grid is data bound. Defaults to -1 (which includes the entire data source) @@ -87147,7 +87040,8 @@ interface JQuery { * * @optionValue New value to be set. */ - igTreeGrid(optionLiteral: 'option', optionName: "foreignKeyRootValue", optionValue: number): void; + + igTreeGrid(optionLiteral: 'option', optionName: "foreignKeyRootValue", optionValue: number|string): void; /** * Specify whether to render non-data column which contains expander indicators @@ -87167,6 +87061,7 @@ interface JQuery { * A reference or name of a javascript function which changes first data cell - renders indentation according to databound level * */ + igTreeGrid(optionLiteral: 'option', optionName: "renderFirstDataCellFunction"): string|Object; /** @@ -87175,6 +87070,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGrid(optionLiteral: 'option', optionName: "renderFirstDataCellFunction", optionValue: string|Object): void; /** @@ -87195,6 +87091,7 @@ interface JQuery { * A reference or name of a javascript function which renders expand indicators(called ONLY IF option renderExpansionIndicatorColumn is true) * */ + igTreeGrid(optionLiteral: 'option', optionName: "renderExpansionCellFunction"): string|Object; /** @@ -87203,6 +87100,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGrid(optionLiteral: 'option', optionName: "renderExpansionCellFunction", optionValue: string|Object): void; /** @@ -87233,22 +87131,11 @@ interface JQuery { */ igTreeGrid(optionLiteral: 'option', optionName: "dataSourceSettings", optionValue: IgTreeGridDataSourceSettings): void; - /** - * This option is inherited from a parent widget and it's not applicable for the igTreeGrid. - */ - igTreeGrid(optionLiteral: 'option', optionName: "restSettings"): any; - - /** - * This option is inherited from a parent widget and it's not applicable for the igTreeGrid. - * - * @optionValue New value to be set. - */ - igTreeGrid(optionLiteral: 'option', optionName: "restSettings", optionValue: any): void; - /** * Defines the grid width in pixels or percents. [Here you can find more info about setting igGrid width](http://www.igniteui.com/help/iggrid-columns-and-layout#width-height). * */ + igTreeGrid(optionLiteral: 'option', optionName: "width"): string|number; /** @@ -87257,12 +87144,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGrid(optionLiteral: 'option', optionName: "width", optionValue: string|number): void; /** * This is the total height of the grid, including all UI elements - scroll container with data rows, header, footer, filter row - (if any), etc. [Here you can find more info about setting igGrid height](http://www.igniteui.com/help/iggrid-columns-and-layout#width-height). * */ + igTreeGrid(optionLiteral: 'option', optionName: "height"): string|number; /** @@ -87271,6 +87160,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGrid(optionLiteral: 'option', optionName: "height", optionValue: string|number): void; /** @@ -87291,6 +87181,7 @@ interface JQuery { * Used for [row virtualization](ui.iggrid#options:rowVirtualization) in [fixed mode](ui.iggrid#options:virtualizationMode). This is the average value in pixels (default) that will be used to calculate how many rows to render as the end user scrolls. Also all rows' height will be automatically set to this value. * */ + igTreeGrid(optionLiteral: 'option', optionName: "avgRowHeight"): string|number; /** @@ -87299,12 +87190,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGrid(optionLiteral: 'option', optionName: "avgRowHeight", optionValue: string|number): void; /** * Used for [column virtualization](ui.iggrid#options:columnVirtualization) in [fixed mode](ui.iggrid#options:virtualizationMode). This is the average value in pixels for a column width. * */ + igTreeGrid(optionLiteral: 'option', optionName: "avgColumnWidth"): string|number; /** @@ -87313,12 +87206,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGrid(optionLiteral: 'option', optionName: "avgColumnWidth", optionValue: string|number): void; /** * Default column width that will be set for all columns, that don't have [column width](ui.iggrid#options:columns.width) defined. * */ + igTreeGrid(optionLiteral: 'option', optionName: "defaultColumnWidth"): string|number; /** @@ -87327,6 +87222,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGrid(optionLiteral: 'option', optionName: "defaultColumnWidth", optionValue: string|number): void; /** @@ -87365,6 +87261,7 @@ interface JQuery { * Determines row virtualization mode. * */ + igTreeGrid(optionLiteral: 'option', optionName: "virtualizationMode"): string; /** @@ -87373,6 +87270,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGrid(optionLiteral: 'option', optionName: "virtualizationMode", optionValue: string): void; /** @@ -87435,6 +87333,7 @@ interface JQuery { * The templating engine that will be used to render the grid [column templates](ui.iggrid#options:columns.template). [Here you can find](http://www.infragistics.com/community/blogs/marina_stoyanova/archive/2014/05/30/using-different-template-engines-with-ignite-ui-controls.aspx) how to use templating engines other than igTemplating and jsRender. * */ + igTreeGrid(optionLiteral: 'option', optionName: "templatingEngine"): string; /** @@ -87443,6 +87342,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGrid(optionLiteral: 'option', optionName: "templatingEngine", optionValue: string): void; /** @@ -87463,6 +87363,7 @@ interface JQuery { * Can be any valid data source accepted by [$.ig.DataSource](ig.datasource), or an instance of an $.ig.DataSource itself * */ + igTreeGrid(optionLiteral: 'option', optionName: "dataSource"): Array|Object|string; /** @@ -87471,6 +87372,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGrid(optionLiteral: 'option', optionName: "dataSource", optionValue: Array|Object|string): void; /** @@ -87737,6 +87639,7 @@ interface JQuery { * Sets gets ability to automatically format text in cells for numeric and date columns. The format patterns and rules for numbers and dates are defined in $.ig.regional.defaults object. [Here column formatting is explained in details](http://www.igniteui.com/help/iggrid-columns-and-layout#column-formatting) * */ + igTreeGrid(optionLiteral: 'option', optionName: "autoFormat"): string|boolean; /** @@ -87745,6 +87648,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGrid(optionLiteral: 'option', optionName: "autoFormat", optionValue: string|boolean): void; /** @@ -87775,6 +87679,20 @@ interface JQuery { */ igTreeGrid(optionLiteral: 'option', optionName: "updateUrl", optionValue: string): void; + /** + * Settings related to REST compliant update routines. + * + */ + igTreeGrid(optionLiteral: 'option', optionName: "restSettings"): IgGridRestSettings; + + /** + * Settings related to REST compliant update routines. + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "restSettings", optionValue: IgGridRestSettings): void; + /** * Enables/disables rendering of alternating row styles (odd and even rows receive different styling). * @@ -87879,6 +87797,7 @@ interface JQuery { * Configures how the feature chooser icon should display on header cells - e.g. to display as gear icon or not. * */ + igTreeGrid(optionLiteral: 'option', optionName: "featureChooserIconDisplay"): string; /** @@ -87887,6 +87806,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGrid(optionLiteral: 'option', optionName: "featureChooserIconDisplay", optionValue: string): void; /** @@ -88294,7 +88214,7 @@ interface IgTreeGridMultiColumnHeadersMethods { * Expands a collapsed group. If the group is expanded, the method does nothing. * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * - * @param groupKey Group key. + * @param groupKey Group key. * @param callback Specifies a custom function to be called when the group is expanded. */ expandGroup(groupKey: string, callback?: Function): void; @@ -88794,14 +88714,14 @@ interface IgTreeGridPagingMethods { /** * Gets/Sets the current page index, delegates data binding and paging to [$.ig.DataSource](ig.datasource). * - * @param index The page index to go to. + * @param index The page index to go to. */ pageIndex(index?: number): number; /** * Gets/Sets the page size. If no parameter is specified, just returns the current page size. * - * @param size The new page size. + * @param size The new page size. */ pageSize(size?: number): number; } @@ -88820,6 +88740,7 @@ interface JQuery { * Sets gets paging mode. * */ + igTreeGridPaging(optionLiteral: 'option', optionName: "mode"): string; /** @@ -88828,12 +88749,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGridPaging(optionLiteral: 'option', optionName: "mode", optionValue: string): void; /** * When data flows to the next page there are a couple of different modes that can help communicate the context of a leaf level row. When mode option is "rootLevelOnly" then the context row always shows the value of the contextRowRootText option. * */ + igTreeGridPaging(optionLiteral: 'option', optionName: "contextRowMode"): string; /** @@ -88842,6 +88765,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGridPaging(optionLiteral: 'option', optionName: "contextRowMode", optionValue: string): void; /** @@ -88904,6 +88828,7 @@ interface JQuery { * Reference to the (or name of )function, called before rendering context row content(rendering loading message/bread crumb/parent row). The function takes 4 arguments- dataRow, $textArea- jQuery representation of the text area of the context row(when mode is loading/breadcrumb then it is otherwise ), array of parent rows and context mode - "loading"|"breadcrumb"|"parent". When the function returns string it is used as html set in $textArea. If the function does not return result or returns false/empty string then rendering of the content of the context row should be handled by the developer(similar to canceling rendering of context row content). * */ + igTreeGridPaging(optionLiteral: 'option', optionName: "renderContextRowFunc"): Function|string; /** @@ -88912,6 +88837,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGridPaging(optionLiteral: 'option', optionName: "renderContextRowFunc", optionValue: Function|string): void; /** @@ -88988,6 +88914,7 @@ interface JQuery { * Type of paging. Delegates all paging functionality to the [$.ig.DataSource](ig.datasource). * */ + igTreeGridPaging(optionLiteral: 'option', optionName: "type"): string; /** @@ -88996,6 +88923,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGridPaging(optionLiteral: 'option', optionName: "type", optionValue: string): void; /** @@ -89044,6 +88972,7 @@ interface JQuery { * Page size dropdown location, when [showPageSizeDropDown](ui.iggridpaging#options:showPageSizeDropDown) is set to true. Can be rendered above the grid header or inside the pager, next to the page links. * */ + igTreeGridPaging(optionLiteral: 'option', optionName: "pageSizeDropDownLocation"): string; /** @@ -89052,6 +88981,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGridPaging(optionLiteral: 'option', optionName: "pageSizeDropDownLocation", optionValue: string): void; /** @@ -89571,8 +89501,8 @@ interface IgTreeGridResizingMethods { /** * Resizes a column to a specified width in pixels, percents or auto if no width is specified. * - * @param column An identifier for the column. If a number is provided it will be used as a columnIndex else if a strings is provided it will be used as a columnKey. - * @param width Width of the column in pixels or percents. If no width or "*" is specified the column will be auto-sized to the width of the data in it (including header and footer cells). + * @param column An identifier for the column. If a number is provided it will be used as a columnIndex else if a strings is provided it will be used as a columnKey. + * @param width Width of the column in pixels or percents. If no width or "*" is specified the column will be auto-sized to the width of the data in it (including header and footer cells). */ resize(column: Object, width?: Object): void; } @@ -89814,30 +89744,30 @@ interface IgTreeGridRowSelectorsMethods { /** * Change the check state of a row by row id * - * @param rowId Row Id - * @param toCheck The new check state of the checkbox - true for checked or false for unchecked + * @param rowId Row Id + * @param toCheck The new check state of the checkbox - true for checked or false for unchecked */ changeCheckStateById(rowId: Object, toCheck: boolean): void; /** * Changes the check state of a row by index to specified value * - * @param index Row index - * @param toCheck The new check state of the checkbox - true for checked or false for unchecked + * @param index Row index + * @param toCheck The new check state of the checkbox - true for checked or false for unchecked */ changeCheckState(index: number, toCheck: boolean): void; /** * Toggles the check state of a row by row id * - * @param rowId Row Id + * @param rowId Row Id */ toggleCheckStateById(rowId: Object): void; /** * Toggles the check state of a row by index * - * @param index Row index + * @param index Row index */ toggleCheckState(index: number): void; @@ -89882,6 +89812,7 @@ interface JQuery { * Determines row numbering format. * */ + igTreeGridRowSelectors(optionLiteral: 'option', optionName: "rowSelectorNumberingMode"): string; /** @@ -89890,12 +89821,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGridRowSelectors(optionLiteral: 'option', optionName: "rowSelectorNumberingMode", optionValue: string): void; /** * Gets the type of checkboxes rendered in the row selector. Can be set only at initialization. * */ + igTreeGridRowSelectors(optionLiteral: 'option', optionName: "checkBoxMode"): string; /** @@ -89904,6 +89837,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGridRowSelectors(optionLiteral: 'option', optionName: "checkBoxMode", optionValue: string): void; /** @@ -89952,6 +89886,7 @@ interface JQuery { * Defines width of the row selector`s column in pixels or percentage. * */ + igTreeGridRowSelectors(optionLiteral: 'option', optionName: "rowSelectorColumnWidth"): string|number; /** @@ -89960,6 +89895,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGridRowSelectors(optionLiteral: 'option', optionName: "rowSelectorColumnWidth", optionValue: string|number): void; /** @@ -90225,7 +90161,7 @@ interface IgTreeGridSelectionMethods { /** * Selects a row by row id * - * @param id Row Id + * @param id Row Id */ selectRowById(id: Object): void; @@ -90237,55 +90173,55 @@ interface IgTreeGridSelectionMethods { /** * Selects a cell by row/col * - * @param row Row index - * @param col Column index - * @param isFixed If the cell is part of the fixed or unfixed area of the grid. + * @param row Row index + * @param col Column index + * @param isFixed If the cell is part of the fixed or unfixed area of the grid. */ selectCell(row: number, col: number, isFixed?: boolean): void; /** * Selects a cell by row id/column key * - * @param id Row Id - * @param colKey Column key + * @param id Row Id + * @param colKey Column key */ selectCellById(id: Object, colKey: string): void; /** * Deselects a cell by row/col * - * @param row Row index - * @param col Column index - * @param isFixed If the cell is part of the fixed or unfixed area of the grid. + * @param row Row index + * @param col Column index + * @param isFixed If the cell is part of the fixed or unfixed area of the grid. */ deselectCell(row: number, col: number, isFixed?: boolean): void; /** * Deselects a cell by row id/column key * - * @param id Row Id - * @param colKey Column key + * @param id Row Id + * @param colKey Column key */ deselectCellById(id: Object, colKey: string): void; /** * Selects a row by index * - * @param index Row index + * @param index Row index */ selectRow(index: number): void; /** * Deselects a row by index * - * @param index Row index + * @param index Row index */ deselectRow(index: number): void; /** * Deselects a row by row id * - * @param id Row Id + * @param id Row Id */ deselectRowById(id: Object): void; @@ -90381,6 +90317,7 @@ interface JQuery { * Defines type of the selection. * */ + igTreeGridSelection(optionLiteral: 'option', optionName: "mode"): string; /** @@ -90389,6 +90326,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGridSelection(optionLiteral: 'option', optionName: "mode", optionValue: string): void; /** @@ -90898,7 +90836,7 @@ interface IgTreeGridSortingMethods { /** * Returns whether a column with the specified columnKey is sorted(taken from the data source sorting expressions) * - * @param columnKey Column key (string) + * @param columnKey Column key (string) */ isColumnSorted(columnKey: string): boolean; destroy(): void; @@ -90906,8 +90844,8 @@ interface IgTreeGridSortingMethods { /** * Sorts the data in a grid column and updates the UI. * - * @param index Column key (string) or index (number) - for multi-row grid only column key can be used. Specifies the column which we want to sort. If the mode is multiple, previous sorting states are not cleared. - * @param direction Specifies sorting direction (ascending or descending) + * @param index Column key (string) or index (number) - for multi-row grid only column key can be used. Specifies the column which we want to sort. If the mode is multiple, previous sorting states are not cleared. + * @param direction Specifies sorting direction (ascending or descending) * @param header */ sortColumn(index: Object, direction: Object, header: Object): void; @@ -90925,8 +90863,8 @@ interface IgTreeGridSortingMethods { /** * Removes sorting for the grid column with the specified columnKey/columnIndex and updates the UI. * - * @param index Column key (string) or index (number) - for multi-row grid only column key can be used. Specifies the column for which we want to remove sorting. If the mode is multiple, previous sorting states are not cleared. - * @param header - if specified client events should be fired + * @param index Column key (string) or index (number) - for multi-row grid only column key can be used. Specifies the column for which we want to remove sorting. If the mode is multiple, previous sorting states are not cleared. + * @param header - if specified client events should be fired */ unsortColumn(index: Object, header: Object): void; @@ -91000,6 +90938,7 @@ interface JQuery { * Defines local or remote sorting operations. * */ + igTreeGridSorting(optionLiteral: 'option', optionName: "type"): string; /** @@ -91008,6 +90947,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGridSorting(optionLiteral: 'option', optionName: "type", optionValue: string): void; /** @@ -91084,6 +91024,7 @@ interface JQuery { * Defines single column sorting or multiple column sorting. * */ + igTreeGridSorting(optionLiteral: 'option', optionName: "mode"): string; /** @@ -91092,6 +91033,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGridSorting(optionLiteral: 'option', optionName: "mode", optionValue: string): void; /** @@ -91112,6 +91054,7 @@ interface JQuery { * Gets which direction to use on the first click / keydown, if the column is sorted for the first time. * */ + igTreeGridSorting(optionLiteral: 'option', optionName: "firstSortDirection"): string; /** @@ -91120,6 +91063,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGridSorting(optionLiteral: 'option', optionName: "firstSortDirection", optionValue: string): void; /** @@ -91222,6 +91166,7 @@ interface JQuery { * Gets width of multiple sorting dialog. * */ + igTreeGridSorting(optionLiteral: 'option', optionName: "modalDialogWidth"): string|number; /** @@ -91230,12 +91175,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGridSorting(optionLiteral: 'option', optionName: "modalDialogWidth", optionValue: string|number): void; /** * Gets height of multiple sorting dialog. * */ + igTreeGridSorting(optionLiteral: 'option', optionName: "modalDialogHeight"): string|number; /** @@ -91244,6 +91191,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGridSorting(optionLiteral: 'option', optionName: "modalDialogHeight", optionValue: string|number): void; /** @@ -91717,6 +91665,7 @@ interface JQuery { * Determines the tooltip visibility option * */ + igTreeGridTooltips(optionLiteral: 'option', optionName: "visibility"): string; /** @@ -91725,12 +91674,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGridTooltips(optionLiteral: 'option', optionName: "visibility", optionValue: string): void; /** * Controls the tooltip's style * */ + igTreeGridTooltips(optionLiteral: 'option', optionName: "style"): string; /** @@ -91739,6 +91690,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGridTooltips(optionLiteral: 'option', optionName: "style", optionValue: string): void; /** @@ -92179,23 +92131,23 @@ interface IgTreeGridUpdatingMethods { /** * Adds a new child to a specific row. It also creates a transaction and updates the UI. * - * @param values Pairs of values in the format { column1Key: value1, column2Key: value2, ... } . - * @param parentId The ID of the targeted row. + * @param values Pairs of values in the format { column1Key: value1, column2Key: value2, ... } . + * @param parentId The ID of the targeted row. */ addChild(values: Object, parentId: Object): void; /** * Starts editing for adding a new child for specific row. * - * @param parentId The ID of the targeted row. - * @param raiseEvents Specifies whether or not updating events should be raised for this operation. + * @param parentId The ID of the targeted row. + * @param raiseEvents Specifies whether or not updating events should be raised for this operation. */ startAddChildFor(parentId: Object, raiseEvents?: Object): void; /** * Shows the "Add Child" button for specific row. * - * @param row A jQuery object of the targeted row. + * @param row A jQuery object of the targeted row. */ showAddChildButtonFor(row: Object): void; @@ -92209,9 +92161,9 @@ interface IgTreeGridUpdatingMethods { * Sets a cell value for the specified cell. It also creates a transaction and updates the UI. * If the specified cell is currently in edit mode, the function will set the desired value in the cell's editor instead. * - * @param rowId The primary key of the row the cell is a child of. - * @param colKey The column key of the cell. - * @param value The new value for the cell. + * @param rowId The primary key of the row the cell is a child of. + * @param colKey The column key of the cell. + * @param value The new value for the cell. */ setCellValue(rowId: Object, colKey: string, value: Object): void; @@ -92219,46 +92171,46 @@ interface IgTreeGridUpdatingMethods { * Sets values for specified cells in a row. It also creates a transaction and updates the UI. * If the specified row is currently in edit mode, the function will set the desired values in the row's editors instead. * - * @param rowId The primary key of the row to update. - * @param values Pairs of values in the format { column1Key: value1, column2Key: value2, ... } . + * @param rowId The primary key of the row to update. + * @param values Pairs of values in the format { column1Key: value1, column2Key: value2, ... } . */ updateRow(rowId: Object, values: Object): void; /** * Adds a new row to the grid. It also creates a transaction and updates the UI. * - * @param values Pairs of values in the format { column1Key: value1, column2Key: value2, ... } . + * @param values Pairs of values in the format { column1Key: value1, column2Key: value2, ... } . */ addRow(values: Object): void; /** * Deletes a row from the grid. It also creates a transaction and updates the UI. * - * @param rowId The primary key of the row to delete. + * @param rowId The primary key of the row to delete. */ deleteRow(rowId: Object): void; /** * Starts editing for the row or cell specified (depending on the [editMode](ui.iggridupdating#options:editMode)). * - * @param rowId The row id. - * @param column The column key or index. - * @param raiseEvents Specifies whether or not updating events should be raised for this operation. + * @param rowId The row id. + * @param column The column key or index. + * @param raiseEvents Specifies whether or not updating events should be raised for this operation. */ startEdit(rowId: Object, column: Object, raiseEvents?: boolean): boolean; /** * Starts editing for adding a new row. * - * @param raiseEvents Specifies whether or not updating events should be raised for this operation. + * @param raiseEvents Specifies whether or not updating events should be raised for this operation. */ startAddRowEdit(raiseEvents?: boolean): boolean; /** * Ends the currently active edit mode. * - * @param update Specifies if the edit process should accept the current changes. Default is 'false'. - * @param raiseEvents Specifies whether or not updating events should be raised for this operation. + * @param update Specifies if the edit process should accept the current changes. Default is 'false'. + * @param raiseEvents Specifies whether or not updating events should be raised for this operation. */ endEdit(update?: boolean, raiseEvents?: boolean): boolean; @@ -92275,22 +92227,22 @@ interface IgTreeGridUpdatingMethods { /** * Gets the editor for a column by the column key. That method can be used only after the editor has been created. * - * @param key The key of the column. + * @param key The key of the column. */ editorForKey(key: string): Object; /** * Gets the editor for a column by the cell it resides in. If allowed the function can create the editor if it has not been created yet. * - * @param cell Reference to the jQuery-wrapped TD object of the grid that the editor belongs to. - * @param create Requests to create the editor if it has not been created yet. + * @param cell Reference to the jQuery-wrapped TD object of the grid that the editor belongs to. + * @param create Requests to create the editor if it has not been created yet. */ editorForCell(cell: string, create?: boolean): Object; /** * Shows the delete button for specific row. * - * @param row A jQuery object of the targeted row. + * @param row A jQuery object of the targeted row. */ showDeleteButtonFor(row: Object): void; @@ -92383,6 +92335,7 @@ interface JQuery { * Gets the edit mode. * */ + igTreeGridUpdating(optionLiteral: 'option', optionName: "editMode"): string; /** @@ -92391,6 +92344,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGridUpdating(optionLiteral: 'option', optionName: "editMode", optionValue: string): void; /** @@ -92579,6 +92533,7 @@ interface JQuery { * Gets how end-users are able to start edit mode. Possible values: "click", "dblclick", "F2", "enter" and their combinations separated by coma or in array. The keyboard triggers have effect only if the grid cells can receive focus (the grid's [tabIndex](ui.iggrid#options:tabIndex) property should not have a negative value) or Selection is enabled. If "dblclick" is included, then "click" has no effect. * */ + igTreeGridUpdating(optionLiteral: 'option', optionName: "startEditTriggers"): string|Array; /** @@ -92587,6 +92542,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGridUpdating(optionLiteral: 'option', optionName: "startEditTriggers", optionValue: string|Array): void; /** @@ -92621,6 +92577,7 @@ interface JQuery { * Sets a custom function to be called when the AJAX request to the URL specified by the [updateUrl](ui.iggrid#options:updateUrl) property succeeds. The function will be called with arguments representing the data returned by the server. * */ + igTreeGridUpdating(optionLiteral: 'option', optionName: "saveChangesSuccessHandler"): Function|string; /** @@ -92629,12 +92586,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGridUpdating(optionLiteral: 'option', optionName: "saveChangesSuccessHandler", optionValue: Function|string): void; /** * Sets a custom function to be called when the AJAX request to the URL specified by the [updateUrl](ui.iggrid#options:updateUrl) property fails. The function will be called with arguments representing the data returned by the server. * */ + igTreeGridUpdating(optionLiteral: 'option', optionName: "saveChangesErrorHandler"): Function|string; /** @@ -92643,12 +92602,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGridUpdating(optionLiteral: 'option', optionName: "saveChangesErrorHandler", optionValue: Function|string): void; /** * On touch-enabled devices specifies the swipe distance for the delete button to appear. * */ + igTreeGridUpdating(optionLiteral: 'option', optionName: "swipeDistance"): string|number; /** @@ -92657,6 +92618,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igTreeGridUpdating(optionLiteral: 'option', optionName: "swipeDistance", optionValue: string|number): void; /** @@ -93590,23 +93552,23 @@ interface IgUploadMethods { /** * Append additional data field to formData(before submitting it to the server). Usually this function is used in the handler of the event onFormDataSubmit. If the browser supports HTML5 file API formData is instance of FormData, otherwise(like IE10 and older) formData is jQuery representation of the
that should be submitted to the server * - * @param formData If the browser supports HTML5 file API formData is instance of FormData, otherwise(like IE10 and older) formData is jQuery representation of the that should be submitted to the server - * @param field Data field that should be appended to the formData. The object has 2 properties - value and name. If the browser supports HTML5 the data field is appended to the formData object. Otherwise it is appended as input hidden field to the + * @param formData If the browser supports HTML5 file API formData is instance of FormData, otherwise(like IE10 and older) formData is jQuery representation of the that should be submitted to the server + * @param field Data field that should be appended to the formData. The object has 2 properties - value and name. If the browser supports HTML5 the data field is appended to the formData object. Otherwise it is appended as input hidden field to the */ addDataField(formData: Object, field: Object): void; /** * Append additional data fields to formData(before submitting it to the server). Usually this function is used in the handler of the event onFormDataSubmit. If the browser supports HTML5 file API formData is instance of FormData, otherwise(like IE10 and older) formData is jQuery representation of the that should be submitted to the server * - * @param formData If the browser supports HTML5 file API formData is instance of FormData, otherwise(like IE10 and older) formData is jQuery representation of the that should be submitted to the server - * @param fields Array of data fields that should be appended to the formData. Each data field is object with 2 properties - value and name. If the browser supports HTML5 these data fields are added to the formData. Otherwise each of these data field is appended as input hidden field to the + * @param formData If the browser supports HTML5 file API formData is instance of FormData, otherwise(like IE10 and older) formData is jQuery representation of the that should be submitted to the server + * @param fields Array of data fields that should be appended to the formData. Each data field is object with 2 properties - value and name. If the browser supports HTML5 these data fields are added to the formData. Otherwise each of these data field is appended as input hidden field to the */ addDataFields(formData: Object, fields: any[]): void; /** * Start uploading file as submitting form with the specified formNumber. * - * @param formNumber id of the upload form + * @param formNumber id of the upload form */ startUpload(formNumber: number): void; @@ -93614,7 +93576,7 @@ interface IgUploadMethods { * Cancel upload for the specified file id * formNumber - id of the file to be canceled * - * @param formNumber id of the form which should be cancelled + * @param formNumber id of the form which should be cancelled */ cancelUpload(formNumber: number): void; @@ -93636,7 +93598,7 @@ interface IgUploadMethods { /** * Returns the information about the file by specified file identifier. It could be file which is uploading/uploaded or uploading is not started. If there isn"t file with the specified file id returns null * - * @param fileIndex unique identifier of the file + * @param fileIndex unique identifier of the file */ getFileInfo(fileIndex: number): Object; } @@ -93648,21 +93610,9 @@ interface JQuery { igBrowseButton(methodName: "attachFilePicker", e: Object, isHidden: Object): void; igBrowseButton(methodName: "getFilePicker"): void; igBrowseButton(methodName: "destroy"): void; - - /** - */ igBrowseButton(optionLiteral: 'option', optionName: "autoselect"): boolean; - - /** - */ igBrowseButton(optionLiteral: 'option', optionName: "autoselect", optionValue: boolean): void; - - /** - */ igBrowseButton(optionLiteral: 'option', optionName: "multipleFiles"): boolean; - - /** - */ igBrowseButton(optionLiteral: 'option', optionName: "multipleFiles", optionValue: boolean): void; /** @@ -93699,6 +93649,7 @@ interface JQuery { * Get or set width of the main container of the file upload control. Main container contains all buttons, progressbar, etc. * */ + igUpload(optionLiteral: 'option', optionName: "width"): number|string; /** @@ -93707,12 +93658,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igUpload(optionLiteral: 'option', optionName: "width", optionValue: number|string): void; /** * Get or set height of the main container of the file upload control. Main container contains all buttons, progressbar, etc. * */ + igUpload(optionLiteral: 'option', optionName: "height"): number|string; /** @@ -93721,6 +93674,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igUpload(optionLiteral: 'option', optionName: "height", optionValue: number|string): void; /** @@ -94766,7 +94720,6 @@ interface IgValidator { * Gets/Sets number validation rule options.Default separators for decimals and thousands are '.' and ',' respectively and are defined in the "$.ui.igValidator.defaults" object. * * - * * Valid values: * "boolean" A boolean value indicating if the field should be a number. Default separators are used. * "object" A configuration object with errorMessage, decimalSeparator and thousandsSeparator. Those properties are all optional. @@ -94777,7 +94730,6 @@ interface IgValidator { * Gets/Sets date validation rule options. This can additionally help guide the [valueRange](ui.igvalidator#options:valueRange) validation.Note: Dependat on JavaScript Date parsing which will accept a wide range of values. * * - * * Valid values: * "boolean" A boolean value indicating if the field should be a valid JavaScript Date or can be parsed as one. * "object" A configuration object with optional error message (e.g. date: { errorMessage: "Enter a valid number"} ) @@ -94818,7 +94770,6 @@ interface IgValidator { * Gets/Sets Credit Card number validation rule options.Note: This rule will only validate the checksum of the number using Luhn algorithm irregardless of card type. * * - * * Valid values: * "boolean" A boolean value indicating if the field should be a valid Credit Card number. * "object" A configuration object with optional error message (e.g. creditCard: { errorMessage: "Enter a valid card number"} ) @@ -95096,14 +95047,14 @@ interface IgValidatorMethods { /** * Trigger validation and show errors for invalid fields. * - * @param field Optional field object, its selector or zero-based index to check. Only has effect with fields collection and skips other fields. + * @param field Optional field object, its selector or zero-based index to check. Only has effect with fields collection and skips other fields. */ validate(field?: Object): boolean; /** * Trigger validation but do not display error messages. * - * @param field Optional field object, its selector or zero-based index to check. Only has effect with fields collection and skips other fields. + * @param field Optional field object, its selector or zero-based index to check. Only has effect with fields collection and skips other fields. */ isValid(field?: Object): boolean; @@ -95111,7 +95062,7 @@ interface IgValidatorMethods { * Hide any possible message(s) (either messageTarget or igNotifier). * Note: When the validator has a fields colleciton, not passing a field will hide messages on all fields. * - * @param field Optional field object, its selector or zero-based index to hide message for. + * @param field Optional field object, its selector or zero-based index to hide message for. */ hide(field?: Object): void; @@ -95119,7 +95070,7 @@ interface IgValidatorMethods { * Gets all current error messages for invalid field(s). Note that this method does not valdiate and states and messages are only updated on validation, so * this can be used on formValidated event or after validate/isValid method calls. * - * @param field Optional field object, selector or zero-based index for a single field to get error message for. + * @param field Optional field object, selector or zero-based index for a single field to get error message for. */ getErrorMessages(field?: Object): any[]; @@ -95127,36 +95078,36 @@ interface IgValidatorMethods { * Check for currently displayed message(s). Takes an optional field. * Note: When the validator has a fields colleciton, not passing a field will return a cumulative true even if just one field has a visible message. * - * @param field Optional field object, selector or zero-based index for a single field to get error message for. + * @param field Optional field object, selector or zero-based index for a single field to get error message for. */ isMessageDisplayed(field?: Object): boolean; /** * Gets the notifier for the igValidator or for a single filed. * - * @param field Optional field object, its selector or zero-based index to get notifier for. + * @param field Optional field object, its selector or zero-based index to get notifier for. */ notifier(field?: Object): Object; /** * Adds an new input to the fields collection and initializes it with the validator. Note: Additional fields are only accepted if the validator has been created with the collection. * - * @param field An object with the field selector and options. + * @param field An object with the field selector and options. */ addField(field: Object): void; /** * Removes an input from the fields collection. * - * @param field The field object to remove, its zero-based index or selector. + * @param field The field object to remove, its zero-based index or selector. */ removeField(field: Object): void; /** * Updates a field in the validator collection. Used to reinitialize field in case a control has been created after the validator or to pass in new options. * - * @param field The field object to update, its zero-based index or selector. - * @param fieldOptions New options to apply to the field. + * @param field The field object to update, its zero-based index or selector. + * @param fieldOptions New options to apply to the field. */ updateField(field: Object, fieldOptions?: Object): void; @@ -95172,6 +95123,7 @@ interface JQuery { declare namespace Infragistics { class IgValidatorBaseRule { constructor(name: string); + constructor(formatItems: any[]); /** @@ -95192,15 +95144,15 @@ class IgValidatorBaseRule { /** * Formats an error message using rule-specific values (usually from formatItems). * - * @param message The unformatted error message the validator intends to display. + * @param message The unformatted error message the validator intends to display. */ formatMessage(message: string): string; /** * Validates a value against this rule and returns the result. * - * @param options Options for the validator, if fields are used this parameter is already populated with inherited ones. - * @param value The value to check. + * @param options Options for the validator, if fields are used this parameter is already populated with inherited ones. + * @param value The value to check. */ isValid(options: Object, value: Object): boolean; } @@ -95212,8 +95164,11 @@ IgValidatorBaseRule: typeof Infragistics.IgValidatorBaseRule; declare namespace Infragistics { class IgValidatorRequiredRule { constructor(name: string); + constructor(groupTypes: any[]); + constructor(groupMessageName: string); + constructor(formatItems: any[]); getMessageType(options: Object): void; isValid(options: Object, value: Object): void; @@ -95228,7 +95183,7 @@ class IgValidatorRequiredRule { /** * Formats an error message using rule-specific values (usually from formatItems). * - * @param message The unformatted error message the validator intends to display. + * @param message The unformatted error message the validator intends to display. */ formatMessage(message: string): string; } @@ -95240,6 +95195,7 @@ IgValidatorRequiredRule: typeof Infragistics.IgValidatorRequiredRule; declare namespace Infragistics { class IgValidatorControlRule { constructor(name: string); + constructor(formatItems: any[]); getMessageType(): void; @@ -95254,7 +95210,7 @@ class IgValidatorControlRule { /** * Formats an error message using rule-specific values (usually from formatItems). * - * @param message The unformatted error message the validator intends to display. + * @param message The unformatted error message the validator intends to display. */ formatMessage(message: string): string; } @@ -95266,6 +95222,7 @@ IgValidatorControlRule: typeof Infragistics.IgValidatorControlRule; declare namespace Infragistics { class IgValidatorNumberRule { constructor(name: string); + constructor(formatItems: any[]); isValid(options: Object, value: Object): void; @@ -95287,7 +95244,7 @@ class IgValidatorNumberRule { /** * Formats an error message using rule-specific values (usually from formatItems). * - * @param message The unformatted error message the validator intends to display. + * @param message The unformatted error message the validator intends to display. */ formatMessage(message: string): string; } @@ -95299,6 +95256,7 @@ IgValidatorNumberRule: typeof Infragistics.IgValidatorNumberRule; declare namespace Infragistics { class IgValidatorDateRule { constructor(name: string); + constructor(formatItems: any[]); isValid(options: Object, value: Object): void; @@ -95320,7 +95278,7 @@ class IgValidatorDateRule { /** * Formats an error message using rule-specific values (usually from formatItems). * - * @param message The unformatted error message the validator intends to display. + * @param message The unformatted error message the validator intends to display. */ formatMessage(message: string): string; } @@ -95332,6 +95290,7 @@ IgValidatorDateRule: typeof Infragistics.IgValidatorDateRule; declare namespace Infragistics { class IgValidatorLengthRule { constructor(name: string); + constructor(formatItems: any[]); getMessageType(): void; isValid(options: Object, value: Object): void; @@ -95346,7 +95305,7 @@ class IgValidatorLengthRule { /** * Formats an error message using rule-specific values (usually from formatItems). * - * @param message The unformatted error message the validator intends to display. + * @param message The unformatted error message the validator intends to display. */ formatMessage(message: string): string; } @@ -95358,6 +95317,7 @@ IgValidatorLengthRule: typeof Infragistics.IgValidatorLengthRule; declare namespace Infragistics { class IgValidatorValueRule { constructor(name: string); + constructor(formatItems: any[]); getMessageType(): void; isValid(options: Object, value: Object): void; @@ -95370,6 +95330,7 @@ IgValidatorValueRule: typeof Infragistics.IgValidatorValueRule; declare namespace Infragistics { class IgValidatorEqualToRule { constructor(name: string); + constructor(formatItems: any[]); isValid(options: Object, value: Object): void; @@ -95391,7 +95352,7 @@ class IgValidatorEqualToRule { /** * Formats an error message using rule-specific values (usually from formatItems). * - * @param message The unformatted error message the validator intends to display. + * @param message The unformatted error message the validator intends to display. */ formatMessage(message: string): string; } @@ -95403,6 +95364,7 @@ IgValidatorEqualToRule: typeof Infragistics.IgValidatorEqualToRule; declare namespace Infragistics { class IgValidatorEmailRule { constructor(name: string); + constructor(formatItems: any[]); isValid(options: Object, value: Object): void; @@ -95424,7 +95386,7 @@ class IgValidatorEmailRule { /** * Formats an error message using rule-specific values (usually from formatItems). * - * @param message The unformatted error message the validator intends to display. + * @param message The unformatted error message the validator intends to display. */ formatMessage(message: string): string; } @@ -95436,6 +95398,7 @@ IgValidatorEmailRule: typeof Infragistics.IgValidatorEmailRule; declare namespace Infragistics { class IgValidatorPatternRule { constructor(name: string); + constructor(formatItems: any[]); isValid(options: Object, value: Object): void; @@ -95457,7 +95420,7 @@ class IgValidatorPatternRule { /** * Formats an error message using rule-specific values (usually from formatItems). * - * @param message The unformatted error message the validator intends to display. + * @param message The unformatted error message the validator intends to display. */ formatMessage(message: string): string; } @@ -95469,6 +95432,7 @@ IgValidatorPatternRule: typeof Infragistics.IgValidatorPatternRule; declare namespace Infragistics { class IgValidatorCustomRule { constructor(name: string); + constructor(formatItems: any[]); getMessageType(): void; isValid(options: Object, value: Object): void; @@ -95483,7 +95447,7 @@ class IgValidatorCustomRule { /** * Formats an error message using rule-specific values (usually from formatItems). * - * @param message The unformatted error message the validator intends to display. + * @param message The unformatted error message the validator intends to display. */ formatMessage(message: string): string; } @@ -95495,12 +95459,13 @@ IgValidatorCustomRule: typeof Infragistics.IgValidatorCustomRule; declare namespace Infragistics { class IgValidatorCreditCardRule { constructor(name: string); + constructor(formatItems: any[]); /** * Based on ASP.NET CreditCardAttribute check, * https://github.com/Microsoft/referencesource/blob/master/System.ComponentModel.DataAnnotations/DataAnnotations/CreditCardAttribute.cs - * using Luhn algorithm https://en.wikipedia.org/wiki/Luhn_algorithm + * using Luhn algorithm https://en.wikipedia.org/wiki/Luhn_algorithm * * @param options * @param value @@ -95525,7 +95490,7 @@ class IgValidatorCreditCardRule { /** * Formats an error message using rule-specific values (usually from formatItems). * - * @param message The unformatted error message the validator intends to display. + * @param message The unformatted error message the validator intends to display. */ formatMessage(message: string): string; } @@ -95598,6 +95563,7 @@ interface JQuery { * Gets/Sets option to validate if a value was entered (not empty text, selected item, etc.) * */ + igValidator(optionLiteral: 'option', optionName: "required"): boolean|Object; /** @@ -95606,44 +95572,46 @@ interface JQuery { * * @optionValue New value to be set. */ + igValidator(optionLiteral: 'option', optionName: "required", optionValue: boolean|Object): void; /** * Gets/Sets number validation rule options.Default separators for decimals and thousands are '.' and ',' respectively and are defined in the "$.ui.igValidator.defaults" object. * - * */ + igValidator(optionLiteral: 'option', optionName: "number"): boolean|Object; /** * /Sets number validation rule options.Default separators for decimals and thousands are '.' and ',' respectively and are defined in the "$.ui.igValidator.defaults" object. * * - * * @optionValue New value to be set. */ + igValidator(optionLiteral: 'option', optionName: "number", optionValue: boolean|Object): void; /** * Gets/Sets date validation rule options. This can additionally help guide the [valueRange](ui.igvalidator#options:valueRange) validation.Note: Dependat on JavaScript Date parsing which will accept a wide range of values. * - * */ + igValidator(optionLiteral: 'option', optionName: "date"): boolean|Object; /** * /Sets date validation rule options. This can additionally help guide the [valueRange](ui.igvalidator#options:valueRange) validation.Note: Dependat on JavaScript Date parsing which will accept a wide range of values. * * - * * @optionValue New value to be set. */ + igValidator(optionLiteral: 'option', optionName: "date", optionValue: boolean|Object): void; /** * Gets/Sets email validation rule options. Uses a RegExp defined in the "$.ui.igValidator.defaults" object. * */ + igValidator(optionLiteral: 'option', optionName: "email"): boolean|Object; /** @@ -95652,12 +95620,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igValidator(optionLiteral: 'option', optionName: "email", optionValue: boolean|Object): void; /** * Gets/Sets a minimum and/or maximum length of text or number of selected items. Null or 0 values are ignored. * */ + igValidator(optionLiteral: 'option', optionName: "lengthRange"): Array|Object; /** @@ -95666,12 +95636,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igValidator(optionLiteral: 'option', optionName: "lengthRange", optionValue: Array|Object): void; /** * Gets/Sets a minimum and/or maximum value. Null values are ignored. * */ + igValidator(optionLiteral: 'option', optionName: "valueRange"): Array|Object; /** @@ -95680,28 +95652,30 @@ interface JQuery { * * @optionValue New value to be set. */ + igValidator(optionLiteral: 'option', optionName: "valueRange", optionValue: Array|Object): void; /** * Gets/Sets Credit Card number validation rule options.Note: This rule will only validate the checksum of the number using Luhn algorithm irregardless of card type. * - * */ + igValidator(optionLiteral: 'option', optionName: "creditCard"): boolean|Object; /** * /Sets Credit Card number validation rule options.Note: This rule will only validate the checksum of the number using Luhn algorithm irregardless of card type. * * - * * @optionValue New value to be set. */ + igValidator(optionLiteral: 'option', optionName: "creditCard", optionValue: boolean|Object): void; /** * Gets/Sets regular expression validation rule options. * */ + igValidator(optionLiteral: 'option', optionName: "pattern"): string|Object; /** @@ -95710,6 +95684,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igValidator(optionLiteral: 'option', optionName: "pattern", optionValue: string|Object): void; /** @@ -95774,6 +95749,7 @@ interface JQuery { * Gets/Sets a requirement for the value in this field to be the same as another input element or editor control. * */ + igValidator(optionLiteral: 'option', optionName: "equalTo"): string|Object; /** @@ -95782,12 +95758,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igValidator(optionLiteral: 'option', optionName: "equalTo", optionValue: string|Object): void; /** * Gets/Sets a custom function to perform validation. Use 'this' to reference the calling validator and the value and optional field settings arguments to determine and return the state of the field. * */ + igValidator(optionLiteral: 'option', optionName: "custom"): Function|string|Object; /** @@ -95796,6 +95774,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igValidator(optionLiteral: 'option', optionName: "custom", optionValue: Function|string|Object): void; /** @@ -97014,21 +96993,21 @@ interface IgVideoPlayerMethods { /** * Play a linked commercial for this video. * - * @param commercial Specify the linked commercial to play. + * @param commercial Specify the linked commercial to play. */ playCommercial(commercial: Object): void; /** * Shows the ad banner, if there is such. * - * @param index Specify the index of the banner from the banners array. + * @param index Specify the index of the banner from the banners array. */ showBanner(index: number): void; /** * Hide the ad banner, if there is such. * - * @param index Specify the index of the banner from the banners array. + * @param index Specify the index of the banner from the banners array. */ hideBanner(index: number): void; @@ -97055,14 +97034,14 @@ interface IgVideoPlayerMethods { /** * Gets/Sets the current time of the playing video. * - * @param val Specify the playback position in seconds to navigate to. + * @param val Specify the playback position in seconds to navigate to. */ currentTime(val: number): number; /** * Get a screenshot of the current video frame. It returns a canvas object that you can position and show on the page. This depends on the browser support for canvas. * - * @param scaleFactor Specify scale factor between 0 and 1. + * @param scaleFactor Specify scale factor between 0 and 1. */ screenshot(scaleFactor?: number): Object; @@ -97155,6 +97134,7 @@ interface JQuery { * Gets/Sets the width of the control. By default null will stretch the control to fit data, if no other widths are defined. * */ + igVideoPlayer(optionLiteral: 'option', optionName: "width"): string|number; /** @@ -97163,12 +97143,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igVideoPlayer(optionLiteral: 'option', optionName: "width", optionValue: string|number): void; /** * Gets/Sets the height of the control. By default null will stretch the control to fit data, if no other heights are defined. * */ + igVideoPlayer(optionLiteral: 'option', optionName: "height"): string|number; /** @@ -97177,6 +97159,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igVideoPlayer(optionLiteral: 'option', optionName: "height", optionValue: string|number): void; /** @@ -98030,8 +98013,8 @@ interface IgZoombarMethods { /** * Gets or sets the current zoom window * - * @param left The left parameter of the new zoom window in percentages - * @param width The width parameter of the new zoom window in percentages + * @param left The left parameter of the new zoom window in percentages + * @param width The width parameter of the new zoom window in percentages */ zoom(left?: number, width?: number): Object; } @@ -98077,22 +98060,22 @@ class ZoombarProviderDefault { /** * Gets basic options for initializing the clone, based on the options the target is initialized with * - * @param options if the Zoombar has a copy of the options object it'll pass it to the provider + * @param options if the Zoombar has a copy of the options object it'll pass it to the provider */ getBaseOpts(options: Object): void; /** * Alters specific options so that the the clone is more suitable for its purpose * - * @param options the base options of the widget obtained from getBaseOpts + * @param options the base options of the widget obtained from getBaseOpts */ cleanOptsForZoom(options: Object): void; /** * Will be called by the Zoombar if a clone of the target widget should be created * - * @param container a jQuery wrapped element to create the clone component in - * @param options the options that are obtained from cleanOptsForZoom + * @param container a jQuery wrapped element to create the clone component in + * @param options the options that are obtained from cleanOptsForZoom */ createClone(container: Object, options: Object): void; @@ -98109,22 +98092,22 @@ class ZoombarProviderDefault { /** * Sets the target widget min window width (to be in sync with the same property of the zoombar) * - * @param minWidth a number from 0 to 1 representing the minimal width (i.e. maximal zoom) the zoom window can take as a fraction of the total one + * @param minWidth a number from 0 to 1 representing the minimal width (i.e. maximal zoom) the zoom window can take as a fraction of the total one */ syncMinWidth(minWidth: number): void; /** * Sets the width and height of the clone component * - * @param width The width to set in pixels or string (px or % -affixed). - * @param height The height to set in pixels or string (px or % -affixed). + * @param width The width to set in pixels or string (px or % -affixed). + * @param height The height to set in pixels or string (px or % -affixed). */ setSize(width: Object, height: Object): void; /** * Gets/sets the target object * - * @param obj the new target component instance to set + * @param obj the new target component instance to set */ targetObject(obj?: Object): void; @@ -98187,6 +98170,7 @@ interface JQuery { * object A valid jQuery object, the first element of which is that element. * */ + igZoombar(optionLiteral: 'option', optionName: "target"): string|Object; /** @@ -98196,6 +98180,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igZoombar(optionLiteral: 'option', optionName: "target", optionValue: string|Object): void; /** @@ -98203,6 +98188,7 @@ interface JQuery { * object A valid set of properties to initialize the clone with. * */ + igZoombar(optionLiteral: 'option', optionName: "clone"): string|Object; /** @@ -98212,12 +98198,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igZoombar(optionLiteral: 'option', optionName: "clone", optionValue: string|Object): void; /** * Gets the width of the Zoombar. * */ + igZoombar(optionLiteral: 'option', optionName: "width"): string|number; /** @@ -98226,12 +98214,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igZoombar(optionLiteral: 'option', optionName: "width", optionValue: string|number): void; /** * Gets the height of the Zoombar. * */ + igZoombar(optionLiteral: 'option', optionName: "height"): number|string; /** @@ -98240,12 +98230,14 @@ interface JQuery { * * @optionValue New value to be set. */ + igZoombar(optionLiteral: 'option', optionName: "height", optionValue: number|string): void; /** * Gets when the zoom effect is applied. * */ + igZoombar(optionLiteral: 'option', optionName: "zoomAction"): string; /** @@ -98254,6 +98246,7 @@ interface JQuery { * * @optionValue New value to be set. */ + igZoombar(optionLiteral: 'option', optionName: "zoomAction", optionValue: string): void; /** @@ -98469,27 +98462,27 @@ interface JQuery { } interface IgLoader { - scriptPath: string; - cssPath: string; - resources?: string; - theme?: string; - ready?: Function; - localePath?: string; - locale?: string; - autoDetectLocale?: boolean; - regional?: string; - preinit?: Function; + scriptPath: string; + cssPath: string; + resources?: string; + theme?: string; + ready?: Function; + localePath?: string; + locale?: string; + autoDetectLocale?: boolean; + regional?: string; + preinit?: Function; } interface IgniteUIStatic { - tmpl(template: string, data: any, ...args: any[]): string; - loader(options: IgLoader): void; - loader(callback: Function): void; - loader(resources: string, callback: Function): void; - loader(): any; - OlapUtilities: any; + tmpl(template: string, data: any, ...args: any[]): string; + loader(options: IgLoader): void; + loader(callback: Function): void; + loader(resources: string, callback: Function): void; + loader(): any; + OlapUtilities: any; } interface JQueryStatic { - ig: IgniteUIStatic; + ig: IgniteUIStatic; }