diff --git a/types/ignite-ui/index.d.ts b/types/ignite-ui/index.d.ts index d93cb1f9e6..970875a49b 100644 --- a/types/ignite-ui/index.d.ts +++ b/types/ignite-ui/index.d.ts @@ -227,6 +227,46 @@ interface DataSourceSettingsGroupby { */ defaultCollapseState?: boolean; + /** + * The name of the property that determines whether a record from the group data view is a group record. + * + */ + groupRecordKey?: string; + + /** + * The name of the property that determines whether a record from the group data view is a summary group record. + * + */ + groupSummaryRecordKey?: string; + + /** + * Array of objects containing the summaries for each field. + * Each summary object has the following format { field:"fieldName", summaryFunctions: [] }, where the summaryFunctions arrays can contain either a summary name (avg, sum, count etc.) or a custom function for caclulating a custom summary. + * + */ + summaries?: any[]; + + /** + * Specifies the postion for the summaries for each field inside each group. + * + * + * Valid values: + * "top" One summary row will be displayed at the top for each group + * "bottom" One summary row will be displayed at the bottom for each group + * "both" Two summary rows will be be display for each group. One on the top and one on the bottom. + */ + summariesPosition?: string; + + /** + * . Specifies how paging should be applied when there is at least one grouped column + * + * + * Valid values: + * "allRecords" Paging is applied for all records - data and non-data records(like group-by records) + * "dataRecordsOnly" Paging is applied ONLY for data records. Non-data records are disregarded in paging calculations. + */ + pagingMode?: string; + /** * Option for DataSourceSettingsGroupby */ @@ -531,476 +571,497 @@ interface DataSourceSettings { } declare namespace Infragistics { - class DataSource { - constructor(settings: DataSourceSettings); +class DataSource { + constructor(settings: DataSourceSettings); - /** - * 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' } - */ - fields(fields?: 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' } + */ + fields(fields?: Object): Object; - /** - * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type - */ - analyzeDataSource(): string; + /** + * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type + */ + analyzeDataSource(): string; - /** - * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView - */ - dataView(): any[]; + /** + * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView + */ + dataView(): any[]; - /** - * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. - */ - data(): Object; + /** + * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. + */ + data(): Object; - /** - * Returns transformed data according to transformed execution: - * 1. Before paging and filtering - * 2. After filtering before paging - * 3. After filtering and paging - * - * @param transformedExecution - */ - transformedData(transformedExecution: Object): Object; + /** + * Returns transformed data according to transformed execution: + * 1. Before paging and filtering + * 2. After filtering before paging + * 3. After filtering and paging + * + * @param transformedExecution + */ + transformedData(transformedExecution: Object): Object; - /** - * Returns summaries data - */ - dataSummaries(): Object; + /** + * Returns summaries data + */ + dataSummaries(): Object; - /** - * Gets/sets the schema definition. - * - * @param s a schema object - * @param t type of the data source. See settings.type - */ - schema(s?: Object, t?: string): void; + /** + * Gets/sets the schema definition. + * + * @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 - */ - pagingSettings(p?: Object): Object; + /** + * Gets/sets a list of paging settings + * + * @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 - */ - filterSettings(f?: Object): void; + /** + * Gets/sets a list of filtering settings + * + * @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 - */ - sortSettings(s?: Object): Object; + /** + * Gets/sets a list of paging settings + * + * @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 - */ - summariesSettings(s?: Object): void; + /** + * Gets/sets a list of summaries settings. + * + * @param s object holding all summaries settings. See settings.summaries + */ + summariesSettings(s?: Object): void; - /** - * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource - * - * @param ds - */ - dataSource(ds?: Object): Object; + /** + * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource + * + * @param ds + */ + dataSource(ds?: Object): Object; - /** - * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type - * - * @param t - * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty - */ - type(t?: Object): string; + /** + * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type + * + * @param t + * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty + */ + type(t?: Object): string; - /** - * 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 - */ - findRecordByKey(key: string, ds?: string, objPath?: string): Object; + /** + * 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 + */ + 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 origDs - */ - removeRecordByKey(key: Object, origDs: Object): void; + /** + * 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 origDs + */ + removeRecordByKey(key: Object, origDs: Object): void; - /** - * Removes a record from the data source at specific index. - * - * @param index index of record - * @param origDs - */ - removeRecordByIndex(index: number, origDs: Object): void; + /** + * Removes a record from the data source at specific index. + * + * @param index index of record + * @param origDs + */ + removeRecordByIndex(index: number, origDs: Object): void; - /** - * 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 - */ - setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; + /** + * 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 + */ + 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 - */ - updateRow(rowId: Object, rowObject: 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 + */ + 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 - */ - 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 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 - */ - insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: 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 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 - */ - deleteRow(rowId: Object, autoCommit: boolean): 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 + */ + 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 - */ - addNode(data: Object): void; + /** + * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back + * + * @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 - */ - removeNode(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 + */ + 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 - */ - getDetachedRecord(t: Object): Object; + /** + * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source + * + * @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. - */ - commit(id?: number): void; + /** + * 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. + */ + 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. - */ - rollback(id?: Object): 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. + */ + rollback(id?: Object): void; - /** - * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source - */ - pendingTransactions(): any[]; + /** + * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source + */ + pendingTransactions(): any[]; - /** - * Returns a list of all transaction objects that are either pending, or have been committed in the data source. - */ - allTransactions(): any[]; + /** + * Returns a list of all transaction objects that are either pending, or have been committed in the data source. + */ + allTransactions(): any[]; - /** - * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently - */ - transactionsAsString(): string; + /** + * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently + */ + transactionsAsString(): string; - /** - * 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) - */ - saveChanges(success: Function, error: Function): 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) + */ + saveChanges(success: Function, error: Function): void; - /** - * Data binds to the current data source - * databinding works using the following workflow: - * 1. fire the databinding event - * 2. based on the data source type (see analyzeDataSource()), do the following: - * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. - * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting - * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. - * if no paging/sorting/filtering are enabled, use just this._data to save space - * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL - * if the data source is invalid, throw an exception - * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if - * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree - * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion - * 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 - */ - dataBind(callback?: string, callee?: Object): void; + /** + * Data binds to the current data source + * databinding works using the following workflow: + * 1. fire the databinding event + * 2. based on the data source type (see analyzeDataSource()), do the following: + * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. + * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting + * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. + * if no paging/sorting/filtering are enabled, use just this._data to save space + * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL + * if the data source is invalid, throw an exception + * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if + * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree + * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion + * 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 + */ + 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 - */ - getCellValue(fieldName: string, record: Object): Object; + /** + * 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 + */ + getCellValue(fieldName: string, record: Object): Object; - /** - * Applicable only when the data source is bound to remote data. - * Gets or sets summaries data. - * 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) - */ - summariesResponse(key?: string, dsObj?: Object): Object; + /** + * Applicable only when the data source is bound to remote data. + * Gets or sets summaries data. + * 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) + */ + summariesResponse(key?: string, dsObj?: Object): Object; - /** - * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. - */ - filteredData(): any[]; + /** + * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. + */ + filteredData(): any[]; - /** - * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). - * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions - * multi-column sorting can be enabled by setting keepSortState to true. - * 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 - */ - sort(fields: Object, direction: string): void; + /** + * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). + * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions + * multi-column sorting can be enabled by setting keepSortState to true. + * 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 + */ + sort(fields: Object, direction: string): void; - /** - * This clears local sorting applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalSorting(): void; + /** + * This clears local sorting applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalSorting(): void; - /** - * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and - * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() - * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] - * expr is the filter expression text , such as "abc", or a regular expression such as *test* - * 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 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: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; + /** + * 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. + */ + filterByText(expression: string, fields?: any[]): void; - /** - * This clears local filtering applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalFilter(): void; + /** + * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and + * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() + * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] + * example 3: [{filterAllFields: true, expr: "abc", fields: [name: "Description", type: "string"]}] + * expr is the filter expression text , such as "abc", or a regular expression such as *test* + * 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: + * + * @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. + */ + filter(fieldExpressions: any[], boolLogic: Object, keepFilterState: Object, fieldExpressionsOnStrings: Object): void; - /** - * Applicable only when the data source is bound to remote data. - * Gets / sets the total number of records in the data source. - * If data binding is remote, and there's paging or filtering enabled, - * 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 key - * @param dsObj - * @param context - */ - totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; + /** + * This clears local filtering applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalFilter(): void; - /** - * 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 - */ - hasTotalRecordsCount(hasCount: boolean): void; + /** + * Applicable only when the data source is bound to remote data. + * Gets / sets the total number of records in the data source. + * If data binding is remote, and there's paging or filtering enabled, + * 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 key + * @param dsObj + * @param context + */ + totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; - /** - * Returns metadata object for the specified key - * - * @param key Primary key of the record - */ - metadata(key: string): Object; + /** + * 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 + */ + hasTotalRecordsCount(hasCount: boolean): void; - /** - * Returns the total number of records in the local data source - */ - totalLocalRecordsCount(): number; + /** + * Returns metadata object for the specified key + * + * @param key Primary key of the record + */ + metadata(key: string): Object; - /** - * Returns the total number of pages - */ - pageCount(): number; + /** + * Returns the total number of records in the local data source + */ + totalLocalRecordsCount(): number; - /** - * 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. - */ - pageIndex(index?: number): number; + /** + * Returns the total number of pages + */ + pageCount(): 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. - */ - persistedPageIndex(value?: number): number; + /** + * 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. + */ + pageIndex(index?: number): number; - /** - * Sets the page index to be equal to the previous page index and rebinds the data source - */ - prevPage(): void; + /** + * 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. + */ + persistedPageIndex(value?: number): number; - /** - * Sets the page index to be equal to the next page index and rebinds the data source - */ - nextPage(): void; + /** + * Sets the page index to be equal to the previous page index and rebinds the data source + */ + prevPage(): void; - /** - * 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. - */ - pageSize(s?: number): number; + /** + * Sets the page index to be equal to the next page index and rebinds the data source + */ + nextPage(): void; - /** - * For internal use - * - * @param dirty - */ - pageSizeDirty(dirty: Object): void; + /** + * 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. + */ + pageSize(s?: number): number; - /** - * 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 - */ - recordsForPage(p: number): void; + /** + * For internal use + * + * @param dirty + */ + pageSizeDirty(dirty: Object): 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 - */ - tableToObject(tableDOM: Element): Object; + /** + * 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 + */ + recordsForPage(p: number): void; - /** - * Parses the string and returns an evaluated JSON object - * - * @param s the JSON as string. - */ - stringToJSONObject(s: string): 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 + */ + tableToObject(tableDOM: Element): Object; - /** - * Parses a string and returns a XML Document - * - * @param s the XML represented as a string - */ - stringToXmlObject(s: string): void; + /** + * Parses the string and returns an evaluated JSON object + * + * @param s the JSON as string. + */ + stringToJSONObject(s: string): void; - /** - * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data - */ - groupByData(): any[]; + /** + * Parses a string and returns a XML Document + * + * @param s the XML represented as a string + */ + stringToXmlObject(s: string): void; - /** - * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) - */ - visibleGroupByData(): any[]; + /** + * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data + */ + groupByData(): any[]; - /** - * Returns the current normalized/transformed and paged/filtered/sorted group-by data - */ - groupByDataView(): any[]; + /** + * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) + */ + visibleGroupByData(): any[]; - /** - * 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 - */ - toggleGroupByRecord(id: string, collapsed: boolean): void; + /** + * Returns the current normalized/transformed and paged/filtered/sorted group-by data + */ + groupByDataView(): any[]; - /** - * Check whether the specified gorupby record is collapsed - * - * @param gbRec id of the grouped record OR grouped record - */ - isGroupByRecordCollapsed(gbRec: Object): boolean; + /** + * 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 + */ + toggleGroupByRecord(id: string, collapsed: boolean): void; - /** - * 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 - */ - isGroupByApplied(exprs?: any[]): boolean; - } + /** + * Check whether the specified gorupby record is collapsed + * + * @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 + */ + isGroupByApplied(exprs?: any[]): boolean; +} } interface IgniteUIStatic { DataSource: typeof Infragistics.DataSource; } declare namespace Infragistics { - class TypeParser { - toStr(obj: Object): void; +class TypeParser { + toStr(obj: Object): void; - /** - * L.A. 18 June 2012 Fixing bug #113265 Column 'date' shows empty values as 'NaN' - * - * @param obj - * @param pk - * @param key - */ - toDate(obj: Object, pk: Object, key: Object): void; - toNumber(obj: Object): void; - toBool(obj: Object): void; - isNullOrUndefined(obj: Object): void; - empty(): void; - num(): void; - } + /** + * L.A. 18 June 2012 Fixing bug #113265 Column 'date' shows empty values as 'NaN' + * + * @param obj + */ + toDate(obj: Object): void; + toNumber(obj: Object): void; + toBool(obj: Object): void; + isNullOrUndefined(obj: Object): void; + empty(): void; + num(): void; +} } interface DataSchemaSchemaFields { @@ -1029,6 +1090,11 @@ interface DataSchemaSchemaFields { */ mapper?: string|Function; + /** + * ParamType="function" optional="true" formatter function which accepts three parameters: val - value of the field; record - data source record; field - field definition; and return the formatted string. Formatter function is used when filtering by all fields. + */ + formatter?: any; + /** * Option for DataSchemaSchemaFields */ @@ -1059,942 +1125,1004 @@ interface DataSchemaSchema { } declare namespace Infragistics { - class DataSchema { - constructor(schema: DataSchemaSchema); +class DataSchema { + constructor(schema: DataSchemaSchema); - /** - * Performs a transformation on the schema so that the resulting data matches the schema - * - * @param data the data to transform - */ - transform(data: Object): Object; + /** + * Performs a transformation on the schema so that the resulting data matches the schema + * + * @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 - */ - isEmpty(o: Object): Object; + /** + * Specifies if the object is null, undefined, or an empty string + * + * @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 - */ - isObjEmpty(obj: Object): Object; + /** + * Specifies if the object has custom properties or not + * + * @param obj the object to check for presence or lack of custom properties + */ + isObjEmpty(obj: Object): Object; - /** - * A list of field definitions specifying the schema of the data source. - * Field objects description: {fieldName, [fieldDataType], [fieldXPath]} - */ - fields(): any[]; - } + /** + * A list of field definitions specifying the schema of the data source. + * Field objects description: {fieldName, [fieldDataType], [fieldXPath]} + */ + fields(): any[]; +} } interface IgniteUIStatic { DataSchema: typeof Infragistics.DataSchema; } declare namespace Infragistics { - class RemoteDataSource { - constructor(settings: DataSourceSettings); +class RemoteDataSource { + constructor(settings: DataSourceSettings); - /** - * 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' } - */ - fields(fields?: 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' } + */ + fields(fields?: Object): Object; - /** - * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type - */ - analyzeDataSource(): string; + /** + * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type + */ + analyzeDataSource(): string; - /** - * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView - */ - dataView(): any[]; + /** + * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView + */ + dataView(): any[]; - /** - * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. - */ - data(): Object; + /** + * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. + */ + data(): Object; - /** - * Returns transformed data according to transformed execution: - * 1. Before paging and filtering - * 2. After filtering before paging - * 3. After filtering and paging - * - * @param transformedExecution - */ - transformedData(transformedExecution: Object): Object; + /** + * Returns transformed data according to transformed execution: + * 1. Before paging and filtering + * 2. After filtering before paging + * 3. After filtering and paging + * + * @param transformedExecution + */ + transformedData(transformedExecution: Object): Object; - /** - * Returns summaries data - */ - dataSummaries(): Object; + /** + * Returns summaries data + */ + dataSummaries(): Object; - /** - * Gets/sets the schema definition. - * - * @param s a schema object - * @param t type of the data source. See settings.type - */ - schema(s?: Object, t?: string): void; + /** + * Gets/sets the schema definition. + * + * @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 - */ - pagingSettings(p?: Object): Object; + /** + * Gets/sets a list of paging settings + * + * @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 - */ - filterSettings(f?: Object): void; + /** + * Gets/sets a list of filtering settings + * + * @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 - */ - sortSettings(s?: Object): Object; + /** + * Gets/sets a list of paging settings + * + * @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 - */ - summariesSettings(s?: Object): void; + /** + * Gets/sets a list of summaries settings. + * + * @param s object holding all summaries settings. See settings.summaries + */ + summariesSettings(s?: Object): void; - /** - * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource - * - * @param ds - */ - dataSource(ds?: Object): Object; + /** + * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource + * + * @param ds + */ + dataSource(ds?: Object): Object; - /** - * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type - * - * @param t - * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty - */ - type(t?: Object): string; + /** + * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type + * + * @param t + * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty + */ + type(t?: Object): string; - /** - * 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 - */ - findRecordByKey(key: string, ds?: string, objPath?: string): Object; + /** + * 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 + */ + 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 origDs - */ - removeRecordByKey(key: Object, origDs: Object): void; + /** + * 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 origDs + */ + removeRecordByKey(key: Object, origDs: Object): void; - /** - * Removes a record from the data source at specific index. - * - * @param index index of record - * @param origDs - */ - removeRecordByIndex(index: number, origDs: Object): void; + /** + * Removes a record from the data source at specific index. + * + * @param index index of record + * @param origDs + */ + removeRecordByIndex(index: number, origDs: Object): void; - /** - * 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 - */ - setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; + /** + * 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 + */ + 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 - */ - updateRow(rowId: Object, rowObject: 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 + */ + 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 - */ - 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 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 - */ - insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: 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 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 - */ - deleteRow(rowId: Object, autoCommit: boolean): 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 + */ + 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 - */ - addNode(data: Object): void; + /** + * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back + * + * @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 - */ - removeNode(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 + */ + 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 - */ - getDetachedRecord(t: Object): Object; + /** + * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source + * + * @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. - */ - commit(id?: number): void; + /** + * 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. + */ + 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. - */ - rollback(id?: Object): 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. + */ + rollback(id?: Object): void; - /** - * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source - */ - pendingTransactions(): any[]; + /** + * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source + */ + pendingTransactions(): any[]; - /** - * Returns a list of all transaction objects that are either pending, or have been committed in the data source. - */ - allTransactions(): any[]; + /** + * Returns a list of all transaction objects that are either pending, or have been committed in the data source. + */ + allTransactions(): any[]; - /** - * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently - */ - transactionsAsString(): string; + /** + * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently + */ + transactionsAsString(): string; - /** - * 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) - */ - saveChanges(success: Function, error: Function): 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) + */ + saveChanges(success: Function, error: Function): void; - /** - * Data binds to the current data source - * databinding works using the following workflow: - * 1. fire the databinding event - * 2. based on the data source type (see analyzeDataSource()), do the following: - * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. - * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting - * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. - * if no paging/sorting/filtering are enabled, use just this._data to save space - * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL - * if the data source is invalid, throw an exception - * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if - * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree - * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion - * 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 - */ - dataBind(callback?: string, callee?: Object): void; + /** + * Data binds to the current data source + * databinding works using the following workflow: + * 1. fire the databinding event + * 2. based on the data source type (see analyzeDataSource()), do the following: + * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. + * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting + * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. + * if no paging/sorting/filtering are enabled, use just this._data to save space + * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL + * if the data source is invalid, throw an exception + * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if + * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree + * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion + * 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 + */ + 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 - */ - getCellValue(fieldName: string, record: Object): Object; + /** + * 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 + */ + getCellValue(fieldName: string, record: Object): Object; - /** - * Applicable only when the data source is bound to remote data. - * Gets or sets summaries data. - * 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) - */ - summariesResponse(key?: string, dsObj?: Object): Object; + /** + * Applicable only when the data source is bound to remote data. + * Gets or sets summaries data. + * 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) + */ + summariesResponse(key?: string, dsObj?: Object): Object; - /** - * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. - */ - filteredData(): any[]; + /** + * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. + */ + filteredData(): any[]; - /** - * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). - * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions - * multi-column sorting can be enabled by setting keepSortState to true. - * 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 - */ - sort(fields: Object, direction: string): void; + /** + * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). + * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions + * multi-column sorting can be enabled by setting keepSortState to true. + * 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 + */ + sort(fields: Object, direction: string): void; - /** - * This clears local sorting applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalSorting(): void; + /** + * This clears local sorting applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalSorting(): void; - /** - * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and - * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() - * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] - * expr is the filter expression text , such as "abc", or a regular expression such as *test* - * 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 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: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; + /** + * 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. + */ + filterByText(expression: string, fields?: any[]): void; - /** - * This clears local filtering applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalFilter(): void; + /** + * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and + * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() + * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] + * example 3: [{filterAllFields: true, expr: "abc", fields: [name: "Description", type: "string"]}] + * expr is the filter expression text , such as "abc", or a regular expression such as *test* + * 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: + * + * @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. + */ + filter(fieldExpressions: any[], boolLogic: Object, keepFilterState: Object, fieldExpressionsOnStrings: Object): void; - /** - * Applicable only when the data source is bound to remote data. - * Gets / sets the total number of records in the data source. - * If data binding is remote, and there's paging or filtering enabled, - * 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 key - * @param dsObj - * @param context - */ - totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; + /** + * This clears local filtering applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalFilter(): void; - /** - * 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 - */ - hasTotalRecordsCount(hasCount: boolean): void; + /** + * Applicable only when the data source is bound to remote data. + * Gets / sets the total number of records in the data source. + * If data binding is remote, and there's paging or filtering enabled, + * 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 key + * @param dsObj + * @param context + */ + totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; - /** - * Returns metadata object for the specified key - * - * @param key Primary key of the record - */ - metadata(key: string): Object; + /** + * 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 + */ + hasTotalRecordsCount(hasCount: boolean): void; - /** - * Returns the total number of records in the local data source - */ - totalLocalRecordsCount(): number; + /** + * Returns metadata object for the specified key + * + * @param key Primary key of the record + */ + metadata(key: string): Object; - /** - * Returns the total number of pages - */ - pageCount(): number; + /** + * Returns the total number of records in the local data source + */ + totalLocalRecordsCount(): number; - /** - * 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. - */ - pageIndex(index?: number): number; + /** + * Returns the total number of pages + */ + pageCount(): 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. - */ - persistedPageIndex(value?: number): number; + /** + * 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. + */ + pageIndex(index?: number): number; - /** - * Sets the page index to be equal to the previous page index and rebinds the data source - */ - prevPage(): void; + /** + * 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. + */ + persistedPageIndex(value?: number): number; - /** - * Sets the page index to be equal to the next page index and rebinds the data source - */ - nextPage(): void; + /** + * Sets the page index to be equal to the previous page index and rebinds the data source + */ + prevPage(): void; - /** - * 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. - */ - pageSize(s?: number): number; + /** + * Sets the page index to be equal to the next page index and rebinds the data source + */ + nextPage(): void; - /** - * For internal use - * - * @param dirty - */ - pageSizeDirty(dirty: Object): void; + /** + * 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. + */ + pageSize(s?: number): number; - /** - * 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 - */ - recordsForPage(p: number): void; + /** + * For internal use + * + * @param dirty + */ + pageSizeDirty(dirty: Object): 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 - */ - tableToObject(tableDOM: Element): Object; + /** + * 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 + */ + recordsForPage(p: number): void; - /** - * Parses the string and returns an evaluated JSON object - * - * @param s the JSON as string. - */ - stringToJSONObject(s: string): 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 + */ + tableToObject(tableDOM: Element): Object; - /** - * Parses a string and returns a XML Document - * - * @param s the XML represented as a string - */ - stringToXmlObject(s: string): void; + /** + * Parses the string and returns an evaluated JSON object + * + * @param s the JSON as string. + */ + stringToJSONObject(s: string): void; - /** - * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data - */ - groupByData(): any[]; + /** + * Parses a string and returns a XML Document + * + * @param s the XML represented as a string + */ + stringToXmlObject(s: string): void; - /** - * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) - */ - visibleGroupByData(): any[]; + /** + * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data + */ + groupByData(): any[]; - /** - * Returns the current normalized/transformed and paged/filtered/sorted group-by data - */ - groupByDataView(): any[]; + /** + * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) + */ + visibleGroupByData(): any[]; - /** - * 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 - */ - toggleGroupByRecord(id: string, collapsed: boolean): void; + /** + * Returns the current normalized/transformed and paged/filtered/sorted group-by data + */ + groupByDataView(): any[]; - /** - * Check whether the specified gorupby record is collapsed - * - * @param gbRec id of the grouped record OR grouped record - */ - isGroupByRecordCollapsed(gbRec: Object): boolean; + /** + * 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 + */ + toggleGroupByRecord(id: string, collapsed: boolean): void; - /** - * 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 - */ - isGroupByApplied(exprs?: any[]): boolean; - } + /** + * Check whether the specified gorupby record is collapsed + * + * @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 + */ + isGroupByApplied(exprs?: any[]): boolean; +} } interface IgniteUIStatic { RemoteDataSource: typeof Infragistics.RemoteDataSource; } +interface JSONDataSourceSettings { + /** + * Type of the data source. + */ + type?: string; + + /** + * Option for JSONDataSourceSettings + */ + [optionName: string]: any; +} + declare namespace Infragistics { - class JSONDataSource { - constructor(settings: DataSourceSettings); +class JSONDataSource { + constructor(settings: JSONDataSourceSettings); - /** - * 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' } - */ - fields(fields?: 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' } + */ + fields(fields?: Object): Object; - /** - * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type - */ - analyzeDataSource(): string; + /** + * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type + */ + analyzeDataSource(): string; - /** - * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView - */ - dataView(): any[]; + /** + * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView + */ + dataView(): any[]; - /** - * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. - */ - data(): Object; + /** + * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. + */ + data(): Object; - /** - * Returns transformed data according to transformed execution: - * 1. Before paging and filtering - * 2. After filtering before paging - * 3. After filtering and paging - * - * @param transformedExecution - */ - transformedData(transformedExecution: Object): Object; + /** + * Returns transformed data according to transformed execution: + * 1. Before paging and filtering + * 2. After filtering before paging + * 3. After filtering and paging + * + * @param transformedExecution + */ + transformedData(transformedExecution: Object): Object; - /** - * Returns summaries data - */ - dataSummaries(): Object; + /** + * Returns summaries data + */ + dataSummaries(): Object; - /** - * Gets/sets the schema definition. - * - * @param s a schema object - * @param t type of the data source. See settings.type - */ - schema(s?: Object, t?: string): void; + /** + * Gets/sets the schema definition. + * + * @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 - */ - pagingSettings(p?: Object): Object; + /** + * Gets/sets a list of paging settings + * + * @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 - */ - filterSettings(f?: Object): void; + /** + * Gets/sets a list of filtering settings + * + * @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 - */ - sortSettings(s?: Object): Object; + /** + * Gets/sets a list of paging settings + * + * @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 - */ - summariesSettings(s?: Object): void; + /** + * Gets/sets a list of summaries settings. + * + * @param s object holding all summaries settings. See settings.summaries + */ + summariesSettings(s?: Object): void; - /** - * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource - * - * @param ds - */ - dataSource(ds?: Object): Object; + /** + * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource + * + * @param ds + */ + dataSource(ds?: Object): Object; - /** - * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type - * - * @param t - * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty - */ - type(t?: Object): string; + /** + * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type + * + * @param t + * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty + */ + type(t?: Object): string; - /** - * 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 - */ - findRecordByKey(key: string, ds?: string, objPath?: string): Object; + /** + * 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 + */ + 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 origDs - */ - removeRecordByKey(key: Object, origDs: Object): void; + /** + * 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 origDs + */ + removeRecordByKey(key: Object, origDs: Object): void; - /** - * Removes a record from the data source at specific index. - * - * @param index index of record - * @param origDs - */ - removeRecordByIndex(index: number, origDs: Object): void; + /** + * Removes a record from the data source at specific index. + * + * @param index index of record + * @param origDs + */ + removeRecordByIndex(index: number, origDs: Object): void; - /** - * 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 - */ - setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; + /** + * 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 + */ + 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 - */ - updateRow(rowId: Object, rowObject: 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 + */ + 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 - */ - 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 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 - */ - insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: 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 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 - */ - deleteRow(rowId: Object, autoCommit: boolean): 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 + */ + 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 - */ - addNode(data: Object): void; + /** + * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back + * + * @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 - */ - removeNode(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 + */ + 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 - */ - getDetachedRecord(t: Object): Object; + /** + * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source + * + * @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. - */ - commit(id?: number): void; + /** + * 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. + */ + 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. - */ - rollback(id?: Object): 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. + */ + rollback(id?: Object): void; - /** - * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source - */ - pendingTransactions(): any[]; + /** + * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source + */ + pendingTransactions(): any[]; - /** - * Returns a list of all transaction objects that are either pending, or have been committed in the data source. - */ - allTransactions(): any[]; + /** + * Returns a list of all transaction objects that are either pending, or have been committed in the data source. + */ + allTransactions(): any[]; - /** - * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently - */ - transactionsAsString(): string; + /** + * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently + */ + transactionsAsString(): string; - /** - * 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) - */ - saveChanges(success: Function, error: Function): 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) + */ + saveChanges(success: Function, error: Function): void; - /** - * Data binds to the current data source - * databinding works using the following workflow: - * 1. fire the databinding event - * 2. based on the data source type (see analyzeDataSource()), do the following: - * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. - * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting - * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. - * if no paging/sorting/filtering are enabled, use just this._data to save space - * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL - * if the data source is invalid, throw an exception - * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if - * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree - * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion - * 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 - */ - dataBind(callback?: string, callee?: Object): void; + /** + * Data binds to the current data source + * databinding works using the following workflow: + * 1. fire the databinding event + * 2. based on the data source type (see analyzeDataSource()), do the following: + * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. + * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting + * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. + * if no paging/sorting/filtering are enabled, use just this._data to save space + * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL + * if the data source is invalid, throw an exception + * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if + * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree + * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion + * 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 + */ + 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 - */ - getCellValue(fieldName: string, record: Object): Object; + /** + * 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 + */ + getCellValue(fieldName: string, record: Object): Object; - /** - * Applicable only when the data source is bound to remote data. - * Gets or sets summaries data. - * 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) - */ - summariesResponse(key?: string, dsObj?: Object): Object; + /** + * Applicable only when the data source is bound to remote data. + * Gets or sets summaries data. + * 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) + */ + summariesResponse(key?: string, dsObj?: Object): Object; - /** - * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. - */ - filteredData(): any[]; + /** + * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. + */ + filteredData(): any[]; - /** - * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). - * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions - * multi-column sorting can be enabled by setting keepSortState to true. - * 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 - */ - sort(fields: Object, direction: string): void; + /** + * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). + * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions + * multi-column sorting can be enabled by setting keepSortState to true. + * 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 + */ + sort(fields: Object, direction: string): void; - /** - * This clears local sorting applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalSorting(): void; + /** + * This clears local sorting applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalSorting(): void; - /** - * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and - * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() - * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] - * expr is the filter expression text , such as "abc", or a regular expression such as *test* - * 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 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: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; + /** + * 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. + */ + filterByText(expression: string, fields?: any[]): void; - /** - * This clears local filtering applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalFilter(): void; + /** + * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and + * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() + * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] + * example 3: [{filterAllFields: true, expr: "abc", fields: [name: "Description", type: "string"]}] + * expr is the filter expression text , such as "abc", or a regular expression such as *test* + * 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: + * + * @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. + */ + filter(fieldExpressions: any[], boolLogic: Object, keepFilterState: Object, fieldExpressionsOnStrings: Object): void; - /** - * Applicable only when the data source is bound to remote data. - * Gets / sets the total number of records in the data source. - * If data binding is remote, and there's paging or filtering enabled, - * 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 key - * @param dsObj - * @param context - */ - totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; + /** + * This clears local filtering applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalFilter(): void; - /** - * 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 - */ - hasTotalRecordsCount(hasCount: boolean): void; + /** + * Applicable only when the data source is bound to remote data. + * Gets / sets the total number of records in the data source. + * If data binding is remote, and there's paging or filtering enabled, + * 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 key + * @param dsObj + * @param context + */ + totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; - /** - * Returns metadata object for the specified key - * - * @param key Primary key of the record - */ - metadata(key: string): Object; + /** + * 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 + */ + hasTotalRecordsCount(hasCount: boolean): void; - /** - * Returns the total number of records in the local data source - */ - totalLocalRecordsCount(): number; + /** + * Returns metadata object for the specified key + * + * @param key Primary key of the record + */ + metadata(key: string): Object; - /** - * Returns the total number of pages - */ - pageCount(): number; + /** + * Returns the total number of records in the local data source + */ + totalLocalRecordsCount(): number; - /** - * 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. - */ - pageIndex(index?: number): number; + /** + * Returns the total number of pages + */ + pageCount(): 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. - */ - persistedPageIndex(value?: number): number; + /** + * 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. + */ + pageIndex(index?: number): number; - /** - * Sets the page index to be equal to the previous page index and rebinds the data source - */ - prevPage(): void; + /** + * 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. + */ + persistedPageIndex(value?: number): number; - /** - * Sets the page index to be equal to the next page index and rebinds the data source - */ - nextPage(): void; + /** + * Sets the page index to be equal to the previous page index and rebinds the data source + */ + prevPage(): void; - /** - * 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. - */ - pageSize(s?: number): number; + /** + * Sets the page index to be equal to the next page index and rebinds the data source + */ + nextPage(): void; - /** - * For internal use - * - * @param dirty - */ - pageSizeDirty(dirty: Object): void; + /** + * 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. + */ + pageSize(s?: number): number; - /** - * 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 - */ - recordsForPage(p: number): void; + /** + * For internal use + * + * @param dirty + */ + pageSizeDirty(dirty: Object): 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 - */ - tableToObject(tableDOM: Element): Object; + /** + * 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 + */ + recordsForPage(p: number): void; - /** - * Parses the string and returns an evaluated JSON object - * - * @param s the JSON as string. - */ - stringToJSONObject(s: string): 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 + */ + tableToObject(tableDOM: Element): Object; - /** - * Parses a string and returns a XML Document - * - * @param s the XML represented as a string - */ - stringToXmlObject(s: string): void; + /** + * Parses the string and returns an evaluated JSON object + * + * @param s the JSON as string. + */ + stringToJSONObject(s: string): void; - /** - * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data - */ - groupByData(): any[]; + /** + * Parses a string and returns a XML Document + * + * @param s the XML represented as a string + */ + stringToXmlObject(s: string): void; - /** - * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) - */ - visibleGroupByData(): any[]; + /** + * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data + */ + groupByData(): any[]; - /** - * Returns the current normalized/transformed and paged/filtered/sorted group-by data - */ - groupByDataView(): any[]; + /** + * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) + */ + visibleGroupByData(): any[]; - /** - * 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 - */ - toggleGroupByRecord(id: string, collapsed: boolean): void; + /** + * Returns the current normalized/transformed and paged/filtered/sorted group-by data + */ + groupByDataView(): any[]; - /** - * Check whether the specified gorupby record is collapsed - * - * @param gbRec id of the grouped record OR grouped record - */ - isGroupByRecordCollapsed(gbRec: Object): boolean; + /** + * 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 + */ + toggleGroupByRecord(id: string, collapsed: boolean): void; - /** - * 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 - */ - isGroupByApplied(exprs?: any[]): boolean; - } + /** + * Check whether the specified gorupby record is collapsed + * + * @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 + */ + isGroupByApplied(exprs?: any[]): boolean; +} } interface IgniteUIStatic { JSONDataSource: typeof Infragistics.JSONDataSource; @@ -2116,453 +2244,478 @@ interface RESTDataSourceSettings { } declare namespace Infragistics { - class RESTDataSource { - constructor(settings: RESTDataSourceSettings); +class RESTDataSource { + constructor(settings: RESTDataSourceSettings); - /** - * Posts to the restSettings urls using $.ajax, by serializing the changes as url params. - * - * @param success - * @param error - */ - saveChanges(success: Object, error: Object): void; + /** + * Posts to the restSettings urls using $.ajax, by serializing the changes as url params. + * + * @param success + * @param error + */ + saveChanges(success: Object, error: Object): void; - /** - * 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' } - */ - fields(fields?: 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' } + */ + fields(fields?: Object): Object; - /** - * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type - */ - analyzeDataSource(): string; + /** + * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type + */ + analyzeDataSource(): string; - /** - * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView - */ - dataView(): any[]; + /** + * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView + */ + dataView(): any[]; - /** - * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. - */ - data(): Object; + /** + * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. + */ + data(): Object; - /** - * Returns transformed data according to transformed execution: - * 1. Before paging and filtering - * 2. After filtering before paging - * 3. After filtering and paging - * - * @param transformedExecution - */ - transformedData(transformedExecution: Object): Object; + /** + * Returns transformed data according to transformed execution: + * 1. Before paging and filtering + * 2. After filtering before paging + * 3. After filtering and paging + * + * @param transformedExecution + */ + transformedData(transformedExecution: Object): Object; - /** - * Returns summaries data - */ - dataSummaries(): Object; + /** + * Returns summaries data + */ + dataSummaries(): Object; - /** - * Gets/sets the schema definition. - * - * @param s a schema object - * @param t type of the data source. See settings.type - */ - schema(s?: Object, t?: string): void; + /** + * Gets/sets the schema definition. + * + * @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 - */ - pagingSettings(p?: Object): Object; + /** + * Gets/sets a list of paging settings + * + * @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 - */ - filterSettings(f?: Object): void; + /** + * Gets/sets a list of filtering settings + * + * @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 - */ - sortSettings(s?: Object): Object; + /** + * Gets/sets a list of paging settings + * + * @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 - */ - summariesSettings(s?: Object): void; + /** + * Gets/sets a list of summaries settings. + * + * @param s object holding all summaries settings. See settings.summaries + */ + summariesSettings(s?: Object): void; - /** - * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource - * - * @param ds - */ - dataSource(ds?: Object): Object; + /** + * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource + * + * @param ds + */ + dataSource(ds?: Object): Object; - /** - * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type - * - * @param t - * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty - */ - type(t?: Object): string; + /** + * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type + * + * @param t + * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty + */ + type(t?: Object): string; - /** - * 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 - */ - findRecordByKey(key: string, ds?: string, objPath?: string): Object; + /** + * 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 + */ + 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 origDs - */ - removeRecordByKey(key: Object, origDs: Object): void; + /** + * 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 origDs + */ + removeRecordByKey(key: Object, origDs: Object): void; - /** - * Removes a record from the data source at specific index. - * - * @param index index of record - * @param origDs - */ - removeRecordByIndex(index: number, origDs: Object): void; + /** + * Removes a record from the data source at specific index. + * + * @param index index of record + * @param origDs + */ + removeRecordByIndex(index: number, origDs: Object): void; - /** - * 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 - */ - setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; + /** + * 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 + */ + 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 - */ - updateRow(rowId: Object, rowObject: 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 + */ + 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 - */ - 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 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 - */ - insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: 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 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 - */ - deleteRow(rowId: Object, autoCommit: boolean): 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 + */ + 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 - */ - addNode(data: Object): void; + /** + * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back + * + * @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 - */ - removeNode(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 + */ + 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 - */ - getDetachedRecord(t: Object): Object; + /** + * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source + * + * @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. - */ - commit(id?: number): void; + /** + * 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. + */ + 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. - */ - rollback(id?: Object): 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. + */ + rollback(id?: Object): void; - /** - * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source - */ - pendingTransactions(): any[]; + /** + * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source + */ + pendingTransactions(): any[]; - /** - * Returns a list of all transaction objects that are either pending, or have been committed in the data source. - */ - allTransactions(): any[]; + /** + * Returns a list of all transaction objects that are either pending, or have been committed in the data source. + */ + allTransactions(): any[]; - /** - * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently - */ - transactionsAsString(): string; + /** + * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently + */ + transactionsAsString(): string; - /** - * Data binds to the current data source - * databinding works using the following workflow: - * 1. fire the databinding event - * 2. based on the data source type (see analyzeDataSource()), do the following: - * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. - * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting - * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. - * if no paging/sorting/filtering are enabled, use just this._data to save space - * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL - * if the data source is invalid, throw an exception - * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if - * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree - * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion - * 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 - */ - dataBind(callback?: string, callee?: Object): void; + /** + * Data binds to the current data source + * databinding works using the following workflow: + * 1. fire the databinding event + * 2. based on the data source type (see analyzeDataSource()), do the following: + * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. + * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting + * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. + * if no paging/sorting/filtering are enabled, use just this._data to save space + * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL + * if the data source is invalid, throw an exception + * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if + * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree + * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion + * 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 + */ + 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 - */ - getCellValue(fieldName: string, record: Object): Object; + /** + * 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 + */ + getCellValue(fieldName: string, record: Object): Object; - /** - * Applicable only when the data source is bound to remote data. - * Gets or sets summaries data. - * 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) - */ - summariesResponse(key?: string, dsObj?: Object): Object; + /** + * Applicable only when the data source is bound to remote data. + * Gets or sets summaries data. + * 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) + */ + summariesResponse(key?: string, dsObj?: Object): Object; - /** - * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. - */ - filteredData(): any[]; + /** + * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. + */ + filteredData(): any[]; - /** - * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). - * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions - * multi-column sorting can be enabled by setting keepSortState to true. - * 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 - */ - sort(fields: Object, direction: string): void; + /** + * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). + * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions + * multi-column sorting can be enabled by setting keepSortState to true. + * 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 + */ + sort(fields: Object, direction: string): void; - /** - * This clears local sorting applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalSorting(): void; + /** + * This clears local sorting applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalSorting(): void; - /** - * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and - * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() - * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] - * expr is the filter expression text , such as "abc", or a regular expression such as *test* - * 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 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: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; + /** + * 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. + */ + filterByText(expression: string, fields?: any[]): void; - /** - * This clears local filtering applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalFilter(): void; + /** + * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and + * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() + * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] + * example 3: [{filterAllFields: true, expr: "abc", fields: [name: "Description", type: "string"]}] + * expr is the filter expression text , such as "abc", or a regular expression such as *test* + * 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: + * + * @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. + */ + filter(fieldExpressions: any[], boolLogic: Object, keepFilterState: Object, fieldExpressionsOnStrings: Object): void; - /** - * Applicable only when the data source is bound to remote data. - * Gets / sets the total number of records in the data source. - * If data binding is remote, and there's paging or filtering enabled, - * 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 key - * @param dsObj - * @param context - */ - totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; + /** + * This clears local filtering applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalFilter(): void; - /** - * 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 - */ - hasTotalRecordsCount(hasCount: boolean): void; + /** + * Applicable only when the data source is bound to remote data. + * Gets / sets the total number of records in the data source. + * If data binding is remote, and there's paging or filtering enabled, + * 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 key + * @param dsObj + * @param context + */ + totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; - /** - * Returns metadata object for the specified key - * - * @param key Primary key of the record - */ - metadata(key: string): Object; + /** + * 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 + */ + hasTotalRecordsCount(hasCount: boolean): void; - /** - * Returns the total number of records in the local data source - */ - totalLocalRecordsCount(): number; + /** + * Returns metadata object for the specified key + * + * @param key Primary key of the record + */ + metadata(key: string): Object; - /** - * Returns the total number of pages - */ - pageCount(): number; + /** + * Returns the total number of records in the local data source + */ + totalLocalRecordsCount(): number; - /** - * 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. - */ - pageIndex(index?: number): number; + /** + * Returns the total number of pages + */ + pageCount(): 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. - */ - persistedPageIndex(value?: number): number; + /** + * 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. + */ + pageIndex(index?: number): number; - /** - * Sets the page index to be equal to the previous page index and rebinds the data source - */ - prevPage(): void; + /** + * 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. + */ + persistedPageIndex(value?: number): number; - /** - * Sets the page index to be equal to the next page index and rebinds the data source - */ - nextPage(): void; + /** + * Sets the page index to be equal to the previous page index and rebinds the data source + */ + prevPage(): void; - /** - * 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. - */ - pageSize(s?: number): number; + /** + * Sets the page index to be equal to the next page index and rebinds the data source + */ + nextPage(): void; - /** - * For internal use - * - * @param dirty - */ - pageSizeDirty(dirty: Object): void; + /** + * 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. + */ + pageSize(s?: number): number; - /** - * 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 - */ - recordsForPage(p: number): void; + /** + * For internal use + * + * @param dirty + */ + pageSizeDirty(dirty: Object): 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 - */ - tableToObject(tableDOM: Element): Object; + /** + * 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 + */ + recordsForPage(p: number): void; - /** - * Parses the string and returns an evaluated JSON object - * - * @param s the JSON as string. - */ - stringToJSONObject(s: string): 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 + */ + tableToObject(tableDOM: Element): Object; - /** - * Parses a string and returns a XML Document - * - * @param s the XML represented as a string - */ - stringToXmlObject(s: string): void; + /** + * Parses the string and returns an evaluated JSON object + * + * @param s the JSON as string. + */ + stringToJSONObject(s: string): void; - /** - * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data - */ - groupByData(): any[]; + /** + * Parses a string and returns a XML Document + * + * @param s the XML represented as a string + */ + stringToXmlObject(s: string): void; - /** - * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) - */ - visibleGroupByData(): any[]; + /** + * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data + */ + groupByData(): any[]; - /** - * Returns the current normalized/transformed and paged/filtered/sorted group-by data - */ - groupByDataView(): any[]; + /** + * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) + */ + visibleGroupByData(): any[]; - /** - * 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 - */ - toggleGroupByRecord(id: string, collapsed: boolean): void; + /** + * Returns the current normalized/transformed and paged/filtered/sorted group-by data + */ + groupByDataView(): any[]; - /** - * Check whether the specified gorupby record is collapsed - * - * @param gbRec id of the grouped record OR grouped record - */ - isGroupByRecordCollapsed(gbRec: Object): boolean; + /** + * 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 + */ + toggleGroupByRecord(id: string, collapsed: boolean): void; - /** - * 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 - */ - isGroupByApplied(exprs?: any[]): boolean; - } + /** + * Check whether the specified gorupby record is collapsed + * + * @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 + */ + isGroupByApplied(exprs?: any[]): boolean; +} } interface IgniteUIStatic { RESTDataSource: typeof Infragistics.RESTDataSource; @@ -2580,6 +2733,11 @@ interface JSONPDataSourceSettings { */ jsonpCallback?: string|Function; + /** + * Type of the data source. + */ + type?: string; + /** * Option for JSONPDataSourceSettings */ @@ -2587,2265 +2745,2414 @@ interface JSONPDataSourceSettings { } declare namespace Infragistics { - class JSONPDataSource { - constructor(settings: JSONPDataSourceSettings); +class JSONPDataSource { + constructor(settings: JSONPDataSourceSettings); - /** - * 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' } - */ - fields(fields?: 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' } + */ + fields(fields?: Object): Object; - /** - * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type - */ - analyzeDataSource(): string; + /** + * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type + */ + analyzeDataSource(): string; - /** - * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView - */ - dataView(): any[]; + /** + * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView + */ + dataView(): any[]; - /** - * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. - */ - data(): Object; + /** + * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. + */ + data(): Object; - /** - * Returns transformed data according to transformed execution: - * 1. Before paging and filtering - * 2. After filtering before paging - * 3. After filtering and paging - * - * @param transformedExecution - */ - transformedData(transformedExecution: Object): Object; + /** + * Returns transformed data according to transformed execution: + * 1. Before paging and filtering + * 2. After filtering before paging + * 3. After filtering and paging + * + * @param transformedExecution + */ + transformedData(transformedExecution: Object): Object; - /** - * Returns summaries data - */ - dataSummaries(): Object; + /** + * Returns summaries data + */ + dataSummaries(): Object; - /** - * Gets/sets the schema definition. - * - * @param s a schema object - * @param t type of the data source. See settings.type - */ - schema(s?: Object, t?: string): void; + /** + * Gets/sets the schema definition. + * + * @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 - */ - pagingSettings(p?: Object): Object; + /** + * Gets/sets a list of paging settings + * + * @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 - */ - filterSettings(f?: Object): void; + /** + * Gets/sets a list of filtering settings + * + * @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 - */ - sortSettings(s?: Object): Object; + /** + * Gets/sets a list of paging settings + * + * @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 - */ - summariesSettings(s?: Object): void; + /** + * Gets/sets a list of summaries settings. + * + * @param s object holding all summaries settings. See settings.summaries + */ + summariesSettings(s?: Object): void; - /** - * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource - * - * @param ds - */ - dataSource(ds?: Object): Object; + /** + * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource + * + * @param ds + */ + dataSource(ds?: Object): Object; - /** - * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type - * - * @param t - * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty - */ - type(t?: Object): string; + /** + * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type + * + * @param t + * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty + */ + type(t?: Object): string; - /** - * 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 - */ - findRecordByKey(key: string, ds?: string, objPath?: string): Object; + /** + * 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 + */ + 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 origDs - */ - removeRecordByKey(key: Object, origDs: Object): void; + /** + * 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 origDs + */ + removeRecordByKey(key: Object, origDs: Object): void; - /** - * Removes a record from the data source at specific index. - * - * @param index index of record - * @param origDs - */ - removeRecordByIndex(index: number, origDs: Object): void; + /** + * Removes a record from the data source at specific index. + * + * @param index index of record + * @param origDs + */ + removeRecordByIndex(index: number, origDs: Object): void; - /** - * 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 - */ - setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; + /** + * 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 + */ + 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 - */ - updateRow(rowId: Object, rowObject: 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 + */ + 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 - */ - 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 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 - */ - insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: 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 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 - */ - deleteRow(rowId: Object, autoCommit: boolean): 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 + */ + 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 - */ - addNode(data: Object): void; + /** + * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back + * + * @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 - */ - removeNode(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 + */ + 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 - */ - getDetachedRecord(t: Object): Object; + /** + * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source + * + * @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. - */ - commit(id?: number): void; + /** + * 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. + */ + 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. - */ - rollback(id?: Object): 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. + */ + rollback(id?: Object): void; - /** - * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source - */ - pendingTransactions(): any[]; + /** + * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source + */ + pendingTransactions(): any[]; - /** - * Returns a list of all transaction objects that are either pending, or have been committed in the data source. - */ - allTransactions(): any[]; + /** + * Returns a list of all transaction objects that are either pending, or have been committed in the data source. + */ + allTransactions(): any[]; - /** - * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently - */ - transactionsAsString(): string; + /** + * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently + */ + transactionsAsString(): string; - /** - * 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) - */ - saveChanges(success: Function, error: Function): 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) + */ + saveChanges(success: Function, error: Function): void; - /** - * Data binds to the current data source - * databinding works using the following workflow: - * 1. fire the databinding event - * 2. based on the data source type (see analyzeDataSource()), do the following: - * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. - * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting - * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. - * if no paging/sorting/filtering are enabled, use just this._data to save space - * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL - * if the data source is invalid, throw an exception - * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if - * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree - * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion - * 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 - */ - dataBind(callback?: string, callee?: Object): void; + /** + * Data binds to the current data source + * databinding works using the following workflow: + * 1. fire the databinding event + * 2. based on the data source type (see analyzeDataSource()), do the following: + * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. + * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting + * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. + * if no paging/sorting/filtering are enabled, use just this._data to save space + * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL + * if the data source is invalid, throw an exception + * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if + * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree + * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion + * 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 + */ + 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 - */ - getCellValue(fieldName: string, record: Object): Object; + /** + * 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 + */ + getCellValue(fieldName: string, record: Object): Object; - /** - * Applicable only when the data source is bound to remote data. - * Gets or sets summaries data. - * 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) - */ - summariesResponse(key?: string, dsObj?: Object): Object; + /** + * Applicable only when the data source is bound to remote data. + * Gets or sets summaries data. + * 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) + */ + summariesResponse(key?: string, dsObj?: Object): Object; - /** - * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. - */ - filteredData(): any[]; + /** + * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. + */ + filteredData(): any[]; - /** - * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). - * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions - * multi-column sorting can be enabled by setting keepSortState to true. - * 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 - */ - sort(fields: Object, direction: string): void; + /** + * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). + * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions + * multi-column sorting can be enabled by setting keepSortState to true. + * 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 + */ + sort(fields: Object, direction: string): void; - /** - * This clears local sorting applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalSorting(): void; + /** + * This clears local sorting applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalSorting(): void; - /** - * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and - * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() - * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] - * expr is the filter expression text , such as "abc", or a regular expression such as *test* - * 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 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: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; + /** + * 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. + */ + filterByText(expression: string, fields?: any[]): void; - /** - * This clears local filtering applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalFilter(): void; + /** + * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and + * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() + * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] + * example 3: [{filterAllFields: true, expr: "abc", fields: [name: "Description", type: "string"]}] + * expr is the filter expression text , such as "abc", or a regular expression such as *test* + * 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: + * + * @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. + */ + filter(fieldExpressions: any[], boolLogic: Object, keepFilterState: Object, fieldExpressionsOnStrings: Object): void; - /** - * Applicable only when the data source is bound to remote data. - * Gets / sets the total number of records in the data source. - * If data binding is remote, and there's paging or filtering enabled, - * 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 key - * @param dsObj - * @param context - */ - totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; + /** + * This clears local filtering applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalFilter(): void; - /** - * 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 - */ - hasTotalRecordsCount(hasCount: boolean): void; + /** + * Applicable only when the data source is bound to remote data. + * Gets / sets the total number of records in the data source. + * If data binding is remote, and there's paging or filtering enabled, + * 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 key + * @param dsObj + * @param context + */ + totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; - /** - * Returns metadata object for the specified key - * - * @param key Primary key of the record - */ - metadata(key: string): Object; + /** + * 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 + */ + hasTotalRecordsCount(hasCount: boolean): void; - /** - * Returns the total number of records in the local data source - */ - totalLocalRecordsCount(): number; + /** + * Returns metadata object for the specified key + * + * @param key Primary key of the record + */ + metadata(key: string): Object; - /** - * Returns the total number of pages - */ - pageCount(): number; + /** + * Returns the total number of records in the local data source + */ + totalLocalRecordsCount(): number; - /** - * 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. - */ - pageIndex(index?: number): number; + /** + * Returns the total number of pages + */ + pageCount(): 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. - */ - persistedPageIndex(value?: number): number; + /** + * 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. + */ + pageIndex(index?: number): number; - /** - * Sets the page index to be equal to the previous page index and rebinds the data source - */ - prevPage(): void; + /** + * 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. + */ + persistedPageIndex(value?: number): number; - /** - * Sets the page index to be equal to the next page index and rebinds the data source - */ - nextPage(): void; + /** + * Sets the page index to be equal to the previous page index and rebinds the data source + */ + prevPage(): void; - /** - * 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. - */ - pageSize(s?: number): number; + /** + * Sets the page index to be equal to the next page index and rebinds the data source + */ + nextPage(): void; - /** - * For internal use - * - * @param dirty - */ - pageSizeDirty(dirty: Object): void; + /** + * 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. + */ + pageSize(s?: number): number; - /** - * 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 - */ - recordsForPage(p: number): void; + /** + * For internal use + * + * @param dirty + */ + pageSizeDirty(dirty: Object): 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 - */ - tableToObject(tableDOM: Element): Object; + /** + * 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 + */ + recordsForPage(p: number): void; - /** - * Parses the string and returns an evaluated JSON object - * - * @param s the JSON as string. - */ - stringToJSONObject(s: string): 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 + */ + tableToObject(tableDOM: Element): Object; - /** - * Parses a string and returns a XML Document - * - * @param s the XML represented as a string - */ - stringToXmlObject(s: string): void; + /** + * Parses the string and returns an evaluated JSON object + * + * @param s the JSON as string. + */ + stringToJSONObject(s: string): void; - /** - * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data - */ - groupByData(): any[]; + /** + * Parses a string and returns a XML Document + * + * @param s the XML represented as a string + */ + stringToXmlObject(s: string): void; - /** - * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) - */ - visibleGroupByData(): any[]; + /** + * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data + */ + groupByData(): any[]; - /** - * Returns the current normalized/transformed and paged/filtered/sorted group-by data - */ - groupByDataView(): any[]; + /** + * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) + */ + visibleGroupByData(): any[]; - /** - * 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 - */ - toggleGroupByRecord(id: string, collapsed: boolean): void; + /** + * Returns the current normalized/transformed and paged/filtered/sorted group-by data + */ + groupByDataView(): any[]; - /** - * Check whether the specified gorupby record is collapsed - * - * @param gbRec id of the grouped record OR grouped record - */ - isGroupByRecordCollapsed(gbRec: Object): boolean; + /** + * 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 + */ + toggleGroupByRecord(id: string, collapsed: boolean): void; - /** - * 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 - */ - isGroupByApplied(exprs?: any[]): boolean; - } + /** + * Check whether the specified gorupby record is collapsed + * + * @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 + */ + isGroupByApplied(exprs?: any[]): boolean; +} } interface IgniteUIStatic { JSONPDataSource: typeof Infragistics.JSONPDataSource; } declare namespace Infragistics { - class XmlDataSource { - constructor(settings: DataSourceSettings); +class XmlDataSource { + constructor(settings: DataSourceSettings); - /** - * 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' } - */ - fields(fields?: 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' } + */ + fields(fields?: Object): Object; - /** - * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type - */ - analyzeDataSource(): string; + /** + * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type + */ + analyzeDataSource(): string; - /** - * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView - */ - dataView(): any[]; + /** + * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView + */ + dataView(): any[]; - /** - * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. - */ - data(): Object; + /** + * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. + */ + data(): Object; - /** - * Returns transformed data according to transformed execution: - * 1. Before paging and filtering - * 2. After filtering before paging - * 3. After filtering and paging - * - * @param transformedExecution - */ - transformedData(transformedExecution: Object): Object; + /** + * Returns transformed data according to transformed execution: + * 1. Before paging and filtering + * 2. After filtering before paging + * 3. After filtering and paging + * + * @param transformedExecution + */ + transformedData(transformedExecution: Object): Object; - /** - * Returns summaries data - */ - dataSummaries(): Object; + /** + * Returns summaries data + */ + dataSummaries(): Object; - /** - * Gets/sets the schema definition. - * - * @param s a schema object - * @param t type of the data source. See settings.type - */ - schema(s?: Object, t?: string): void; + /** + * Gets/sets the schema definition. + * + * @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 - */ - pagingSettings(p?: Object): Object; + /** + * Gets/sets a list of paging settings + * + * @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 - */ - filterSettings(f?: Object): void; + /** + * Gets/sets a list of filtering settings + * + * @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 - */ - sortSettings(s?: Object): Object; + /** + * Gets/sets a list of paging settings + * + * @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 - */ - summariesSettings(s?: Object): void; + /** + * Gets/sets a list of summaries settings. + * + * @param s object holding all summaries settings. See settings.summaries + */ + summariesSettings(s?: Object): void; - /** - * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource - * - * @param ds - */ - dataSource(ds?: Object): Object; + /** + * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource + * + * @param ds + */ + dataSource(ds?: Object): Object; - /** - * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type - * - * @param t - * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty - */ - type(t?: Object): string; + /** + * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type + * + * @param t + * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty + */ + type(t?: Object): string; - /** - * 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 - */ - findRecordByKey(key: string, ds?: string, objPath?: string): Object; + /** + * 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 + */ + 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 origDs - */ - removeRecordByKey(key: Object, origDs: Object): void; + /** + * 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 origDs + */ + removeRecordByKey(key: Object, origDs: Object): void; - /** - * Removes a record from the data source at specific index. - * - * @param index index of record - * @param origDs - */ - removeRecordByIndex(index: number, origDs: Object): void; + /** + * Removes a record from the data source at specific index. + * + * @param index index of record + * @param origDs + */ + removeRecordByIndex(index: number, origDs: Object): void; - /** - * 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 - */ - setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; + /** + * 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 + */ + 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 - */ - updateRow(rowId: Object, rowObject: 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 + */ + 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 - */ - 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 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 - */ - insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: 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 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 - */ - deleteRow(rowId: Object, autoCommit: boolean): 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 + */ + 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 - */ - addNode(data: Object): void; + /** + * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back + * + * @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 - */ - removeNode(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 + */ + 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 - */ - getDetachedRecord(t: Object): Object; + /** + * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source + * + * @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. - */ - commit(id?: number): void; + /** + * 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. + */ + 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. - */ - rollback(id?: Object): 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. + */ + rollback(id?: Object): void; - /** - * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source - */ - pendingTransactions(): any[]; + /** + * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source + */ + pendingTransactions(): any[]; - /** - * Returns a list of all transaction objects that are either pending, or have been committed in the data source. - */ - allTransactions(): any[]; + /** + * Returns a list of all transaction objects that are either pending, or have been committed in the data source. + */ + allTransactions(): any[]; - /** - * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently - */ - transactionsAsString(): string; + /** + * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently + */ + transactionsAsString(): string; - /** - * 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) - */ - saveChanges(success: Function, error: Function): 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) + */ + saveChanges(success: Function, error: Function): void; - /** - * Data binds to the current data source - * databinding works using the following workflow: - * 1. fire the databinding event - * 2. based on the data source type (see analyzeDataSource()), do the following: - * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. - * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting - * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. - * if no paging/sorting/filtering are enabled, use just this._data to save space - * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL - * if the data source is invalid, throw an exception - * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if - * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree - * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion - * 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 - */ - dataBind(callback?: string, callee?: Object): void; + /** + * Data binds to the current data source + * databinding works using the following workflow: + * 1. fire the databinding event + * 2. based on the data source type (see analyzeDataSource()), do the following: + * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. + * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting + * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. + * if no paging/sorting/filtering are enabled, use just this._data to save space + * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL + * if the data source is invalid, throw an exception + * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if + * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree + * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion + * 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 + */ + 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 - */ - getCellValue(fieldName: string, record: Object): Object; + /** + * 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 + */ + getCellValue(fieldName: string, record: Object): Object; - /** - * Applicable only when the data source is bound to remote data. - * Gets or sets summaries data. - * 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) - */ - summariesResponse(key?: string, dsObj?: Object): Object; + /** + * Applicable only when the data source is bound to remote data. + * Gets or sets summaries data. + * 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) + */ + summariesResponse(key?: string, dsObj?: Object): Object; - /** - * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. - */ - filteredData(): any[]; + /** + * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. + */ + filteredData(): any[]; - /** - * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). - * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions - * multi-column sorting can be enabled by setting keepSortState to true. - * 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 - */ - sort(fields: Object, direction: string): void; + /** + * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). + * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions + * multi-column sorting can be enabled by setting keepSortState to true. + * 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 + */ + sort(fields: Object, direction: string): void; - /** - * This clears local sorting applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalSorting(): void; + /** + * This clears local sorting applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalSorting(): void; - /** - * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and - * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() - * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] - * expr is the filter expression text , such as "abc", or a regular expression such as *test* - * 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 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: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; + /** + * 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. + */ + filterByText(expression: string, fields?: any[]): void; - /** - * This clears local filtering applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalFilter(): void; + /** + * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and + * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() + * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] + * example 3: [{filterAllFields: true, expr: "abc", fields: [name: "Description", type: "string"]}] + * expr is the filter expression text , such as "abc", or a regular expression such as *test* + * 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: + * + * @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. + */ + filter(fieldExpressions: any[], boolLogic: Object, keepFilterState: Object, fieldExpressionsOnStrings: Object): void; - /** - * Applicable only when the data source is bound to remote data. - * Gets / sets the total number of records in the data source. - * If data binding is remote, and there's paging or filtering enabled, - * 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 key - * @param dsObj - * @param context - */ - totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; + /** + * This clears local filtering applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalFilter(): void; - /** - * 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 - */ - hasTotalRecordsCount(hasCount: boolean): void; + /** + * Applicable only when the data source is bound to remote data. + * Gets / sets the total number of records in the data source. + * If data binding is remote, and there's paging or filtering enabled, + * 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 key + * @param dsObj + * @param context + */ + totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; - /** - * Returns metadata object for the specified key - * - * @param key Primary key of the record - */ - metadata(key: string): Object; + /** + * 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 + */ + hasTotalRecordsCount(hasCount: boolean): void; - /** - * Returns the total number of records in the local data source - */ - totalLocalRecordsCount(): number; + /** + * Returns metadata object for the specified key + * + * @param key Primary key of the record + */ + metadata(key: string): Object; - /** - * Returns the total number of pages - */ - pageCount(): number; + /** + * Returns the total number of records in the local data source + */ + totalLocalRecordsCount(): number; - /** - * 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. - */ - pageIndex(index?: number): number; + /** + * Returns the total number of pages + */ + pageCount(): 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. - */ - persistedPageIndex(value?: number): number; + /** + * 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. + */ + pageIndex(index?: number): number; - /** - * Sets the page index to be equal to the previous page index and rebinds the data source - */ - prevPage(): void; + /** + * 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. + */ + persistedPageIndex(value?: number): number; - /** - * Sets the page index to be equal to the next page index and rebinds the data source - */ - nextPage(): void; + /** + * Sets the page index to be equal to the previous page index and rebinds the data source + */ + prevPage(): void; - /** - * 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. - */ - pageSize(s?: number): number; + /** + * Sets the page index to be equal to the next page index and rebinds the data source + */ + nextPage(): void; - /** - * For internal use - * - * @param dirty - */ - pageSizeDirty(dirty: Object): void; + /** + * 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. + */ + pageSize(s?: number): number; - /** - * 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 - */ - recordsForPage(p: number): void; + /** + * For internal use + * + * @param dirty + */ + pageSizeDirty(dirty: Object): 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 - */ - tableToObject(tableDOM: Element): Object; + /** + * 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 + */ + recordsForPage(p: number): void; - /** - * Parses the string and returns an evaluated JSON object - * - * @param s the JSON as string. - */ - stringToJSONObject(s: string): 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 + */ + tableToObject(tableDOM: Element): Object; - /** - * Parses a string and returns a XML Document - * - * @param s the XML represented as a string - */ - stringToXmlObject(s: string): void; + /** + * Parses the string and returns an evaluated JSON object + * + * @param s the JSON as string. + */ + stringToJSONObject(s: string): void; - /** - * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data - */ - groupByData(): any[]; + /** + * Parses a string and returns a XML Document + * + * @param s the XML represented as a string + */ + stringToXmlObject(s: string): void; - /** - * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) - */ - visibleGroupByData(): any[]; + /** + * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data + */ + groupByData(): any[]; - /** - * Returns the current normalized/transformed and paged/filtered/sorted group-by data - */ - groupByDataView(): any[]; + /** + * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) + */ + visibleGroupByData(): any[]; - /** - * 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 - */ - toggleGroupByRecord(id: string, collapsed: boolean): void; + /** + * Returns the current normalized/transformed and paged/filtered/sorted group-by data + */ + groupByDataView(): any[]; - /** - * Check whether the specified gorupby record is collapsed - * - * @param gbRec id of the grouped record OR grouped record - */ - isGroupByRecordCollapsed(gbRec: Object): boolean; + /** + * 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 + */ + toggleGroupByRecord(id: string, collapsed: boolean): void; - /** - * 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 - */ - isGroupByApplied(exprs?: any[]): boolean; - } + /** + * Check whether the specified gorupby record is collapsed + * + * @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 + */ + isGroupByApplied(exprs?: any[]): boolean; +} } interface IgniteUIStatic { XmlDataSource: typeof Infragistics.XmlDataSource; } +interface FunctionDataSourceSettings { + /** + * Type of the data source. + */ + type?: string; + + /** + * Option for FunctionDataSourceSettings + */ + [optionName: string]: any; +} + declare namespace Infragistics { - class FunctionDataSource { - constructor(settings: DataSourceSettings); +class FunctionDataSource { + constructor(settings: FunctionDataSourceSettings); - /** - * 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' } - */ - fields(fields?: 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' } + */ + fields(fields?: Object): Object; - /** - * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type - */ - analyzeDataSource(): string; + /** + * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type + */ + analyzeDataSource(): string; - /** - * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView - */ - dataView(): any[]; + /** + * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView + */ + dataView(): any[]; - /** - * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. - */ - data(): Object; + /** + * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. + */ + data(): Object; - /** - * Returns transformed data according to transformed execution: - * 1. Before paging and filtering - * 2. After filtering before paging - * 3. After filtering and paging - * - * @param transformedExecution - */ - transformedData(transformedExecution: Object): Object; + /** + * Returns transformed data according to transformed execution: + * 1. Before paging and filtering + * 2. After filtering before paging + * 3. After filtering and paging + * + * @param transformedExecution + */ + transformedData(transformedExecution: Object): Object; - /** - * Returns summaries data - */ - dataSummaries(): Object; + /** + * Returns summaries data + */ + dataSummaries(): Object; - /** - * Gets/sets the schema definition. - * - * @param s a schema object - * @param t type of the data source. See settings.type - */ - schema(s?: Object, t?: string): void; + /** + * Gets/sets the schema definition. + * + * @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 - */ - pagingSettings(p?: Object): Object; + /** + * Gets/sets a list of paging settings + * + * @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 - */ - filterSettings(f?: Object): void; + /** + * Gets/sets a list of filtering settings + * + * @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 - */ - sortSettings(s?: Object): Object; + /** + * Gets/sets a list of paging settings + * + * @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 - */ - summariesSettings(s?: Object): void; + /** + * Gets/sets a list of summaries settings. + * + * @param s object holding all summaries settings. See settings.summaries + */ + summariesSettings(s?: Object): void; - /** - * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource - * - * @param ds - */ - dataSource(ds?: Object): Object; + /** + * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource + * + * @param ds + */ + dataSource(ds?: Object): Object; - /** - * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type - * - * @param t - * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty - */ - type(t?: Object): string; + /** + * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type + * + * @param t + * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty + */ + type(t?: Object): string; - /** - * 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 - */ - findRecordByKey(key: string, ds?: string, objPath?: string): Object; + /** + * 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 + */ + 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 origDs - */ - removeRecordByKey(key: Object, origDs: Object): void; + /** + * 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 origDs + */ + removeRecordByKey(key: Object, origDs: Object): void; - /** - * Removes a record from the data source at specific index. - * - * @param index index of record - * @param origDs - */ - removeRecordByIndex(index: number, origDs: Object): void; + /** + * Removes a record from the data source at specific index. + * + * @param index index of record + * @param origDs + */ + removeRecordByIndex(index: number, origDs: Object): void; - /** - * 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 - */ - setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; + /** + * 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 + */ + 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 - */ - updateRow(rowId: Object, rowObject: 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 + */ + 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 - */ - 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 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 - */ - insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: 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 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 - */ - deleteRow(rowId: Object, autoCommit: boolean): 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 + */ + 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 - */ - addNode(data: Object): void; + /** + * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back + * + * @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 - */ - removeNode(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 + */ + 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 - */ - getDetachedRecord(t: Object): Object; + /** + * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source + * + * @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. - */ - commit(id?: number): void; + /** + * 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. + */ + 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. - */ - rollback(id?: Object): 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. + */ + rollback(id?: Object): void; - /** - * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source - */ - pendingTransactions(): any[]; + /** + * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source + */ + pendingTransactions(): any[]; - /** - * Returns a list of all transaction objects that are either pending, or have been committed in the data source. - */ - allTransactions(): any[]; + /** + * Returns a list of all transaction objects that are either pending, or have been committed in the data source. + */ + allTransactions(): any[]; - /** - * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently - */ - transactionsAsString(): string; + /** + * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently + */ + transactionsAsString(): string; - /** - * 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) - */ - saveChanges(success: Function, error: Function): 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) + */ + saveChanges(success: Function, error: Function): void; - /** - * Data binds to the current data source - * databinding works using the following workflow: - * 1. fire the databinding event - * 2. based on the data source type (see analyzeDataSource()), do the following: - * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. - * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting - * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. - * if no paging/sorting/filtering are enabled, use just this._data to save space - * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL - * if the data source is invalid, throw an exception - * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if - * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree - * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion - * 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 - */ - dataBind(callback?: string, callee?: Object): void; + /** + * Data binds to the current data source + * databinding works using the following workflow: + * 1. fire the databinding event + * 2. based on the data source type (see analyzeDataSource()), do the following: + * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. + * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting + * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. + * if no paging/sorting/filtering are enabled, use just this._data to save space + * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL + * if the data source is invalid, throw an exception + * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if + * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree + * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion + * 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 + */ + 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 - */ - getCellValue(fieldName: string, record: Object): Object; + /** + * 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 + */ + getCellValue(fieldName: string, record: Object): Object; - /** - * Applicable only when the data source is bound to remote data. - * Gets or sets summaries data. - * 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) - */ - summariesResponse(key?: string, dsObj?: Object): Object; + /** + * Applicable only when the data source is bound to remote data. + * Gets or sets summaries data. + * 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) + */ + summariesResponse(key?: string, dsObj?: Object): Object; - /** - * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. - */ - filteredData(): any[]; + /** + * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. + */ + filteredData(): any[]; - /** - * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). - * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions - * multi-column sorting can be enabled by setting keepSortState to true. - * 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 - */ - sort(fields: Object, direction: string): void; + /** + * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). + * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions + * multi-column sorting can be enabled by setting keepSortState to true. + * 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 + */ + sort(fields: Object, direction: string): void; - /** - * This clears local sorting applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalSorting(): void; + /** + * This clears local sorting applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalSorting(): void; - /** - * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and - * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() - * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] - * expr is the filter expression text , such as "abc", or a regular expression such as *test* - * 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 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: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; + /** + * 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. + */ + filterByText(expression: string, fields?: any[]): void; - /** - * This clears local filtering applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalFilter(): void; + /** + * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and + * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() + * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] + * example 3: [{filterAllFields: true, expr: "abc", fields: [name: "Description", type: "string"]}] + * expr is the filter expression text , such as "abc", or a regular expression such as *test* + * 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: + * + * @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. + */ + filter(fieldExpressions: any[], boolLogic: Object, keepFilterState: Object, fieldExpressionsOnStrings: Object): void; - /** - * Applicable only when the data source is bound to remote data. - * Gets / sets the total number of records in the data source. - * If data binding is remote, and there's paging or filtering enabled, - * 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 key - * @param dsObj - * @param context - */ - totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; + /** + * This clears local filtering applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalFilter(): void; - /** - * 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 - */ - hasTotalRecordsCount(hasCount: boolean): void; + /** + * Applicable only when the data source is bound to remote data. + * Gets / sets the total number of records in the data source. + * If data binding is remote, and there's paging or filtering enabled, + * 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 key + * @param dsObj + * @param context + */ + totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; - /** - * Returns metadata object for the specified key - * - * @param key Primary key of the record - */ - metadata(key: string): Object; + /** + * 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 + */ + hasTotalRecordsCount(hasCount: boolean): void; - /** - * Returns the total number of records in the local data source - */ - totalLocalRecordsCount(): number; + /** + * Returns metadata object for the specified key + * + * @param key Primary key of the record + */ + metadata(key: string): Object; - /** - * Returns the total number of pages - */ - pageCount(): number; + /** + * Returns the total number of records in the local data source + */ + totalLocalRecordsCount(): number; - /** - * 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. - */ - pageIndex(index?: number): number; + /** + * Returns the total number of pages + */ + pageCount(): 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. - */ - persistedPageIndex(value?: number): number; + /** + * 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. + */ + pageIndex(index?: number): number; - /** - * Sets the page index to be equal to the previous page index and rebinds the data source - */ - prevPage(): void; + /** + * 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. + */ + persistedPageIndex(value?: number): number; - /** - * Sets the page index to be equal to the next page index and rebinds the data source - */ - nextPage(): void; + /** + * Sets the page index to be equal to the previous page index and rebinds the data source + */ + prevPage(): void; - /** - * 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. - */ - pageSize(s?: number): number; + /** + * Sets the page index to be equal to the next page index and rebinds the data source + */ + nextPage(): void; - /** - * For internal use - * - * @param dirty - */ - pageSizeDirty(dirty: Object): void; + /** + * 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. + */ + pageSize(s?: number): number; - /** - * 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 - */ - recordsForPage(p: number): void; + /** + * For internal use + * + * @param dirty + */ + pageSizeDirty(dirty: Object): 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 - */ - tableToObject(tableDOM: Element): Object; + /** + * 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 + */ + recordsForPage(p: number): void; - /** - * Parses the string and returns an evaluated JSON object - * - * @param s the JSON as string. - */ - stringToJSONObject(s: string): 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 + */ + tableToObject(tableDOM: Element): Object; - /** - * Parses a string and returns a XML Document - * - * @param s the XML represented as a string - */ - stringToXmlObject(s: string): void; + /** + * Parses the string and returns an evaluated JSON object + * + * @param s the JSON as string. + */ + stringToJSONObject(s: string): void; - /** - * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data - */ - groupByData(): any[]; + /** + * Parses a string and returns a XML Document + * + * @param s the XML represented as a string + */ + stringToXmlObject(s: string): void; - /** - * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) - */ - visibleGroupByData(): any[]; + /** + * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data + */ + groupByData(): any[]; - /** - * Returns the current normalized/transformed and paged/filtered/sorted group-by data - */ - groupByDataView(): any[]; + /** + * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) + */ + visibleGroupByData(): any[]; - /** - * 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 - */ - toggleGroupByRecord(id: string, collapsed: boolean): void; + /** + * Returns the current normalized/transformed and paged/filtered/sorted group-by data + */ + groupByDataView(): any[]; - /** - * Check whether the specified gorupby record is collapsed - * - * @param gbRec id of the grouped record OR grouped record - */ - isGroupByRecordCollapsed(gbRec: Object): boolean; + /** + * 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 + */ + toggleGroupByRecord(id: string, collapsed: boolean): void; - /** - * 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 - */ - isGroupByApplied(exprs?: any[]): boolean; - } + /** + * Check whether the specified gorupby record is collapsed + * + * @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 + */ + isGroupByApplied(exprs?: any[]): boolean; +} } interface IgniteUIStatic { FunctionDataSource: typeof Infragistics.FunctionDataSource; } +interface HtmlTableDataSourceSettings { + /** + * Type of the data source. + */ + type?: string; + + /** + * Option for HtmlTableDataSourceSettings + */ + [optionName: string]: any; +} + declare namespace Infragistics { - class HtmlTableDataSource { - constructor(settings: DataSourceSettings); +class HtmlTableDataSource { + constructor(settings: HtmlTableDataSourceSettings); - /** - * 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' } - */ - fields(fields?: 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' } + */ + fields(fields?: Object): Object; - /** - * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type - */ - analyzeDataSource(): string; + /** + * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type + */ + analyzeDataSource(): string; - /** - * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView - */ - dataView(): any[]; + /** + * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView + */ + dataView(): any[]; - /** - * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. - */ - data(): Object; + /** + * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. + */ + data(): Object; - /** - * Returns transformed data according to transformed execution: - * 1. Before paging and filtering - * 2. After filtering before paging - * 3. After filtering and paging - * - * @param transformedExecution - */ - transformedData(transformedExecution: Object): Object; + /** + * Returns transformed data according to transformed execution: + * 1. Before paging and filtering + * 2. After filtering before paging + * 3. After filtering and paging + * + * @param transformedExecution + */ + transformedData(transformedExecution: Object): Object; - /** - * Returns summaries data - */ - dataSummaries(): Object; + /** + * Returns summaries data + */ + dataSummaries(): Object; - /** - * Gets/sets the schema definition. - * - * @param s a schema object - * @param t type of the data source. See settings.type - */ - schema(s?: Object, t?: string): void; + /** + * Gets/sets the schema definition. + * + * @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 - */ - pagingSettings(p?: Object): Object; + /** + * Gets/sets a list of paging settings + * + * @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 - */ - filterSettings(f?: Object): void; + /** + * Gets/sets a list of filtering settings + * + * @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 - */ - sortSettings(s?: Object): Object; + /** + * Gets/sets a list of paging settings + * + * @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 - */ - summariesSettings(s?: Object): void; + /** + * Gets/sets a list of summaries settings. + * + * @param s object holding all summaries settings. See settings.summaries + */ + summariesSettings(s?: Object): void; - /** - * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource - * - * @param ds - */ - dataSource(ds?: Object): Object; + /** + * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource + * + * @param ds + */ + dataSource(ds?: Object): Object; - /** - * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type - * - * @param t - * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty - */ - type(t?: Object): string; + /** + * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type + * + * @param t + * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty + */ + type(t?: Object): string; - /** - * 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 - */ - findRecordByKey(key: string, ds?: string, objPath?: string): Object; + /** + * 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 + */ + 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 origDs - */ - removeRecordByKey(key: Object, origDs: Object): void; + /** + * 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 origDs + */ + removeRecordByKey(key: Object, origDs: Object): void; - /** - * Removes a record from the data source at specific index. - * - * @param index index of record - * @param origDs - */ - removeRecordByIndex(index: number, origDs: Object): void; + /** + * Removes a record from the data source at specific index. + * + * @param index index of record + * @param origDs + */ + removeRecordByIndex(index: number, origDs: Object): void; - /** - * 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 - */ - setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; + /** + * 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 + */ + 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 - */ - updateRow(rowId: Object, rowObject: 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 + */ + 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 - */ - 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 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 - */ - insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: 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 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 - */ - deleteRow(rowId: Object, autoCommit: boolean): 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 + */ + 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 - */ - addNode(data: Object): void; + /** + * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back + * + * @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 - */ - removeNode(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 + */ + 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 - */ - getDetachedRecord(t: Object): Object; + /** + * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source + * + * @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. - */ - commit(id?: number): void; + /** + * 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. + */ + 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. - */ - rollback(id?: Object): 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. + */ + rollback(id?: Object): void; - /** - * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source - */ - pendingTransactions(): any[]; + /** + * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source + */ + pendingTransactions(): any[]; - /** - * Returns a list of all transaction objects that are either pending, or have been committed in the data source. - */ - allTransactions(): any[]; + /** + * Returns a list of all transaction objects that are either pending, or have been committed in the data source. + */ + allTransactions(): any[]; - /** - * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently - */ - transactionsAsString(): string; + /** + * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently + */ + transactionsAsString(): string; - /** - * 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) - */ - saveChanges(success: Function, error: Function): 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) + */ + saveChanges(success: Function, error: Function): void; - /** - * Data binds to the current data source - * databinding works using the following workflow: - * 1. fire the databinding event - * 2. based on the data source type (see analyzeDataSource()), do the following: - * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. - * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting - * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. - * if no paging/sorting/filtering are enabled, use just this._data to save space - * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL - * if the data source is invalid, throw an exception - * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if - * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree - * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion - * 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 - */ - dataBind(callback?: string, callee?: Object): void; + /** + * Data binds to the current data source + * databinding works using the following workflow: + * 1. fire the databinding event + * 2. based on the data source type (see analyzeDataSource()), do the following: + * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. + * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting + * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. + * if no paging/sorting/filtering are enabled, use just this._data to save space + * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL + * if the data source is invalid, throw an exception + * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if + * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree + * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion + * 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 + */ + 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 - */ - getCellValue(fieldName: string, record: Object): Object; + /** + * 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 + */ + getCellValue(fieldName: string, record: Object): Object; - /** - * Applicable only when the data source is bound to remote data. - * Gets or sets summaries data. - * 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) - */ - summariesResponse(key?: string, dsObj?: Object): Object; + /** + * Applicable only when the data source is bound to remote data. + * Gets or sets summaries data. + * 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) + */ + summariesResponse(key?: string, dsObj?: Object): Object; - /** - * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. - */ - filteredData(): any[]; + /** + * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. + */ + filteredData(): any[]; - /** - * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). - * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions - * multi-column sorting can be enabled by setting keepSortState to true. - * 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 - */ - sort(fields: Object, direction: string): void; + /** + * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). + * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions + * multi-column sorting can be enabled by setting keepSortState to true. + * 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 + */ + sort(fields: Object, direction: string): void; - /** - * This clears local sorting applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalSorting(): void; + /** + * This clears local sorting applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalSorting(): void; - /** - * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and - * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() - * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] - * expr is the filter expression text , such as "abc", or a regular expression such as *test* - * 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 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: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; + /** + * 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. + */ + filterByText(expression: string, fields?: any[]): void; - /** - * This clears local filtering applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalFilter(): void; + /** + * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and + * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() + * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] + * example 3: [{filterAllFields: true, expr: "abc", fields: [name: "Description", type: "string"]}] + * expr is the filter expression text , such as "abc", or a regular expression such as *test* + * 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: + * + * @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. + */ + filter(fieldExpressions: any[], boolLogic: Object, keepFilterState: Object, fieldExpressionsOnStrings: Object): void; - /** - * Applicable only when the data source is bound to remote data. - * Gets / sets the total number of records in the data source. - * If data binding is remote, and there's paging or filtering enabled, - * 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 key - * @param dsObj - * @param context - */ - totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; + /** + * This clears local filtering applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalFilter(): void; - /** - * 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 - */ - hasTotalRecordsCount(hasCount: boolean): void; + /** + * Applicable only when the data source is bound to remote data. + * Gets / sets the total number of records in the data source. + * If data binding is remote, and there's paging or filtering enabled, + * 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 key + * @param dsObj + * @param context + */ + totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; - /** - * Returns metadata object for the specified key - * - * @param key Primary key of the record - */ - metadata(key: string): Object; + /** + * 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 + */ + hasTotalRecordsCount(hasCount: boolean): void; - /** - * Returns the total number of records in the local data source - */ - totalLocalRecordsCount(): number; + /** + * Returns metadata object for the specified key + * + * @param key Primary key of the record + */ + metadata(key: string): Object; - /** - * Returns the total number of pages - */ - pageCount(): number; + /** + * Returns the total number of records in the local data source + */ + totalLocalRecordsCount(): number; - /** - * 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. - */ - pageIndex(index?: number): number; + /** + * Returns the total number of pages + */ + pageCount(): 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. - */ - persistedPageIndex(value?: number): number; + /** + * 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. + */ + pageIndex(index?: number): number; - /** - * Sets the page index to be equal to the previous page index and rebinds the data source - */ - prevPage(): void; + /** + * 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. + */ + persistedPageIndex(value?: number): number; - /** - * Sets the page index to be equal to the next page index and rebinds the data source - */ - nextPage(): void; + /** + * Sets the page index to be equal to the previous page index and rebinds the data source + */ + prevPage(): void; - /** - * 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. - */ - pageSize(s?: number): number; + /** + * Sets the page index to be equal to the next page index and rebinds the data source + */ + nextPage(): void; - /** - * For internal use - * - * @param dirty - */ - pageSizeDirty(dirty: Object): void; + /** + * 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. + */ + pageSize(s?: number): number; - /** - * 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 - */ - recordsForPage(p: number): void; + /** + * For internal use + * + * @param dirty + */ + pageSizeDirty(dirty: Object): 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 - */ - tableToObject(tableDOM: Element): Object; + /** + * 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 + */ + recordsForPage(p: number): void; - /** - * Parses the string and returns an evaluated JSON object - * - * @param s the JSON as string. - */ - stringToJSONObject(s: string): 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 + */ + tableToObject(tableDOM: Element): Object; - /** - * Parses a string and returns a XML Document - * - * @param s the XML represented as a string - */ - stringToXmlObject(s: string): void; + /** + * Parses the string and returns an evaluated JSON object + * + * @param s the JSON as string. + */ + stringToJSONObject(s: string): void; - /** - * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data - */ - groupByData(): any[]; + /** + * Parses a string and returns a XML Document + * + * @param s the XML represented as a string + */ + stringToXmlObject(s: string): void; - /** - * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) - */ - visibleGroupByData(): any[]; + /** + * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data + */ + groupByData(): any[]; - /** - * Returns the current normalized/transformed and paged/filtered/sorted group-by data - */ - groupByDataView(): any[]; + /** + * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) + */ + visibleGroupByData(): any[]; - /** - * 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 - */ - toggleGroupByRecord(id: string, collapsed: boolean): void; + /** + * Returns the current normalized/transformed and paged/filtered/sorted group-by data + */ + groupByDataView(): any[]; - /** - * Check whether the specified gorupby record is collapsed - * - * @param gbRec id of the grouped record OR grouped record - */ - isGroupByRecordCollapsed(gbRec: Object): boolean; + /** + * 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 + */ + toggleGroupByRecord(id: string, collapsed: boolean): void; - /** - * 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 - */ - isGroupByApplied(exprs?: any[]): boolean; - } + /** + * Check whether the specified gorupby record is collapsed + * + * @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 + */ + isGroupByApplied(exprs?: any[]): boolean; +} } interface IgniteUIStatic { HtmlTableDataSource: typeof Infragistics.HtmlTableDataSource; } declare namespace Infragistics { - class ArrayDataSource { - constructor(settings: DataSourceSettings); +class ArrayDataSource { + constructor(settings: DataSourceSettings); - /** - * 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' } - */ - fields(fields?: 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' } + */ + fields(fields?: Object): Object; - /** - * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type - */ - analyzeDataSource(): string; + /** + * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type + */ + analyzeDataSource(): string; - /** - * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView - */ - dataView(): any[]; + /** + * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView + */ + dataView(): any[]; - /** - * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. - */ - data(): Object; + /** + * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. + */ + data(): Object; - /** - * Returns transformed data according to transformed execution: - * 1. Before paging and filtering - * 2. After filtering before paging - * 3. After filtering and paging - * - * @param transformedExecution - */ - transformedData(transformedExecution: Object): Object; + /** + * Returns transformed data according to transformed execution: + * 1. Before paging and filtering + * 2. After filtering before paging + * 3. After filtering and paging + * + * @param transformedExecution + */ + transformedData(transformedExecution: Object): Object; - /** - * Returns summaries data - */ - dataSummaries(): Object; + /** + * Returns summaries data + */ + dataSummaries(): Object; - /** - * Gets/sets the schema definition. - * - * @param s a schema object - * @param t type of the data source. See settings.type - */ - schema(s?: Object, t?: string): void; + /** + * Gets/sets the schema definition. + * + * @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 - */ - pagingSettings(p?: Object): Object; + /** + * Gets/sets a list of paging settings + * + * @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 - */ - filterSettings(f?: Object): void; + /** + * Gets/sets a list of filtering settings + * + * @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 - */ - sortSettings(s?: Object): Object; + /** + * Gets/sets a list of paging settings + * + * @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 - */ - summariesSettings(s?: Object): void; + /** + * Gets/sets a list of summaries settings. + * + * @param s object holding all summaries settings. See settings.summaries + */ + summariesSettings(s?: Object): void; - /** - * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource - * - * @param ds - */ - dataSource(ds?: Object): Object; + /** + * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource + * + * @param ds + */ + dataSource(ds?: Object): Object; - /** - * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type - * - * @param t - * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty - */ - type(t?: Object): string; + /** + * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type + * + * @param t + * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty + */ + type(t?: Object): string; - /** - * 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 - */ - findRecordByKey(key: string, ds?: string, objPath?: string): Object; + /** + * 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 + */ + 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 origDs - */ - removeRecordByKey(key: Object, origDs: Object): void; + /** + * 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 origDs + */ + removeRecordByKey(key: Object, origDs: Object): void; - /** - * Removes a record from the data source at specific index. - * - * @param index index of record - * @param origDs - */ - removeRecordByIndex(index: number, origDs: Object): void; + /** + * Removes a record from the data source at specific index. + * + * @param index index of record + * @param origDs + */ + removeRecordByIndex(index: number, origDs: Object): void; - /** - * 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 - */ - setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; + /** + * 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 + */ + 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 - */ - updateRow(rowId: Object, rowObject: 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 + */ + 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 - */ - 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 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 - */ - insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: 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 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 - */ - deleteRow(rowId: Object, autoCommit: boolean): 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 + */ + 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 - */ - addNode(data: Object): void; + /** + * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back + * + * @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 - */ - removeNode(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 + */ + 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 - */ - getDetachedRecord(t: Object): Object; + /** + * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source + * + * @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. - */ - commit(id?: number): void; + /** + * 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. + */ + 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. - */ - rollback(id?: Object): 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. + */ + rollback(id?: Object): void; - /** - * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source - */ - pendingTransactions(): any[]; + /** + * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source + */ + pendingTransactions(): any[]; - /** - * Returns a list of all transaction objects that are either pending, or have been committed in the data source. - */ - allTransactions(): any[]; + /** + * Returns a list of all transaction objects that are either pending, or have been committed in the data source. + */ + allTransactions(): any[]; - /** - * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently - */ - transactionsAsString(): string; + /** + * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently + */ + transactionsAsString(): string; - /** - * 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) - */ - saveChanges(success: Function, error: Function): 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) + */ + saveChanges(success: Function, error: Function): void; - /** - * Data binds to the current data source - * databinding works using the following workflow: - * 1. fire the databinding event - * 2. based on the data source type (see analyzeDataSource()), do the following: - * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. - * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting - * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. - * if no paging/sorting/filtering are enabled, use just this._data to save space - * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL - * if the data source is invalid, throw an exception - * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if - * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree - * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion - * 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 - */ - dataBind(callback?: string, callee?: Object): void; + /** + * Data binds to the current data source + * databinding works using the following workflow: + * 1. fire the databinding event + * 2. based on the data source type (see analyzeDataSource()), do the following: + * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. + * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting + * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. + * if no paging/sorting/filtering are enabled, use just this._data to save space + * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL + * if the data source is invalid, throw an exception + * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if + * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree + * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion + * 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 + */ + 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 - */ - getCellValue(fieldName: string, record: Object): Object; + /** + * 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 + */ + getCellValue(fieldName: string, record: Object): Object; - /** - * Applicable only when the data source is bound to remote data. - * Gets or sets summaries data. - * 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) - */ - summariesResponse(key?: string, dsObj?: Object): Object; + /** + * Applicable only when the data source is bound to remote data. + * Gets or sets summaries data. + * 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) + */ + summariesResponse(key?: string, dsObj?: Object): Object; - /** - * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. - */ - filteredData(): any[]; + /** + * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. + */ + filteredData(): any[]; - /** - * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). - * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions - * multi-column sorting can be enabled by setting keepSortState to true. - * 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 - */ - sort(fields: Object, direction: string): void; + /** + * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). + * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions + * multi-column sorting can be enabled by setting keepSortState to true. + * 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 + */ + sort(fields: Object, direction: string): void; - /** - * This clears local sorting applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalSorting(): void; + /** + * This clears local sorting applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalSorting(): void; - /** - * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and - * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() - * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] - * expr is the filter expression text , such as "abc", or a regular expression such as *test* - * 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 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: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; + /** + * 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. + */ + filterByText(expression: string, fields?: any[]): void; - /** - * This clears local filtering applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalFilter(): void; + /** + * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and + * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() + * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] + * example 3: [{filterAllFields: true, expr: "abc", fields: [name: "Description", type: "string"]}] + * expr is the filter expression text , such as "abc", or a regular expression such as *test* + * 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: + * + * @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. + */ + filter(fieldExpressions: any[], boolLogic: Object, keepFilterState: Object, fieldExpressionsOnStrings: Object): void; - /** - * Applicable only when the data source is bound to remote data. - * Gets / sets the total number of records in the data source. - * If data binding is remote, and there's paging or filtering enabled, - * 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 key - * @param dsObj - * @param context - */ - totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; + /** + * This clears local filtering applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalFilter(): void; - /** - * 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 - */ - hasTotalRecordsCount(hasCount: boolean): void; + /** + * Applicable only when the data source is bound to remote data. + * Gets / sets the total number of records in the data source. + * If data binding is remote, and there's paging or filtering enabled, + * 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 key + * @param dsObj + * @param context + */ + totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; - /** - * Returns metadata object for the specified key - * - * @param key Primary key of the record - */ - metadata(key: string): Object; + /** + * 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 + */ + hasTotalRecordsCount(hasCount: boolean): void; - /** - * Returns the total number of records in the local data source - */ - totalLocalRecordsCount(): number; + /** + * Returns metadata object for the specified key + * + * @param key Primary key of the record + */ + metadata(key: string): Object; - /** - * Returns the total number of pages - */ - pageCount(): number; + /** + * Returns the total number of records in the local data source + */ + totalLocalRecordsCount(): number; - /** - * 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. - */ - pageIndex(index?: number): number; + /** + * Returns the total number of pages + */ + pageCount(): 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. - */ - persistedPageIndex(value?: number): number; + /** + * 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. + */ + pageIndex(index?: number): number; - /** - * Sets the page index to be equal to the previous page index and rebinds the data source - */ - prevPage(): void; + /** + * 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. + */ + persistedPageIndex(value?: number): number; - /** - * Sets the page index to be equal to the next page index and rebinds the data source - */ - nextPage(): void; + /** + * Sets the page index to be equal to the previous page index and rebinds the data source + */ + prevPage(): void; - /** - * 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. - */ - pageSize(s?: number): number; + /** + * Sets the page index to be equal to the next page index and rebinds the data source + */ + nextPage(): void; - /** - * For internal use - * - * @param dirty - */ - pageSizeDirty(dirty: Object): void; + /** + * 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. + */ + pageSize(s?: number): number; - /** - * 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 - */ - recordsForPage(p: number): void; + /** + * For internal use + * + * @param dirty + */ + pageSizeDirty(dirty: Object): 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 - */ - tableToObject(tableDOM: Element): Object; + /** + * 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 + */ + recordsForPage(p: number): void; - /** - * Parses the string and returns an evaluated JSON object - * - * @param s the JSON as string. - */ - stringToJSONObject(s: string): 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 + */ + tableToObject(tableDOM: Element): Object; - /** - * Parses a string and returns a XML Document - * - * @param s the XML represented as a string - */ - stringToXmlObject(s: string): void; + /** + * Parses the string and returns an evaluated JSON object + * + * @param s the JSON as string. + */ + stringToJSONObject(s: string): void; - /** - * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data - */ - groupByData(): any[]; + /** + * Parses a string and returns a XML Document + * + * @param s the XML represented as a string + */ + stringToXmlObject(s: string): void; - /** - * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) - */ - visibleGroupByData(): any[]; + /** + * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data + */ + groupByData(): any[]; - /** - * Returns the current normalized/transformed and paged/filtered/sorted group-by data - */ - groupByDataView(): any[]; + /** + * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) + */ + visibleGroupByData(): any[]; - /** - * 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 - */ - toggleGroupByRecord(id: string, collapsed: boolean): void; + /** + * Returns the current normalized/transformed and paged/filtered/sorted group-by data + */ + groupByDataView(): any[]; - /** - * Check whether the specified gorupby record is collapsed - * - * @param gbRec id of the grouped record OR grouped record - */ - isGroupByRecordCollapsed(gbRec: Object): boolean; + /** + * 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 + */ + toggleGroupByRecord(id: string, collapsed: boolean): void; - /** - * 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 - */ - isGroupByApplied(exprs?: any[]): boolean; - } + /** + * Check whether the specified gorupby record is collapsed + * + * @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 + */ + isGroupByApplied(exprs?: any[]): boolean; +} } interface IgniteUIStatic { ArrayDataSource: typeof Infragistics.ArrayDataSource; @@ -4869,437 +5176,462 @@ interface MashupDataSourceMashupSettings { } declare namespace Infragistics { - class MashupDataSource { - constructor(mashupSettings: MashupDataSourceMashupSettings); - constructor(settings: DataSourceSettings); +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 - */ - setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; + /** + * 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 + */ + 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 - */ - updateRow(rowId: Object, rowObject: 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 + */ + 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 - */ - 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 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 - */ - insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: 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 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; - /** - * Data binds to the current data source. - */ - dataBind(): void; + /** + * Data binds to the current data source. + */ + dataBind(): void; - /** - * 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' } - */ - fields(fields?: 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' } + */ + fields(fields?: Object): Object; - /** - * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type - */ - analyzeDataSource(): string; + /** + * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type + */ + analyzeDataSource(): string; - /** - * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView - */ - dataView(): any[]; + /** + * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView + */ + dataView(): any[]; - /** - * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. - */ - data(): Object; + /** + * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. + */ + data(): Object; - /** - * Returns transformed data according to transformed execution: - * 1. Before paging and filtering - * 2. After filtering before paging - * 3. After filtering and paging - * - * @param transformedExecution - */ - transformedData(transformedExecution: Object): Object; + /** + * Returns transformed data according to transformed execution: + * 1. Before paging and filtering + * 2. After filtering before paging + * 3. After filtering and paging + * + * @param transformedExecution + */ + transformedData(transformedExecution: Object): Object; - /** - * Returns summaries data - */ - dataSummaries(): Object; + /** + * Returns summaries data + */ + dataSummaries(): Object; - /** - * Gets/sets the schema definition. - * - * @param s a schema object - * @param t type of the data source. See settings.type - */ - schema(s?: Object, t?: string): void; + /** + * Gets/sets the schema definition. + * + * @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 - */ - pagingSettings(p?: Object): Object; + /** + * Gets/sets a list of paging settings + * + * @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 - */ - filterSettings(f?: Object): void; + /** + * Gets/sets a list of filtering settings + * + * @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 - */ - sortSettings(s?: Object): Object; + /** + * Gets/sets a list of paging settings + * + * @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 - */ - summariesSettings(s?: Object): void; + /** + * Gets/sets a list of summaries settings. + * + * @param s object holding all summaries settings. See settings.summaries + */ + summariesSettings(s?: Object): void; - /** - * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource - * - * @param ds - */ - dataSource(ds?: Object): Object; + /** + * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource + * + * @param ds + */ + dataSource(ds?: Object): Object; - /** - * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type - * - * @param t - * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty - */ - type(t?: Object): string; + /** + * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type + * + * @param t + * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty + */ + type(t?: Object): string; - /** - * 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 - */ - findRecordByKey(key: string, ds?: string, objPath?: string): Object; + /** + * 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 + */ + 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 origDs - */ - removeRecordByKey(key: Object, origDs: Object): void; + /** + * 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 origDs + */ + removeRecordByKey(key: Object, origDs: Object): void; - /** - * Removes a record from the data source at specific index. - * - * @param index index of record - * @param origDs - */ - removeRecordByIndex(index: number, origDs: Object): void; + /** + * Removes a record from the data source at specific index. + * + * @param index index of record + * @param origDs + */ + removeRecordByIndex(index: number, origDs: Object): void; - /** - * 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 - */ - deleteRow(rowId: Object, autoCommit: boolean): 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 + */ + 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 - */ - addNode(data: Object): void; + /** + * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back + * + * @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 - */ - removeNode(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 + */ + 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 - */ - getDetachedRecord(t: Object): Object; + /** + * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source + * + * @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. - */ - commit(id?: number): void; + /** + * 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. + */ + 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. - */ - rollback(id?: Object): 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. + */ + rollback(id?: Object): void; - /** - * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source - */ - pendingTransactions(): any[]; + /** + * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source + */ + pendingTransactions(): any[]; - /** - * Returns a list of all transaction objects that are either pending, or have been committed in the data source. - */ - allTransactions(): any[]; + /** + * Returns a list of all transaction objects that are either pending, or have been committed in the data source. + */ + allTransactions(): any[]; - /** - * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently - */ - transactionsAsString(): string; + /** + * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently + */ + transactionsAsString(): string; - /** - * 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) - */ - saveChanges(success: Function, error: Function): 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) + */ + 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 - */ - getCellValue(fieldName: string, record: Object): Object; + /** + * 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 + */ + getCellValue(fieldName: string, record: Object): Object; - /** - * Applicable only when the data source is bound to remote data. - * Gets or sets summaries data. - * 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) - */ - summariesResponse(key?: string, dsObj?: Object): Object; + /** + * Applicable only when the data source is bound to remote data. + * Gets or sets summaries data. + * 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) + */ + summariesResponse(key?: string, dsObj?: Object): Object; - /** - * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. - */ - filteredData(): any[]; + /** + * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. + */ + filteredData(): any[]; - /** - * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). - * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions - * multi-column sorting can be enabled by setting keepSortState to true. - * 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 - */ - sort(fields: Object, direction: string): void; + /** + * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). + * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions + * multi-column sorting can be enabled by setting keepSortState to true. + * 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 + */ + sort(fields: Object, direction: string): void; - /** - * This clears local sorting applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalSorting(): void; + /** + * This clears local sorting applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalSorting(): void; - /** - * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and - * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() - * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] - * expr is the filter expression text , such as "abc", or a regular expression such as *test* - * 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 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: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; + /** + * 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. + */ + filterByText(expression: string, fields?: any[]): void; - /** - * This clears local filtering applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalFilter(): void; + /** + * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and + * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() + * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] + * example 3: [{filterAllFields: true, expr: "abc", fields: [name: "Description", type: "string"]}] + * expr is the filter expression text , such as "abc", or a regular expression such as *test* + * 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: + * + * @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. + */ + filter(fieldExpressions: any[], boolLogic: Object, keepFilterState: Object, fieldExpressionsOnStrings: Object): void; - /** - * Applicable only when the data source is bound to remote data. - * Gets / sets the total number of records in the data source. - * If data binding is remote, and there's paging or filtering enabled, - * 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 key - * @param dsObj - * @param context - */ - totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; + /** + * This clears local filtering applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalFilter(): void; - /** - * 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 - */ - hasTotalRecordsCount(hasCount: boolean): void; + /** + * Applicable only when the data source is bound to remote data. + * Gets / sets the total number of records in the data source. + * If data binding is remote, and there's paging or filtering enabled, + * 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 key + * @param dsObj + * @param context + */ + totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; - /** - * Returns metadata object for the specified key - * - * @param key Primary key of the record - */ - metadata(key: string): Object; + /** + * 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 + */ + hasTotalRecordsCount(hasCount: boolean): void; - /** - * Returns the total number of records in the local data source - */ - totalLocalRecordsCount(): number; + /** + * Returns metadata object for the specified key + * + * @param key Primary key of the record + */ + metadata(key: string): Object; - /** - * Returns the total number of pages - */ - pageCount(): number; + /** + * Returns the total number of records in the local data source + */ + totalLocalRecordsCount(): number; - /** - * 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. - */ - pageIndex(index?: number): number; + /** + * Returns the total number of pages + */ + pageCount(): 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. - */ - persistedPageIndex(value?: number): number; + /** + * 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. + */ + pageIndex(index?: number): number; - /** - * Sets the page index to be equal to the previous page index and rebinds the data source - */ - prevPage(): void; + /** + * 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. + */ + persistedPageIndex(value?: number): number; - /** - * Sets the page index to be equal to the next page index and rebinds the data source - */ - nextPage(): void; + /** + * Sets the page index to be equal to the previous page index and rebinds the data source + */ + prevPage(): void; - /** - * 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. - */ - pageSize(s?: number): number; + /** + * Sets the page index to be equal to the next page index and rebinds the data source + */ + nextPage(): void; - /** - * For internal use - * - * @param dirty - */ - pageSizeDirty(dirty: Object): void; + /** + * 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. + */ + pageSize(s?: number): number; - /** - * 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 - */ - recordsForPage(p: number): void; + /** + * For internal use + * + * @param dirty + */ + pageSizeDirty(dirty: Object): 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 - */ - tableToObject(tableDOM: Element): Object; + /** + * 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 + */ + recordsForPage(p: number): void; - /** - * Parses the string and returns an evaluated JSON object - * - * @param s the JSON as string. - */ - stringToJSONObject(s: string): 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 + */ + tableToObject(tableDOM: Element): Object; - /** - * Parses a string and returns a XML Document - * - * @param s the XML represented as a string - */ - stringToXmlObject(s: string): void; + /** + * Parses the string and returns an evaluated JSON object + * + * @param s the JSON as string. + */ + stringToJSONObject(s: string): void; - /** - * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data - */ - groupByData(): any[]; + /** + * Parses a string and returns a XML Document + * + * @param s the XML represented as a string + */ + stringToXmlObject(s: string): void; - /** - * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) - */ - visibleGroupByData(): any[]; + /** + * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data + */ + groupByData(): any[]; - /** - * Returns the current normalized/transformed and paged/filtered/sorted group-by data - */ - groupByDataView(): any[]; + /** + * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) + */ + visibleGroupByData(): any[]; - /** - * 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 - */ - toggleGroupByRecord(id: string, collapsed: boolean): void; + /** + * Returns the current normalized/transformed and paged/filtered/sorted group-by data + */ + groupByDataView(): any[]; - /** - * Check whether the specified gorupby record is collapsed - * - * @param gbRec id of the grouped record OR grouped record - */ - isGroupByRecordCollapsed(gbRec: Object): boolean; + /** + * 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 + */ + toggleGroupByRecord(id: string, collapsed: boolean): void; - /** - * 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 - */ - isGroupByApplied(exprs?: any[]): boolean; - } + /** + * Check whether the specified gorupby record is collapsed + * + * @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 + */ + isGroupByApplied(exprs?: any[]): boolean; +} } interface IgniteUIStatic { MashupDataSource: typeof Infragistics.MashupDataSource; @@ -5373,12 +5705,12 @@ interface HierarchicalDataSourceSettings { } declare namespace Infragistics { - class HierarchicalDataSource { - constructor(settings: HierarchicalDataSourceSettings); - dataBind(callback: Object, callee: Object): void; - root(): void; - dataAt(path: Object, keyspath: Object): void; - } +class HierarchicalDataSource { + constructor(settings: HierarchicalDataSourceSettings); + dataBind(callback: Object, callee: Object): void; + root(): void; + dataAt(path: Object, keyspath: Object): void; +} } interface IgniteUIStatic { HierarchicalDataSource: typeof Infragistics.HierarchicalDataSource; @@ -5496,15 +5828,27 @@ interface TreeHierarchicalDataSourceSettingsTreeDS { requestDataErrorCallback?: Function; /** + * *** IMPORTANT DEPRECATED *** Use the expandedKey option instead. * The name of the property that keeps track of the expansion state of a data item. Defaults to __ig_options.expanded. */ propertyExpanded?: string; /** + * *** IMPORTANT DEPRECATED *** Use the dataLevelKey option instead. * The name of the property that keeps track of the level in the hierarchy.Defaults to __ig_options.dataLevel. */ propertyDataLevel?: string; + /** + * The name of the property that keeps track of the expansion state of a data item. Defaults to __ig_options.expanded. + */ + expandedKey?: string; + + /** + * The name of the property that keeps track of the level in the hierarchy.Defaults to __ig_options.dataLevel. + */ + dataLevelKey?: string; + /** * If set to TRUE it is expected that the source of data is normalized and transformed(has set dataLevel and expansion state). The source of data is used as flatDataView. Usually used when the paging is remote and paging mode is allLevels, or features are remote(and the processing of the returned result should be made on the server) * @@ -5557,643 +5901,651 @@ interface TreeHierarchicalDataSourceSettings { } declare namespace Infragistics { - class TreeHierarchicalDataSource { - constructor(settings: TreeHierarchicalDataSourceSettings); - - /** - * Data binds to the current data source - * databinding works using the following workflow: - * 1. fire the databinding event - * 2. based on the data source type (see analyzeDataSource()), do the following: - * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. - * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting - * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. - * if no paging/sorting/filtering are enabled, use just this._data to save space - * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL - * if the data source is invalid, throw an exception - * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if - * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object ree - * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion - * 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 - */ - 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. - */ - getParentRowsForRow(dataRow: Object, ds?: Object): Object; - - /** - * Gets the current data bound depth of the tree grid hierarchy. - */ - getDataBoundDepth(): void; - - /** - * 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. - */ - 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 - */ - 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. - */ - 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. - */ - getFlatDataForRecord(record: Object, level?: number): Object; - - /** - * 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. - */ - generateFlatData(data: Object, level?: number): Object; - - /** - * Generates a flat data view from the current (hierarchical)data - */ - generateFlatDataView(): void; - - /** - * Returns the current flat data view - */ - flatDataView(): Object; - - /** - * Returns flat visible data. - */ - getVisibleFlatData(): Object; - - /** - * Returns flat data(without taking into account visible/expansion state). - */ - getFlatData(): Object; - - /** - * Returns total records count(without taking into account visible/expansion state). - */ - getFlatDataCount(): number; - - /** - * 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. - */ - 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. - */ - 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. - */ - 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. - */ - toggleRow(rowId: string, callbackArgs: Function): void; - - /** - * Sorts the data source locally. The result (sorted data) can be obtained by calling dataView(). - * Remote filtering can be performed by just calling dataBind() and setting the settings.sorting.expressions - * multi-column sorting can be enabled by setting keepSortState to true. - * 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 - */ - sort(fields: Object, direction: string): void; - - /** - * Sorts the given data recursively - * fields => an array of fields object definitions: - * 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 - */ - 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 - * - * 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 - */ - sortData(data: Object, fields: Object, direction: string): void; - - /** - * Returns the total number of records in the local data source - */ - totalLocalRecordsCount(): number; - - /** - * Returns the total number of pages - */ - pageCount(): number; - - /** - * Returns the total number of match filtering records in the data source. - * When the dataSource is remote and filtering is applied then it is taken value - * of property "filtering.countRecords" in metatadata - if set. If it is not set returns totalRecordsCount - */ - getFilteringMatchRecordsCount(): number; - - /** - * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() - * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] - * expr is the filter expression text , such as "abc", or a regular expression such as *test* - * 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 fieldExpressionsOnStrings - */ - filter(fieldExpressions: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; - - /** - * Gets the count of the filtered records in the dataView - */ - getFilteredRecordsCountFromDataView(): number; - - /** - * Gets the count of the filtered records - */ - getFilteredRecordsCount(): number; - - /** - * This clears local filtering applied to the data view by resetting it to the original data and applying any paging. - */ - clearLocalFilter(): void; - - /** - * Gets whether the flat data view should be generated by calling the generateFlatDataView method. - */ - shouldCallGenerateFlatDataView(): void; - - /** - * 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. - */ - clearMatchFiltering(data?: Object): void; - - /** - * Gets the path of a record by the record or the record's key - * - * @param record the record or the record's key as string or number - */ - getPathBy(record: Object): void; - - /** - * 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'} - */ - 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 origDs - */ - removeRecordByKey(key: Object, origDs: Object): void; - - /** - * 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 - */ - 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 - */ - 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) - */ - 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' } - */ - fields(fields?: Object): Object; - - /** - * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type - */ - analyzeDataSource(): string; - - /** - * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView - */ - dataView(): any[]; - - /** - * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. - */ - data(): Object; - - /** - * Returns transformed data according to transformed execution: - * 1. Before paging and filtering - * 2. After filtering before paging - * 3. After filtering and paging - * - * @param transformedExecution - */ - transformedData(transformedExecution: Object): Object; - - /** - * Returns summaries data - */ - dataSummaries(): Object; - - /** - * Gets/sets the schema definition. - * - * @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 - */ - pagingSettings(p?: Object): Object; - - /** - * Gets/sets a list of filtering settings - * - * @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 - */ - sortSettings(s?: Object): Object; - - /** - * Gets/sets a list of summaries settings. - * - * @param s object holding all summaries settings. See settings.summaries - */ - summariesSettings(s?: Object): void; - - /** - * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource - * - * @param ds - */ - dataSource(ds?: Object): Object; - - /** - * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type - * - * @param t - * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty - */ - type(t?: Object): string; - - /** - * Removes a record from the data source at specific index. - * - * @param index index of record - * @param origDs - */ - removeRecordByIndex(index: number, origDs: Object): void; - - /** - * 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 - */ - 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 - */ - 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 - */ - 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 - */ - 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 - */ - 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 - */ - 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. - */ - 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. - */ - rollback(id?: Object): void; - - /** - * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source - */ - pendingTransactions(): any[]; - - /** - * Returns a list of all transaction objects that are either pending, or have been committed in the data source. - */ - allTransactions(): any[]; - - /** - * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently - */ - transactionsAsString(): string; - - /** - * 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) - */ - 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 - */ - getCellValue(fieldName: string, record: Object): Object; - - /** - * Applicable only when the data source is bound to remote data. - * Gets or sets summaries data. - * 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) - */ - summariesResponse(key?: string, dsObj?: Object): Object; - - /** - * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. - */ - filteredData(): any[]; - - /** - * This clears local sorting applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalSorting(): void; - - /** - * Applicable only when the data source is bound to remote data. - * Gets / sets the total number of records in the data source. - * If data binding is remote, and there's paging or filtering enabled, - * 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 key - * @param dsObj - * @param context - */ - totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; - - /** - * 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 - */ - hasTotalRecordsCount(hasCount: boolean): void; - - /** - * Returns metadata object for the specified key - * - * @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. - */ - 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. - */ - persistedPageIndex(value?: number): number; - - /** - * Sets the page index to be equal to the previous page index and rebinds the data source - */ - prevPage(): void; - - /** - * Sets the page index to be equal to the next page index and rebinds the data source - */ - nextPage(): void; - - /** - * 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. - */ - pageSize(s?: number): number; - - /** - * For internal use - * - * @param dirty - */ - pageSizeDirty(dirty: Object): void; - - /** - * 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 - */ - 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 - */ - tableToObject(tableDOM: Element): Object; - - /** - * Parses the string and returns an evaluated JSON object - * - * @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 - */ - stringToXmlObject(s: string): void; - - /** - * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data - */ - groupByData(): any[]; - - /** - * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) - */ - visibleGroupByData(): any[]; - - /** - * Returns the current normalized/transformed and paged/filtered/sorted group-by data - */ - groupByDataView(): any[]; - - /** - * 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 - */ - toggleGroupByRecord(id: string, collapsed: boolean): void; - - /** - * Check whether the specified gorupby record is collapsed - * - * @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 - */ - isGroupByApplied(exprs?: any[]): boolean; - } +class TreeHierarchicalDataSource { + constructor(settings: TreeHierarchicalDataSourceSettings); + + /** + * Data binds to the current data source + * databinding works using the following workflow: + * 1. fire the databinding event + * 2. based on the data source type (see analyzeDataSource()), do the following: + * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. + * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting + * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. + * if no paging/sorting/filtering are enabled, use just this._data to save space + * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL + * if the data source is invalid, throw an exception + * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if + * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object ree + * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion + * 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 + */ + 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. + */ + getParentRowsForRow(dataRow: Object, ds?: Object): Object; + + /** + * Gets the current data bound depth of the tree grid hierarchy. + */ + getDataBoundDepth(): void; + + /** + * 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. + */ + 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 + */ + 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. + */ + 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. + */ + getFlatDataForRecord(record: Object, level?: number): Object; + + /** + * 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. + */ + generateFlatData(data: Object, level?: number): Object; + + /** + * Generates a flat data view from the current (hierarchical)data + */ + generateFlatDataView(): void; + + /** + * Returns the current flat data view + */ + flatDataView(): Object; + + /** + * Returns flat visible data. + */ + getVisibleFlatData(): Object; + + /** + * Returns flat data(without taking into account visible/expansion state). + */ + getFlatData(): Object; + + /** + * Returns total records count(without taking into account visible/expansion state). + */ + getFlatDataCount(): number; + + /** + * 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. + */ + 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. + */ + 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. + */ + 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. + */ + toggleRow(rowId: string, callbackArgs: Function): void; + + /** + * Sorts the data source locally. The result (sorted data) can be obtained by calling dataView(). + * Remote filtering can be performed by just calling dataBind() and setting the settings.sorting.expressions + * multi-column sorting can be enabled by setting keepSortState to true. + * 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 + */ + sort(fields: Object, direction: string): void; + + /** + * Sorts the given data recursively + * fields => an array of fields object definitions: + * 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 + */ + 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 + * + * 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 + */ + sortData(data: Object, fields: Object, direction: string): void; + + /** + * Returns the total number of records in the local data source + */ + totalLocalRecordsCount(): number; + + /** + * Returns the total number of pages + */ + pageCount(): number; + + /** + * Returns the total number of match filtering records in the data source. + * When the dataSource is remote and filtering is applied then it is taken value + * of property "filtering.countRecords" in metatadata - if set. If it is not set returns totalRecordsCount + */ + getFilteringMatchRecordsCount(): number; + + /** + * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() + * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] + * expr is the filter expression text , such as "abc", or a regular expression such as *test* + * 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 fieldExpressionsOnStrings + */ + filter(fieldExpressions: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; + + /** + * Gets the count of the filtered records in the dataView + */ + getFilteredRecordsCountFromDataView(): number; + + /** + * Gets the count of the filtered records + */ + getFilteredRecordsCount(): number; + + /** + * This clears local filtering applied to the data view by resetting it to the original data and applying any paging. + */ + clearLocalFilter(): void; + + /** + * Gets whether the flat data view should be generated by calling the generateFlatDataView method. + */ + shouldCallGenerateFlatDataView(): void; + + /** + * 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. + */ + clearMatchFiltering(data?: Object): void; + + /** + * Gets the path of a record by the record or the record's key + * + * @param record + */ + getPathBy(record: Object): string; + + /** + * 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'} + */ + 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 origDs + */ + removeRecordByKey(key: Object, origDs: Object): void; + + /** + * 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 + */ + 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 + */ + 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) + */ + 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' } + */ + fields(fields?: Object): Object; + + /** + * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type + */ + analyzeDataSource(): string; + + /** + * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView + */ + dataView(): any[]; + + /** + * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. + */ + data(): Object; + + /** + * Returns transformed data according to transformed execution: + * 1. Before paging and filtering + * 2. After filtering before paging + * 3. After filtering and paging + * + * @param transformedExecution + */ + transformedData(transformedExecution: Object): Object; + + /** + * Returns summaries data + */ + dataSummaries(): Object; + + /** + * Gets/sets the schema definition. + * + * @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 + */ + pagingSettings(p?: Object): Object; + + /** + * Gets/sets a list of filtering settings + * + * @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 + */ + sortSettings(s?: Object): Object; + + /** + * Gets/sets a list of summaries settings. + * + * @param s object holding all summaries settings. See settings.summaries + */ + summariesSettings(s?: Object): void; + + /** + * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource + * + * @param ds + */ + dataSource(ds?: Object): Object; + + /** + * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type + * + * @param t + * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty + */ + type(t?: Object): string; + + /** + * Removes a record from the data source at specific index. + * + * @param index index of record + * @param origDs + */ + removeRecordByIndex(index: number, origDs: Object): void; + + /** + * 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 + */ + 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 + */ + 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 + */ + 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 + */ + 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 + */ + 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 + */ + 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. + */ + 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. + */ + rollback(id?: Object): void; + + /** + * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source + */ + pendingTransactions(): any[]; + + /** + * Returns a list of all transaction objects that are either pending, or have been committed in the data source. + */ + allTransactions(): any[]; + + /** + * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently + */ + transactionsAsString(): string; + + /** + * 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) + */ + 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 + */ + getCellValue(fieldName: string, record: Object): Object; + + /** + * Applicable only when the data source is bound to remote data. + * Gets or sets summaries data. + * 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) + */ + summariesResponse(key?: string, dsObj?: Object): Object; + + /** + * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. + */ + filteredData(): any[]; + + /** + * This clears local sorting applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalSorting(): void; + + /** + * 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. + */ + filterByText(expression: string, fields?: any[]): void; + + /** + * Applicable only when the data source is bound to remote data. + * Gets / sets the total number of records in the data source. + * If data binding is remote, and there's paging or filtering enabled, + * 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 key + * @param dsObj + * @param context + */ + totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; + + /** + * 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 + */ + hasTotalRecordsCount(hasCount: boolean): void; + + /** + * Returns metadata object for the specified key + * + * @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. + */ + 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. + */ + persistedPageIndex(value?: number): number; + + /** + * Sets the page index to be equal to the previous page index and rebinds the data source + */ + prevPage(): void; + + /** + * Sets the page index to be equal to the next page index and rebinds the data source + */ + nextPage(): void; + + /** + * 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. + */ + pageSize(s?: number): number; + + /** + * For internal use + * + * @param dirty + */ + pageSizeDirty(dirty: Object): void; + + /** + * 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 + */ + 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 + */ + tableToObject(tableDOM: Element): Object; + + /** + * Parses the string and returns an evaluated JSON object + * + * @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 + */ + stringToXmlObject(s: string): void; + + /** + * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data + */ + groupByData(): any[]; + + /** + * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) + */ + visibleGroupByData(): any[]; + + /** + * Returns the current normalized/transformed and paged/filtered/sorted group-by data + */ + groupByDataView(): any[]; + + /** + * 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 + */ + toggleGroupByRecord(id: string, collapsed: boolean): void; + + /** + * Check whether the specified gorupby record is collapsed + * + * @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 + */ + isGroupByApplied(exprs?: any[]): boolean; +} } interface IgniteUIStatic { TreeHierarchicalDataSource: typeof Infragistics.TreeHierarchicalDataSource; } declare namespace Infragistics { - class DvCommonWidget { - option(key: Object, value: Object): void; - } +class DvCommonWidget { + option(key: Object, value: Object): void; +} } interface SimpleTextMarkerTemplateSettings { @@ -6212,50 +6564,166 @@ interface SimpleTextMarkerTemplateSettings { } declare namespace Infragistics { - class SimpleTextMarkerTemplate { - constructor(requireThis: boolean); - constructor(settings: SimpleTextMarkerTemplateSettings); - getText(item: Object, textDelegate: Object): void; - measure(measureInfo: Object): void; - render(renderInfo: Object): void; - } +class SimpleTextMarkerTemplate { + constructor(requireThis: boolean); + constructor(settings: SimpleTextMarkerTemplateSettings); + getText(item: Object, textDelegate: Object): void; + measure(measureInfo: Object): void; + render(renderInfo: Object): void; +} } interface IgniteUIStatic { SimpleTextMarkerTemplate: typeof Infragistics.SimpleTextMarkerTemplate; } +interface GridExcelExporterCallbacks { + /** + * Set a callback that is fired after the cell is exported. + * Function takes arguments sender and args. + * Use args.columnKey to get the igGrid column key of the cell. + * Use args.columnIndex to get the igGrid column index of the cell. + * Use args.cellValue to get the igGrid cell value. + * Use args.rowId to get key or index of row. + * Use args.xlRow to get reference to the worksheet row. + * Use args.grid to get reference to the igGrid widget. + * + */ + cellExported?: Function; + + /** + * Cancel="true" Set a callback that is fired before the cell exporting. + * Function takes arguments sender and args. + * Use args.columnKey to get the igGrid column key of the cell. + * Use args.columnIndex to get the igGrid column index of the cell. + * Use args.cellValue to get or set the igGrid cell value. + * Use args.rowId to get key or index of row. + * Use args.xlRow to get reference to the worksheet row. + * Use args.grid to get reference to the igGrid widget. + * + */ + cellExporting?: Function; + + /** + * Set a callback that is fired when exporting fails. + * Use error to get the reference of error object. + * + */ + error?: Function; + + /** + * Cancel="true" Set a callback that is fired when export is ending, but the document is not saved. + * Function takes arguments sender and args. + * Use args.grid to get reference to the igGrid widget. + * Use args.workbook to get reference to the excel workbook. + * Use args.worksheet to get reference to the excel worksheet. + * + */ + exportEnding?: Function; + + /** + * Cancel="true" Set a callback that is fired when the exporting has started. + * Function takes arguments sender and args. + * Use args.grid to get reference to igGrid widget. + * + */ + exportStarting?: Function; + + /** + * Set a callback that is fired after the header cell is exported. + * Function takes arguments sender and args. + * Use args.headerText to get the igGrid column key of the header cell. + * Use args.columnKey to get the igGrid column key of the header cell. + * Use args.columnIndex to get the igGrid column index of the header cell. + * + */ + headerCellExported?: Function; + + /** + * Cancel="true" Set a callback that is fired before the header cell exporting. + * Function takes arguments sender and args. + * Use args.headerText to get or set the igGrid column key of the header cell. + * Use args.columnKey to get the igGrid column key of the header cell. + * Use args.columnIndex to get the igGrid column index of the header cell. + * + */ + headerCellExporting?: Function; + + /** + * Cancel="true" Set a callback that is fired after the row is exported. + * Function takes arguments sender and args. + * Use args.rowId to get key or index of row. + * Use args.element to get row TR element. + * Use args.xlRow to get reference to the worksheet row. + * Use args.grid to get reference to the igGrid widget. + * Note: When exporting an igHierarchicalGrid this callback is available only for the root grid rows. + * + */ + rowExported?: Function; + + /** + * Cancel="true" Set a callback that is fired before the row exporting. + * Function takes arguments sender and args. + * Use args.rowId to get key or index of row. + * Use args.element to get row TR element. + * Use args.xlRow to get reference to the worksheet row. + * Use args.grid to get reference to the igGrid widget. + * Note: When exporting an igHierarchicalGrid this callback is available only for the root grid rows. + * + */ + rowExporting?: Function; + + /** + * Set a callback that is fired when exporting is successful. + * Use data to get the reference of saved object. + * + */ + success?: Function; + + /** + * Set a callback that is fired after the summary is exported. + * Function takes arguments sender and args. + * Use args.headerText to get the igGrid column header text. + * Use args.columnKey to get the igGrid column key. + * Use args.columnIndex to get the igGrid column index. + * Use args.summary to get a reference to the summary object. + * Use args.xlRowIndex to get the worksheet row index. + * + */ + summaryExported?: Function; + + /** + * Cancel="true" Set a callback that is fired before the summary exporting. + * Function takes arguments sender and args. + * Use args.headerText to get the igGrid column header text. + * Use args.columnKey to get the igGrid column key. + * Use args.columnIndex to get the igGrid column index. + * Use args.summary to get a reference to the summary object. + * Use args.xlRowIndex to get reference to worksheet row index. + * + */ + summaryExporting?: Function; + + /** + * Option for GridExcelExporterCallbacks + */ + [optionName: string]: any; +} + interface GridExcelExporterSettingsGridFeatureOptions { /** - * Indicates whether sorting will be applied in the exported table. This is set_ to none by default, but will change to applied if sorting feature is defined in the igGrid. + * Indicates whether fixed columns will be applied in the exported table. This is set to none by default, but will change to applied if column fixing feature is defined in the igGrid. + * * * Valid values: - * "none" No sorting will be applied in the excel document. - * "applied" Sorting will be applied in the excel document. + * "none" No column fixing will be applied in the excel document. + * "applied" Column fixing will be applied in the excel document. */ - sorting?: string; - - /** - * Indicates whether the rows on the current page or entire data will exported. - * - * Valid values: - * "currentPage" Only current page will be exported to the excel document. - * "allRows" All pages will be exported to the excel document. - */ - paging?: string; - - /** - * Indicates whether hidden columns will be removed from the exported table. This is set to none by default, but will change to applied if hiding feature is defined in the igGrid. - * - * Valid values: - * "none" All hidden columns will be exported to the excel document. - * "applied" Hidden columns will be exported as hidden in the excel document. - * "visibleColumnsOnly" Only visible columns will be exported. - */ - hiding?: string; + columnfixing?: string; /** * Indicates whether filtering will be applied in the exported table. this is set to none by default, but will change to applied if filtering feature is defined in the igGrid. * + * * Valid values: * "none" No filtering will be applied in the excel document. * "applied" Filtering will be applied in the excel document. @@ -6264,17 +6732,40 @@ interface GridExcelExporterSettingsGridFeatureOptions { filtering?: string; /** - * Indicates whether fixed columns will be applied in the exported table. This is set to none by default, but will change to applied if column fixing feature is defined in the igGrid. + * Indicates whether hidden columns will be removed from the exported table. This is set to none by default, but will change to applied if hiding feature is defined in the igGrid. + * * * Valid values: - * "none" No column fixing will be applied in the excel document. - * "applied" Column fixing will be applied in the excel document. + * "none" All hidden columns will be exported to the excel document. + * "applied" Hidden columns will be exported as hidden in the excel document. + * "visibleColumnsOnly" Only visible columns will be exported. */ - columnfixing?: string; + hiding?: string; + + /** + * Indicates whether the rows on the current page or entire data will exported. + * + * + * Valid values: + * "currentPage" Only current page will be exported to the excel document. + * "allRows" All pages will be exported to the excel document. + */ + paging?: string; + + /** + * Indicates whether sorting will be applied in the exported table. This is set_ to none by default, but will change to applied if sorting feature is defined in the igGrid. + * + * + * Valid values: + * "none" No sorting will be applied in the excel document. + * "applied" Sorting will be applied in the excel document. + */ + sorting?: string; /** * Indicates whether summaries will be added in the exported table. This is set to none by default, but will change to applied if summaries feature is defined in the igGrid. * + * * Valid values: * "none" No summaries will be exported to the excel document. * "applied" Summaries will be exported to the excel document. @@ -6288,8 +6779,25 @@ interface GridExcelExporterSettingsGridFeatureOptions { } interface GridExcelExporterSettings { + /** + * List of strings containing the keys for the columns that will not be exported. + * + */ + columnsToSkip?: any[]; + + /** + * Indicates whether all sublevel data will be exported, or only data under expanded rows. + * + * + * Valid values: + * "allRows" All sublevel data will be exported. + * "expandedRows" Only data under expanded rows will be exported. + */ + dataExportMode?: string; + /** * Specifies the name of the excel file that will be generated. + * */ fileName?: string; @@ -6298,33 +6806,10 @@ interface GridExcelExporterSettings { */ gridFeatureOptions?: GridExcelExporterSettingsGridFeatureOptions; - /** - * Specifies the name of workbook where the igGrid will be exported. - */ - worksheetName?: string; - - /** - * List of strings containing the keys for the worksheet columns which will not be applied any filtering - */ - skipFilteringOn?: any[]; - - /** - * List of strings containing the keys for the columns that will not be exported - */ - columnsToSkip?: any[]; - - /** - * Specifies the excel table style region. - * You can set the following table style - * TableStyleMedium[1-28] - * TableStyleLight[1-21] - * TableStyleDark[1-11] - */ - tableStyle?: string; - /** * Indicates whether excel table styles will be the same as grid styles. This is set to applied by default. Custom grid themes are not supported. * + * * Valid values: * "none" The styles from the grid are not applied to the table region. * "applied" The styles from the grid are applied to the table region. @@ -6332,13 +6817,26 @@ interface GridExcelExporterSettings { gridStyling?: string; /** - * Indicates whether all sublevel data will be exported, or only data under expanded rows. + * List of strings containing the keys for the worksheet columns which will not be applied any filtering * - * Valid values: - * "allRows" All sublevel data will be exported. - * "expandedRows" Only data under expanded rows will be exported. */ - dataExportMode?: string; + skipFilteringOn?: any[]; + + /** + * Specifies the excel table style region. + * You can set the following table style + * TableStyleMedium[1-28] + * TableStyleLight[1-21] + * TableStyleDark[1-11] + * + */ + tableStyle?: string; + + /** + * Specifies the name of workbook where the igGrid will be exported. + * + */ + worksheetName?: string; /** * Option for GridExcelExporterSettings @@ -6346,141 +6844,20 @@ interface GridExcelExporterSettings { [optionName: string]: any; } -interface GridExcelExporterCallbacks { - /** - * Cancel="true" Callback fired when the exporting has started. - * Function takes arguments sender and args. - * Use args.grid to get reference to igGrid widget. - */ - exportStarting?: any; - - /** - * Cancel="true" Callback fired when cell exporting has begin. - * Function takes arguments sender and args. - * Use args.columnKey to get the igGrid column key of the cell. - * Use args.columnIndex to get the igGrid column index of the cell. - * Use args.cellValue to get or set the igGrid cell value. - * Use args.rowId to get key or index of row. - * Use args.xlRow to get reference to the worksheet row. - * Use args.grid to get reference to the igGrid widget. - */ - cellExporting?: any; - - /** - * Callback fired when cell exporting has end. - * Function takes arguments sender and args. - * Use args.columnKey to get the igGrid column key of the cell. - * Use args.columnIndex to get the igGrid column index of the cell. - * Use args.cellValue to get the igGrid cell value. - * Use args.rowId to get key or index of row. - * Use args.xlRow to get reference to the worksheet row. - * Use args.grid to get reference to the igGrid widget. - */ - cellExported?: any; - - /** - * Cancel="true" Callback fired when header cell exporting has begin. - * Function takes arguments sender and args. - * Use args.headerText to get or set the igGrid column key of the header cell. - * Use args.columnKey to get the igGrid column key of the header cell. - * Use args.columnIndex to get the igGrid column index of the header cell. - */ - headerCellExporting?: any; - - /** - * Callback fired when header cell exporting has end. - * Function takes arguments sender and args. - * Use args.headerText to get the igGrid column key of the header cell. - * Use args.columnKey to get the igGrid column key of the header cell. - * Use args.columnIndex to get the igGrid column index of the header cell. - */ - headerCellExported?: any; - - /** - * Cancel="true" Callback fired when row exporting has begin. - * Function takes arguments sender and args. - * Use args.rowId to get key or index of row. - * Use args.element to get row TR element. - * Use args.xlRow to get reference to the worksheet row. - * Use args.grid to get reference to the igGrid widget. - * Note: When exporting an igHierarchicalGrid this callback is available only for the root grid rows. - */ - rowExporting?: any; - - /** - * Cancel="true" Callback fired when row exporting has ended. - * Function takes arguments sender and args. - * Use args.rowId to get key or index of row. - * Use args.element to get row TR element. - * Use args.xlRow to get reference to the worksheet row. - * Use args.grid to get reference to the igGrid widget. - * Note: When exporting an igHierarchicalGrid this callback is available only for the root grid rows. - */ - rowExported?: any; - - /** - * Cancel="true" Callback fired when summary exporting has begun. - * Function takes arguments sender and args. - * Use args.headerText to get the igGrid column header text. - * Use args.columnKey to get the igGrid column key. - * Use args.columnIndex to get the igGrid column index. - * Use args.summary to get a reference to the summary object. - * Use args.xlRowIndex to get reference to worksheet row index. - */ - summaryExporting?: any; - - /** - * Callback fired when cell exporting has end. - * Function takes arguments sender and args. - * Use args.headerText to get the igGrid column header text. - * Use args.columnKey to get the igGrid column key. - * Use args.columnIndex to get the igGrid column index. - * Use args.summary to get a reference to the summary object. - * Use args.xlRowIndex to get the worksheet row index. - */ - summaryExported?: any; - - /** - * Cancel="true" Callback fired when export is ending, but the document is not saved. - * Function takes arguments sender and args. - * Use args.grid to get reference to the igGrid widget. - * Use args.workbook to get reference to the excel workbook. - * Use args.worksheet to get reference to the excel worksheet. - */ - exportEnding?: any; - - /** - * Callback fired when exporting is successful. - * Use data to get the reference of saved object. - */ - success?: any; - - /** - * Callback fired when exporting is failed. - * Use error to get the reference of error object. - */ - error?: any; - - /** - * Option for GridExcelExporterCallbacks - */ - [optionName: string]: any; -} - declare namespace Infragistics { - class GridExcelExporter { - constructor(settings: GridExcelExporterSettings); - constructor(callbacks: GridExcelExporterCallbacks); +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. - */ - exportGrid(grid: Object, userSettings: Object, userCallbacks: Object): void; - } + /** + * 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. + */ + exportGrid(grid: Object, userSettings: Object, userCallbacks: Object): void; +} } interface IgniteUIStatic { GridExcelExporter: typeof Infragistics.GridExcelExporter; @@ -6617,315 +6994,315 @@ interface OlapXmlaDataSourceOptions { } declare namespace Infragistics { - class OlapXmlaDataSource { - constructor(options: OlapXmlaDataSourceOptions); +class OlapXmlaDataSource { + constructor(options: OlapXmlaDataSourceOptions); - /** - * Initializes the data source and returns a promise that will be resolved once the data source is initialized. - * The promise's result will be the metadata tree for the catalog/cube/measureGroup specified in the settings or null if the settings do not provide a valid cube initialization data. - * The data source is not functional until it has been initialized and all other methods other than initialize() will throw an error if isInitialized() returns false. - */ - initialize(): Object; + /** + * Initializes the data source and returns a promise that will be resolved once the data source is initialized. + * The promise's result will be the metadata tree for the catalog/cube/measureGroup specified in the settings or null if the settings do not provide a valid cube initialization data. + * The data source is not functional until it has been initialized and all other methods other than initialize() will throw an error if isInitialized() returns false. + */ + initialize(): Object; - /** - * Retrieves the initialization state of the data source. - */ - isInitialized(): boolean; + /** + * Retrieves the initialization state of the data source. + */ + isInitialized(): boolean; - /** - * Indicates whether the data source is modified. - */ - isModified(): boolean; + /** + * Indicates whether the data source is modified. + */ + isModified(): boolean; - /** - * Indicates whether the update() method execution is in progress. - */ - isUpdating(): boolean; + /** + * Indicates whether the update() method execution is in progress. + */ + isUpdating(): boolean; - /** - * Retrieves the currently loaded catalogs in the data source. - */ - catalogs(): any[]; + /** + * Retrieves the currently loaded catalogs in the data source. + */ + catalogs(): any[]; - /** - * Retrieves the current catalog in the data source. - */ - catalog(): Object; + /** + * Retrieves the current catalog in the data source. + */ + catalog(): Object; - /** - * Sets the current catalog for the data source and updates the cubes() and catalog() properties. - * - * @param catalogName the name of the catalog. - */ - setCatalog(catalogName: string): Object; + /** + * Sets the current catalog for the data source and updates the cubes() and catalog() properties. + * + * @param catalogName the name of the catalog. + */ + setCatalog(catalogName: string): Object; - /** - * Retrieves the currently loaded cubes in the data source. - */ - cubes(): any[]; + /** + * Retrieves the currently loaded cubes in the data source. + */ + cubes(): any[]; - /** - * Retrieves the current cube in the data source. - */ - cube(): Object; + /** + * Retrieves the current cube in the data source. + */ + cube(): Object; - /** - * Sets the current cube for the data source and updates the cube(), measureGroup() and metadataTree() properties. - * - * @param cubeName the name of the cube. - */ - setCube(cubeName: string): Object; + /** + * Sets the current cube for the data source and updates the cube(), measureGroup() and metadataTree() properties. + * + * @param cubeName the name of the cube. + */ + setCube(cubeName: string): Object; - /** - * Retrieves the currently loaded measure groups in the data source. - */ - measureGroups(): any[]; + /** + * Retrieves the currently loaded measure groups in the data source. + */ + measureGroups(): any[]; - /** - * Retrieves the current measureGroup in the data source. - */ - measureGroup(): Object; + /** + * Retrieves the current measureGroup in the data source. + */ + measureGroup(): Object; - /** - * Sets the current measure group for the data source and updates the measureGroup() and metadataTree() properties. - * Even though the catalogs/cubes/measureGroups items are cascading(e.g. in order to load the cubes a catalog has to be set) in order to construct the metadata tree a measure group is not required as it just filters the resulting metadata. - * Once setCube(cubeName) is called the metadata tree would be loaded and the measureGroup() property would be filled with the default '(All)' measure group which indicates that no measure group is selected. - * - * @param measureGroupName the name of the measure group. - */ - setMeasureGroup(measureGroupName: string): Object; + /** + * Sets the current measure group for the data source and updates the measureGroup() and metadataTree() properties. + * Even though the catalogs/cubes/measureGroups items are cascading(e.g. in order to load the cubes a catalog has to be set) in order to construct the metadata tree a measure group is not required as it just filters the resulting metadata. + * Once setCube(cubeName) is called the metadata tree would be loaded and the measureGroup() property would be filled with the default '(All)' measure group which indicates that no measure group is selected. + * + * @param measureGroupName the name of the measure group. + */ + setMeasureGroup(measureGroupName: string): Object; - /** - * Returns the fully loaded metadata tree. - */ - metadataTree(): Object; + /** + * Returns the fully loaded metadata tree. + */ + metadataTree(): Object; - /** - * Adds a hierarchy to the rows of the pivot grid. - * - * @param rowItem An object of type $.ig.Hierarchy which is the hierarchy to add in the pivot grid rows. - */ - addRowItem(rowItem: Object): void; + /** + * Adds a hierarchy to the rows of the pivot grid. + * + * @param rowItem An object of type $.ig.Hierarchy which is the hierarchy to add in the pivot grid rows. + */ + addRowItem(rowItem: Object): void; - /** - * Removes a hierarchy or the measure list from the rows of the pivot grid. - * - * @param rowItem an object of type $.ig.Hierarchy or $.ig.MeasureList which is the hierarchy to remove or the measure list if there are more than one measures added and the measure list location is set to "rows". - */ - removeRowItem(rowItem: Object): void; + /** + * Removes a hierarchy or the measure list from the rows of the pivot grid. + * + * @param rowItem an object of type $.ig.Hierarchy or $.ig.MeasureList which is the hierarchy to remove or the measure list if there are more than one measures added and the measure list location is set to "rows". + */ + removeRowItem(rowItem: Object): void; - /** - * Adds a hierarchy to the columns of the pivot grid. - * - * @param columnItem an object of type $.ig.Hierarchy which is the hierarchy to add in the pivot grid columns. - */ - addColumnItem(columnItem: Object): void; + /** + * Adds a hierarchy to the columns of the pivot grid. + * + * @param columnItem an object of type $.ig.Hierarchy which is the hierarchy to add in the pivot grid columns. + */ + addColumnItem(columnItem: Object): void; - /** - * Removes a hierarchy or the measure list from the columns of the pivot grid. - * - * @param columnItem an object of type $.ig.Hierarchy or $.ig.MeasureList which is the hierarchy to remove or the measure list if there are more than one measures added and the measure list location is set to "columns". - */ - removeColumnItem(columnItem: Object): void; + /** + * Removes a hierarchy or the measure list from the columns of the pivot grid. + * + * @param columnItem an object of type $.ig.Hierarchy or $.ig.MeasureList which is the hierarchy to remove or the measure list if there are more than one measures added and the measure list location is set to "columns". + */ + removeColumnItem(columnItem: Object): void; - /** - * Adds a hierarchy to the filter axis of the pivot grid. - * - * @param filterItem an object of type $.ig.Hierarchy which is the hierarchy to add. - */ - addFilterItem(filterItem: Object): void; + /** + * Adds a hierarchy to the filter axis of the pivot grid. + * + * @param filterItem an object of type $.ig.Hierarchy which is the hierarchy to add. + */ + addFilterItem(filterItem: Object): void; - /** - * Removes a hierarchy from the filter axis of the pivot grid. - * - * @param filterItem an object of type $.ig.Hierarchy which is the hierarchy to remove. - */ - removeFilterItem(filterItem: Object): void; + /** + * Removes a hierarchy from the filter axis of the pivot grid. + * + * @param filterItem an object of type $.ig.Hierarchy which is the hierarchy to remove. + */ + removeFilterItem(filterItem: Object): void; - /** - * Adds a measure to the measures of the pivot grid. - * - * @param measureItem an object of type $.ig.Measure which is the measure to add. - */ - addMeasureItem(measureItem: Object): void; + /** + * Adds a measure to the measures of the pivot grid. + * + * @param measureItem an object of type $.ig.Measure which is the measure to add. + */ + addMeasureItem(measureItem: Object): void; - /** - * Removes a measure from the measures of the pivot grid. - * - * @param measureItem An object of type $.ig.Measure which is the measure to remove. - */ - removeMeasureItem(measureItem: Object): void; + /** + * Removes a measure from the measures of the pivot grid. + * + * @param measureItem An object of type $.ig.Measure which is the measure to remove. + */ + removeMeasureItem(measureItem: Object): void; - /** - * Sets the index at which the measure list will be positioned in the rows/columns it resides. - * - * @param index the index where measure list to appear. - */ - setMeasureListIndex(index: number): void; + /** + * Sets the index at which the measure list will be positioned in the rows/columns it resides. + * + * @param index the index where measure list to appear. + */ + setMeasureListIndex(index: number): void; - /** - * Sets the location of the measure list. - * - * @param location accepted values are 'rows' and 'columns'. - */ - setMeasureListLocation(location: Object): void; + /** + * Sets the location of the measure list. + * + * @param location accepted values are 'rows' and 'columns'. + */ + setMeasureListLocation(location: Object): void; - /** - * Sets a tuple member to be expanded next time the update() method is called. - * Calling this method on an already expanded member does nothing. - * - * @param axisName the name of the axis for the tuple. - * @param tupleIndex the index of the tuple in the axis. - * @param memberIndex the index of the member in the tuple. - */ - expandTupleMember(axisName: string, tupleIndex: number, memberIndex: number): void; + /** + * Sets a tuple member to be expanded next time the update() method is called. + * Calling this method on an already expanded member does nothing. + * + * @param axisName the name of the axis for the tuple. + * @param tupleIndex the index of the tuple in the axis. + * @param memberIndex the index of the member in the tuple. + */ + expandTupleMember(axisName: string, tupleIndex: number, memberIndex: number): void; - /** - * Sets a tuple member to be collapsed next time the update() method is called. - * Calling this method on an already collapsed member does nothing. - * - * @param axisName the name of the axis for the tuple. - * @param tupleIndex the index of the tuple in the axis. - * @param memberIndex the index of the member in the tuple. - */ - collapseTupleMember(axisName: string, tupleIndex: number, memberIndex: number): void; + /** + * Sets a tuple member to be collapsed next time the update() method is called. + * Calling this method on an already collapsed member does nothing. + * + * @param axisName the name of the axis for the tuple. + * @param tupleIndex the index of the tuple in the axis. + * @param memberIndex the index of the member in the tuple. + */ + collapseTupleMember(axisName: string, tupleIndex: number, memberIndex: number): void; - /** - * Returns the items in the row axis. - */ - rowAxis(): any[]; + /** + * Returns the items in the row axis. + */ + rowAxis(): any[]; - /** - * Returns the items in the column axis. - */ - columnAxis(): any[]; + /** + * Returns the items in the column axis. + */ + columnAxis(): any[]; - /** - * Returns the items in the filter axis. - */ - filters(): any[]; + /** + * Returns the items in the filter axis. + */ + filters(): any[]; - /** - * Returns the items in the measures axis. - */ - measures(): any[]; + /** + * Returns the items in the measures axis. + */ + measures(): any[]; - /** - * Returns the result from the last update or null if the last update was unsuccessful. - */ - result(): Object; + /** + * Returns the result from the last update or null if the last update was unsuccessful. + */ + result(): Object; - /** - * Clears all pending changes since last time the update() method is called. - */ - clearPendingChanges(): void; + /** + * Clears all pending changes since last time the update() method is called. + */ + clearPendingChanges(): void; - /** - * Performs an update with the list of pending changes and updates the data source result. - */ - update(): Object; + /** + * Performs an update with the list of pending changes and updates the data source result. + */ + update(): Object; - /** - * Gets the first element of the specified elementType which matches the specified predicate or null if there is no such element found. - * - * @param predicate a predicate callback invoked against each core element of the specified type. It has to return true when the element has matched the serach criteria, otherwise - false. - * @param elementType an object specified by $.ig.ICoreOlapElement.prototype.$type property. Valid types which prototype can be examined are: $.ig.Dimension, $.ig.Hierarchy, $.ig.Level, $.ig.Measure and $.ig.MeasureList. - */ - getCoreElement(predicate: Function, elementType: Object): Object; + /** + * Gets the first element of the specified elementType which matches the specified predicate or null if there is no such element found. + * + * @param predicate a predicate callback invoked against each core element of the specified type. It has to return true when the element has matched the serach criteria, otherwise - false. + * @param elementType an object specified by $.ig.ICoreOlapElement.prototype.$type property. Valid types which prototype can be examined are: $.ig.Dimension, $.ig.Hierarchy, $.ig.Level, $.ig.Measure and $.ig.MeasureList. + */ + getCoreElement(predicate: Function, elementType: Object): Object; - /** - * Gets an array with elements of the specified elementType which match the specified predicate or empty array if there is no such element found. - * - * @param predicate a predicate callback invoked against each core element of the specified type. It has to return true when the element has matched the serach criteria, otherwise - false. - * @param elementType an object specified by $.ig.ICoreOlapElement.prototype.$type property. Valid types which prototype can be examined are: $.ig.Dimension, $.ig.Hierarchy, $.ig.Level, $.ig.Measure and $.ig.MeasureList. - */ - getCoreElements(predicate: Function, elementType: Object): Object; + /** + * Gets an array with elements of the specified elementType which match the specified predicate or empty array if there is no such element found. + * + * @param predicate a predicate callback invoked against each core element of the specified type. It has to return true when the element has matched the serach criteria, otherwise - false. + * @param elementType an object specified by $.ig.ICoreOlapElement.prototype.$type property. Valid types which prototype can be examined are: $.ig.Dimension, $.ig.Hierarchy, $.ig.Level, $.ig.Measure and $.ig.MeasureList. + */ + getCoreElements(predicate: Function, elementType: Object): Object; - /** - * Returns $.ig.Dimension object for the specified unique name. - * - * @param dimensionUniqueName the unique name of the searched dimension object. - */ - getDimension(dimensionUniqueName: string): Object; + /** + * Returns $.ig.Dimension object for the specified unique name. + * + * @param dimensionUniqueName the unique name of the searched dimension object. + */ + getDimension(dimensionUniqueName: string): Object; - /** - * Returns $.ig.Hierarchy object for the specified unique name. - * - * @param hierarchyUniqueName the unique name of the searched hierarchy object. - */ - getHierarchy(hierarchyUniqueName: string): Object; + /** + * Returns $.ig.Hierarchy object for the specified unique name. + * + * @param hierarchyUniqueName the unique name of the searched hierarchy object. + */ + getHierarchy(hierarchyUniqueName: string): Object; - /** - * Returns $.ig.Level object for the specified unique name. - * - * @param levelUniqueName the unique name of the searched level object. - */ - getLevel(levelUniqueName: string): Object; + /** + * Returns $.ig.Level object for the specified unique name. + * + * @param levelUniqueName the unique name of the searched level object. + */ + getLevel(levelUniqueName: string): Object; - /** - * Returns $.ig.Measure object for the specified unique name. - * - * @param measureUniqueName the unique name of the searched measure object. - */ - getMeasure(measureUniqueName: string): Object; + /** + * Returns $.ig.Measure object for the specified unique name. + * + * @param measureUniqueName the unique name of the searched measure object. + */ + getMeasure(measureUniqueName: string): Object; - /** - * Returns $.ig.MeasureList object available when operates with more than one $.ig.Measure object. - */ - getMeasureList(): Object; + /** + * Returns $.ig.MeasureList object available when operates with more than one $.ig.Measure object. + */ + getMeasureList(): Object; - /** - * Returns an array of strings with the unique names of selected for given hierarchy filter members. - * - * @param hierarchyUniqueName the unique name of the hierarchy whose active filter members are returned. - */ - getFilterMemberNames(hierarchyUniqueName: string): any[]; + /** + * Returns an array of strings with the unique names of selected for given hierarchy filter members. + * + * @param hierarchyUniqueName the unique name of the hierarchy whose active filter members are returned. + */ + getFilterMemberNames(hierarchyUniqueName: string): any[]; - /** - * Adds a member to list of filter members that will be present in result. - * If a member of given hierarchy is added to this filter list then only those members which are present in this filter list will be present for that hierarchy in the result. - * - * @param hierarchyUniqueName the unique name of the hierarchy this member belongs to. - * @param memberUniqueName the unique name of the member to be added. - */ - addFilterMember(hierarchyUniqueName: string, memberUniqueName: string): void; + /** + * Adds a member to list of filter members that will be present in result. + * If a member of given hierarchy is added to this filter list then only those members which are present in this filter list will be present for that hierarchy in the result. + * + * @param hierarchyUniqueName the unique name of the hierarchy this member belongs to. + * @param memberUniqueName the unique name of the member to be added. + */ + addFilterMember(hierarchyUniqueName: string, memberUniqueName: string): void; - /** - * Removes a member from the list of filter members that will be present in result. - * - * @param hierarchyUniqueName the unique name of the hierarchy this member belongs to. - * @param memberUniqueName the unique name of the member to be removed. - */ - removeFilterMember(hierarchyUniqueName: string, memberUniqueName: string): void; + /** + * Removes a member from the list of filter members that will be present in result. + * + * @param hierarchyUniqueName the unique name of the hierarchy this member belongs to. + * @param memberUniqueName the unique name of the member to be removed. + */ + removeFilterMember(hierarchyUniqueName: string, memberUniqueName: string): void; - /** - * Removes all members from the list of filter members and the filter for the specified hierarchy is cleared. - * - * @param hierarchyUniqueName the unique name of the hierarchy which filter members to be cleared. - */ - removeAllFilterMembers(hierarchyUniqueName: string): void; + /** + * Removes all members from the list of filter members and the filter for the specified hierarchy is cleared. + * + * @param hierarchyUniqueName the unique name of the hierarchy which filter members to be cleared. + */ + removeAllFilterMembers(hierarchyUniqueName: string): void; - /** - * Returns Promise which on completion provides an array of $.ig.OlapResultAxisMember objects of selected for given level filter member. - * - * @param levelUniqueName the unique name of the member whose active filter members are returned. - */ - getMembersOfLevel(levelUniqueName: string): void; + /** + * Returns Promise which on completion provides an array of $.ig.OlapResultAxisMember objects of selected for given level filter member. + * + * @param levelUniqueName the unique name of the member whose active filter members are returned. + */ + getMembersOfLevel(levelUniqueName: string): void; - /** - * Returns Promise which on completion provides an array of $.ig.OlapResultAxisMember objects of selected for given hierarchy filter member. - * - * @param hierarchyUniqueName the unique name of the member whose active filter members are returned. - */ - getMembersOfHierarchy(hierarchyUniqueName: string): void; + /** + * Returns Promise which on completion provides an array of $.ig.OlapResultAxisMember objects of selected for given hierarchy filter member. + * + * @param hierarchyUniqueName the unique name of the member whose active filter members are returned. + */ + getMembersOfHierarchy(hierarchyUniqueName: string): void; - /** - * Returns Promise which on completion provides an array of $.ig.OlapResultAxisMember objects that are children of the current member. - * - * @param memberUniqueName the unique name of the member whose active filter members are returned. - */ - getMembersOfMember(memberUniqueName: string): void; - } + /** + * Returns Promise which on completion provides an array of $.ig.OlapResultAxisMember objects that are children of the current member. + * + * @param memberUniqueName the unique name of the member whose active filter members are returned. + */ + getMembersOfMember(memberUniqueName: string): void; +} } interface IgniteUIStatic { OlapXmlaDataSource: typeof Infragistics.OlapXmlaDataSource; @@ -7159,342 +7536,342 @@ interface OlapFlatDataSourceOptions { } declare namespace Infragistics { - class OlapFlatDataSource { - constructor(options: OlapFlatDataSourceOptions); +class OlapFlatDataSource { + constructor(options: OlapFlatDataSourceOptions); - /** - * Initializes the data source and returns a promise that will be resolved once the data source is initialized. - * The promise's result will be the metadata tree for the catalog/cube/measureGroup specified in the settings or null if the settings do not provide a valid cube initialization data. - * The data source is not functional until it has been initialized and all other methods other than initialize() will throw an error if isInitialized() returns false. - */ - initialize(): Object; + /** + * Initializes the data source and returns a promise that will be resolved once the data source is initialized. + * The promise's result will be the metadata tree for the catalog/cube/measureGroup specified in the settings or null if the settings do not provide a valid cube initialization data. + * The data source is not functional until it has been initialized and all other methods other than initialize() will throw an error if isInitialized() returns false. + */ + initialize(): Object; - /** - * Retrieves the initialization state of the data source. - */ - isInitialized(): boolean; + /** + * Retrieves the initialization state of the data source. + */ + isInitialized(): boolean; - /** - * Indicates whether the data source is modified. - */ - isModified(): boolean; + /** + * Indicates whether the data source is modified. + */ + isModified(): boolean; - /** - * Indicates whether the update() method execution is in progress. - */ - isUpdating(): boolean; + /** + * Indicates whether the update() method execution is in progress. + */ + isUpdating(): boolean; - /** - * Retrieves the currently loaded cubes in the data source. - */ - cubes(): any[]; + /** + * Retrieves the currently loaded cubes in the data source. + */ + cubes(): any[]; - /** - * Retrieves the current cube in the data source. - */ - cube(): Object; + /** + * Retrieves the current cube in the data source. + */ + cube(): Object; - /** - * Sets the current cube for the data source and updates the cube(), measureGroup() and metadataTree() properties. - * - * @param cubeName the name of the cube. - */ - setCube(cubeName: string): Object; + /** + * Sets the current cube for the data source and updates the cube(), measureGroup() and metadataTree() properties. + * + * @param cubeName the name of the cube. + */ + setCube(cubeName: string): Object; - /** - * Returns the fully loaded metadata tree. - */ - metadataTree(): Object; + /** + * Returns the fully loaded metadata tree. + */ + metadataTree(): Object; - /** - * Adds a hierarchy to the rows of the pivot grid. - * - * @param rowItem An object of type $.ig.Hierarchy which is the hierarchy to add in the pivot grid rows. - */ - addRowItem(rowItem: Object): void; + /** + * Adds a hierarchy to the rows of the pivot grid. + * + * @param rowItem An object of type $.ig.Hierarchy which is the hierarchy to add in the pivot grid rows. + */ + addRowItem(rowItem: Object): void; - /** - * Removes a hierarchy or the measure list from the rows of the pivot grid. - * - * @param rowItem an object of type $.ig.Hierarchy or $.ig.MeasureList which is the hierarchy to remove or the measure list if there are more than one measures added and the measure list location is set to "rows". - */ - removeRowItem(rowItem: Object): void; + /** + * Removes a hierarchy or the measure list from the rows of the pivot grid. + * + * @param rowItem an object of type $.ig.Hierarchy or $.ig.MeasureList which is the hierarchy to remove or the measure list if there are more than one measures added and the measure list location is set to "rows". + */ + removeRowItem(rowItem: Object): void; - /** - * Adds a hierarchy to the columns of the pivot grid. - * - * @param columnItem an object of type $.ig.Hierarchy which is the hierarchy to add in the pivot grid columns. - */ - addColumnItem(columnItem: Object): void; + /** + * Adds a hierarchy to the columns of the pivot grid. + * + * @param columnItem an object of type $.ig.Hierarchy which is the hierarchy to add in the pivot grid columns. + */ + addColumnItem(columnItem: Object): void; - /** - * Removes a hierarchy or the measure list from the columns of the pivot grid. - * - * @param columnItem an object of type $.ig.Hierarchy or $.ig.MeasureList which is the hierarchy to remove or the measure list if there are more than one measures added and the measure list location is set to "columns". - */ - removeColumnItem(columnItem: Object): void; + /** + * Removes a hierarchy or the measure list from the columns of the pivot grid. + * + * @param columnItem an object of type $.ig.Hierarchy or $.ig.MeasureList which is the hierarchy to remove or the measure list if there are more than one measures added and the measure list location is set to "columns". + */ + removeColumnItem(columnItem: Object): void; - /** - * Adds a hierarchy to the filter axis of the pivot grid. - * - * @param filterItem an object of type $.ig.Hierarchy which is the hierarchy to add. - */ - addFilterItem(filterItem: Object): void; + /** + * Adds a hierarchy to the filter axis of the pivot grid. + * + * @param filterItem an object of type $.ig.Hierarchy which is the hierarchy to add. + */ + addFilterItem(filterItem: Object): void; - /** - * Removes a hierarchy from the filter axis of the pivot grid. - * - * @param filterItem an object of type $.ig.Hierarchy which is the hierarchy to remove. - */ - removeFilterItem(filterItem: Object): void; + /** + * Removes a hierarchy from the filter axis of the pivot grid. + * + * @param filterItem an object of type $.ig.Hierarchy which is the hierarchy to remove. + */ + removeFilterItem(filterItem: Object): void; - /** - * Adds a measure to the measures of the pivot grid. - * - * @param measureItem an object of type $.ig.Measure which is the measure to add. - */ - addMeasureItem(measureItem: Object): void; + /** + * Adds a measure to the measures of the pivot grid. + * + * @param measureItem an object of type $.ig.Measure which is the measure to add. + */ + addMeasureItem(measureItem: Object): void; - /** - * Removes a measure from the measures of the pivot grid. - * - * @param measureItem An object of type $.ig.Measure which is the measure to remove. - */ - removeMeasureItem(measureItem: Object): void; + /** + * Removes a measure from the measures of the pivot grid. + * + * @param measureItem An object of type $.ig.Measure which is the measure to remove. + */ + removeMeasureItem(measureItem: Object): void; - /** - * Sets the index at which the measure list will be positioned in the rows/columns it resides. - * - * @param index the index where measure list to appear. - */ - setMeasureListIndex(index: number): void; + /** + * Sets the index at which the measure list will be positioned in the rows/columns it resides. + * + * @param index the index where measure list to appear. + */ + setMeasureListIndex(index: number): void; - /** - * Sets the location of the measure list. - * - * @param location accepted values are 'rows' and 'columns'. - */ - setMeasureListLocation(location: Object): void; + /** + * Sets the location of the measure list. + * + * @param location accepted values are 'rows' and 'columns'. + */ + setMeasureListLocation(location: Object): void; - /** - * Sets a tuple member to be expanded next time the update() method is called. - * Calling this method on an already expanded member does nothing. - * - * @param axisName the name of the axis for the tuple. - * @param tupleIndex the index of the tuple in the axis. - * @param memberIndex the index of the member in the tuple. - */ - expandTupleMember(axisName: string, tupleIndex: number, memberIndex: number): void; + /** + * Sets a tuple member to be expanded next time the update() method is called. + * Calling this method on an already expanded member does nothing. + * + * @param axisName the name of the axis for the tuple. + * @param tupleIndex the index of the tuple in the axis. + * @param memberIndex the index of the member in the tuple. + */ + expandTupleMember(axisName: string, tupleIndex: number, memberIndex: number): void; - /** - * Sets a tuple member to be collapsed next time the update() method is called. - * Calling this method on an already collapsed member does nothing. - * - * @param axisName the name of the axis for the tuple. - * @param tupleIndex the index of the tuple in the axis. - * @param memberIndex the index of the member in the tuple. - */ - collapseTupleMember(axisName: string, tupleIndex: number, memberIndex: number): void; + /** + * Sets a tuple member to be collapsed next time the update() method is called. + * Calling this method on an already collapsed member does nothing. + * + * @param axisName the name of the axis for the tuple. + * @param tupleIndex the index of the tuple in the axis. + * @param memberIndex the index of the member in the tuple. + */ + collapseTupleMember(axisName: string, tupleIndex: number, memberIndex: number): void; - /** - * Returns the items in the row axis. - */ - rowAxis(): any[]; + /** + * Returns the items in the row axis. + */ + rowAxis(): any[]; - /** - * Returns the items in the column axis. - */ - columnAxis(): any[]; + /** + * Returns the items in the column axis. + */ + columnAxis(): any[]; - /** - * Returns the items in the filter axis. - */ - filters(): any[]; + /** + * Returns the items in the filter axis. + */ + filters(): any[]; - /** - * Returns the items in the measures axis. - */ - measures(): any[]; + /** + * Returns the items in the measures axis. + */ + measures(): any[]; - /** - * Returns the result from the last update or null if the last update was unsuccessful. - */ - result(): Object; + /** + * Returns the result from the last update or null if the last update was unsuccessful. + */ + result(): Object; - /** - * Clears all pending changes since last time the update() method is called. - */ - clearPendingChanges(): void; + /** + * Clears all pending changes since last time the update() method is called. + */ + clearPendingChanges(): void; - /** - * Performs an update with the list of pending changes and updates the data source result. - */ - update(): Object; + /** + * Performs an update with the list of pending changes and updates the data source result. + */ + update(): Object; - /** - * Gets the first element of the specified elementType which matches the specified predicate or null if there is no such element found. - * - * @param predicate a predicate callback invoked against each core element of the specified type. It has to return true when the element has matched the serach criteria, otherwise - false. - * @param elementType an object specified by $.ig.ICoreOlapElement.prototype.$type property. Valid types which prototype can be examined are: $.ig.Dimension, $.ig.Hierarchy, $.ig.Level, $.ig.Measure and $.ig.MeasureList. - */ - getCoreElement(predicate: Function, elementType: Object): Object; + /** + * Gets the first element of the specified elementType which matches the specified predicate or null if there is no such element found. + * + * @param predicate a predicate callback invoked against each core element of the specified type. It has to return true when the element has matched the serach criteria, otherwise - false. + * @param elementType an object specified by $.ig.ICoreOlapElement.prototype.$type property. Valid types which prototype can be examined are: $.ig.Dimension, $.ig.Hierarchy, $.ig.Level, $.ig.Measure and $.ig.MeasureList. + */ + getCoreElement(predicate: Function, elementType: Object): Object; - /** - * Gets an array with elements of the specified elementType which match the specified predicate or empty array if there is no such element found. - * - * @param predicate a predicate callback invoked against each core element of the specified type. It has to return true when the element has matched the serach criteria, otherwise - false. - * @param elementType an object specified by $.ig.ICoreOlapElement.prototype.$type property. Valid types which prototype can be examined are: $.ig.Dimension, $.ig.Hierarchy, $.ig.Level, $.ig.Measure and $.ig.MeasureList. - */ - getCoreElements(predicate: Function, elementType: Object): Object; + /** + * Gets an array with elements of the specified elementType which match the specified predicate or empty array if there is no such element found. + * + * @param predicate a predicate callback invoked against each core element of the specified type. It has to return true when the element has matched the serach criteria, otherwise - false. + * @param elementType an object specified by $.ig.ICoreOlapElement.prototype.$type property. Valid types which prototype can be examined are: $.ig.Dimension, $.ig.Hierarchy, $.ig.Level, $.ig.Measure and $.ig.MeasureList. + */ + getCoreElements(predicate: Function, elementType: Object): Object; - /** - * Returns $.ig.Dimension object for the specified unique name. - * - * @param dimensionUniqueName the unique name of the searched dimension object. - */ - getDimension(dimensionUniqueName: string): Object; + /** + * Returns $.ig.Dimension object for the specified unique name. + * + * @param dimensionUniqueName the unique name of the searched dimension object. + */ + getDimension(dimensionUniqueName: string): Object; - /** - * Returns $.ig.Hierarchy object for the specified unique name. - * - * @param hierarchyUniqueName the unique name of the searched hierarchy object. - */ - getHierarchy(hierarchyUniqueName: string): Object; + /** + * Returns $.ig.Hierarchy object for the specified unique name. + * + * @param hierarchyUniqueName the unique name of the searched hierarchy object. + */ + getHierarchy(hierarchyUniqueName: string): Object; - /** - * Returns $.ig.Level object for the specified unique name. - * - * @param levelUniqueName the unique name of the searched level object. - */ - getLevel(levelUniqueName: string): Object; + /** + * Returns $.ig.Level object for the specified unique name. + * + * @param levelUniqueName the unique name of the searched level object. + */ + getLevel(levelUniqueName: string): Object; - /** - * Returns $.ig.Measure object for the specified unique name. - * - * @param measureUniqueName the unique name of the searched measure object. - */ - getMeasure(measureUniqueName: string): Object; + /** + * Returns $.ig.Measure object for the specified unique name. + * + * @param measureUniqueName the unique name of the searched measure object. + */ + getMeasure(measureUniqueName: string): Object; - /** - * Returns $.ig.MeasureList object available when operates with more than one $.ig.Measure object. - */ - getMeasureList(): Object; + /** + * Returns $.ig.MeasureList object available when operates with more than one $.ig.Measure object. + */ + getMeasureList(): Object; - /** - * Returns an array of strings with the unique names of selected for given hierarchy filter members. - * - * @param hierarchyUniqueName the unique name of the hierarchy whose active filter members are returned. - */ - getFilterMemberNames(hierarchyUniqueName: string): any[]; + /** + * Returns an array of strings with the unique names of selected for given hierarchy filter members. + * + * @param hierarchyUniqueName the unique name of the hierarchy whose active filter members are returned. + */ + getFilterMemberNames(hierarchyUniqueName: string): any[]; - /** - * Adds a member to list of filter members that will be present in result. - * If a member of given hierarchy is added to this filter list then only those members which are present in this filter list will be present for that hierarchy in the result. - * - * @param hierarchyUniqueName the unique name of the hierarchy this member belongs to. - * @param memberUniqueName the unique name of the member to be added. - */ - addFilterMember(hierarchyUniqueName: string, memberUniqueName: string): void; + /** + * Adds a member to list of filter members that will be present in result. + * If a member of given hierarchy is added to this filter list then only those members which are present in this filter list will be present for that hierarchy in the result. + * + * @param hierarchyUniqueName the unique name of the hierarchy this member belongs to. + * @param memberUniqueName the unique name of the member to be added. + */ + addFilterMember(hierarchyUniqueName: string, memberUniqueName: string): void; - /** - * Removes a member from the list of filter members that will be present in result. - * - * @param hierarchyUniqueName the unique name of the hierarchy this member belongs to. - * @param memberUniqueName the unique name of the member to be removed. - */ - removeFilterMember(hierarchyUniqueName: string, memberUniqueName: string): void; + /** + * Removes a member from the list of filter members that will be present in result. + * + * @param hierarchyUniqueName the unique name of the hierarchy this member belongs to. + * @param memberUniqueName the unique name of the member to be removed. + */ + removeFilterMember(hierarchyUniqueName: string, memberUniqueName: string): void; - /** - * Removes all members from the list of filter members and the filter for the specified hierarchy is cleared. - * - * @param hierarchyUniqueName the unique name of the hierarchy which filter members to be cleared. - */ - removeAllFilterMembers(hierarchyUniqueName: string): void; + /** + * Removes all members from the list of filter members and the filter for the specified hierarchy is cleared. + * + * @param hierarchyUniqueName the unique name of the hierarchy which filter members to be cleared. + */ + removeAllFilterMembers(hierarchyUniqueName: string): void; - /** - * Returns Promise which on completion provides an array of $.ig.OlapResultAxisMember objects of selected for given level filter member. - * - * @param levelUniqueName the unique name of the level whose active filter members are returned. - */ - getMembersOfLevel(levelUniqueName: string): void; + /** + * Returns Promise which on completion provides an array of $.ig.OlapResultAxisMember objects of selected for given level filter member. + * + * @param levelUniqueName the unique name of the level whose active filter members are returned. + */ + getMembersOfLevel(levelUniqueName: string): void; - /** - * Returns Promise which on completion provides an array of $.ig.OlapResultAxisMember objects of selected for given hierarchy filter member. - * - * @param hierarchyUniqueName the unique name of the hierarchy whose active filter members are returned. - */ - getMembersOfHierarchy(hierarchyUniqueName: string): void; + /** + * Returns Promise which on completion provides an array of $.ig.OlapResultAxisMember objects of selected for given hierarchy filter member. + * + * @param hierarchyUniqueName the unique name of the hierarchy whose active filter members are returned. + */ + getMembersOfHierarchy(hierarchyUniqueName: string): void; - /** - * Returns Promise which on completion provides an array of $.ig.OlapResultAxisMember objects that are children of the current member. - * - * @param memberUniqueName the unique name of the member whose active filter members are returned. - */ - getMembersOfMember(memberUniqueName: string): void; - } + /** + * Returns Promise which on completion provides an array of $.ig.OlapResultAxisMember objects that are children of the current member. + * + * @param memberUniqueName the unique name of the member whose active filter members are returned. + */ + getMembersOfMember(memberUniqueName: string): void; +} } interface IgniteUIStatic { OlapFlatDataSource: typeof Infragistics.OlapFlatDataSource; } declare namespace Infragistics { - class OlapMetadataTreeItem { - /** - * Returns the OLAP metadata item that this tree item represents which is an object of type $.ig.Cube, $.ig.Dimension, $.ig.Hierarchy, $.ig.Measure, $.ig.Level. - */ - item(): Object; +class OlapMetadataTreeItem { + /** + * Returns the OLAP metadata item that this tree item represents which is an object of type $.ig.Cube, $.ig.Dimension, $.ig.Hierarchy, $.ig.Measure, $.ig.Level. + */ + item(): Object; - /** - * Returns the metadata tree item type which is a value from the $.ig.MetadataTreeItemType enumeration. - * - * $.ig.MetadataTreeItemType.prototype.cube = 0; - * Item type for the cube tree items. Contain an item() of type $.ig.Cube. - * - * $.ig.MetadataTreeItemType.prototype.dimension = 1; - * Item type for the dimension tree items. Contain an item() of type $.ig.Dimension. - * - * $.ig.MetadataTreeItemType.prototype.group = 2; - * Item type for the group tree items. Does not have item(). - * - * $.ig.MetadataTreeItemType.prototype.userDefinedHierarchy = 3; - * Item type for the userDefinedHierarchy tree items. Contain an item() of type $.ig.Hierarchy. - * - * $.ig.MetadataTreeItemType.prototype.systemEnabledHierarchy = 4; - * Item type for the systemEnabledHierarchy tree items. Contain an item() of type $.ig.Hierarchy. - * - * $.ig.MetadataTreeItemType.prototype.parentChildHierarchy = 5; - * Item type for the parentChildHierarchy tree items. Contain an item() of type $.ig.Hierarchy. - * - * $.ig.MetadataTreeItemType.prototype.measure = 6; - * Item type for the measure tree items. Contain an item() of type $.ig.Measure. - * - * $.ig.MetadataTreeItemType.prototype.level1 = 7; - * Item type for the level1 tree items. Contain an item() of type $.ig.Level. - * - * $.ig.MetadataTreeItemType.prototype.level2 = 8; - * Item type for the level2 tree items. Contain an item() of type $.ig.Level. - * - * $.ig.MetadataTreeItemType.prototype.level3 = 9; - * Item type for the level3 tree items. Contain an item() of type $.ig.Level. - * - * $.ig.MetadataTreeItemType.prototype.level4 = 10; - * Item type for the level4 tree items. Contain an item() of type $.ig.Level. - * - * $.ig.MetadataTreeItemType.prototype.level5 = 11; - * Item type for the level5 tree items. Contain an item() of type $.ig.Level. - */ - type(): number; + /** + * Returns the metadata tree item type which is a value from the $.ig.MetadataTreeItemType enumeration. + * + * $.ig.MetadataTreeItemType.prototype.cube = 0; + * Item type for the cube tree items. Contain an item() of type $.ig.Cube. + * + * $.ig.MetadataTreeItemType.prototype.dimension = 1; + * Item type for the dimension tree items. Contain an item() of type $.ig.Dimension. + * + * $.ig.MetadataTreeItemType.prototype.group = 2; + * Item type for the group tree items. Does not have item(). + * + * $.ig.MetadataTreeItemType.prototype.userDefinedHierarchy = 3; + * Item type for the userDefinedHierarchy tree items. Contain an item() of type $.ig.Hierarchy. + * + * $.ig.MetadataTreeItemType.prototype.systemEnabledHierarchy = 4; + * Item type for the systemEnabledHierarchy tree items. Contain an item() of type $.ig.Hierarchy. + * + * $.ig.MetadataTreeItemType.prototype.parentChildHierarchy = 5; + * Item type for the parentChildHierarchy tree items. Contain an item() of type $.ig.Hierarchy. + * + * $.ig.MetadataTreeItemType.prototype.measure = 6; + * Item type for the measure tree items. Contain an item() of type $.ig.Measure. + * + * $.ig.MetadataTreeItemType.prototype.level1 = 7; + * Item type for the level1 tree items. Contain an item() of type $.ig.Level. + * + * $.ig.MetadataTreeItemType.prototype.level2 = 8; + * Item type for the level2 tree items. Contain an item() of type $.ig.Level. + * + * $.ig.MetadataTreeItemType.prototype.level3 = 9; + * Item type for the level3 tree items. Contain an item() of type $.ig.Level. + * + * $.ig.MetadataTreeItemType.prototype.level4 = 10; + * Item type for the level4 tree items. Contain an item() of type $.ig.Level. + * + * $.ig.MetadataTreeItemType.prototype.level5 = 11; + * Item type for the level5 tree items. Contain an item() of type $.ig.Level. + */ + type(): number; - /** - * Returns the caption text that should be displayed for this tree item. - */ - caption(): string; + /** + * Returns the caption text that should be displayed for this tree item. + */ + caption(): string; - /** - * Returns the children ot this tree item. - */ - children(): Object; - } + /** + * Returns the children ot this tree item. + */ + children(): Object; +} } interface OlapResultViewOptions { @@ -7525,35 +7902,35 @@ interface OlapResultViewOptions { } declare namespace Infragistics { - class OlapResultView { - constructor(options: OlapResultViewOptions); +class OlapResultView { + constructor(options: OlapResultViewOptions); - /** - * Creates a new $.ig.OlapResultView object with result object having the same structure as the original one and new visibleResult where the tuples which appear as children under specified tuple and member index are no longer present. - * - * @param axisName - * @param tupleIndex - * @param memberIndex - */ - collapseTupleMember(axisName: Object, tupleIndex: Object, memberIndex: Object): Object; + /** + * Creates a new $.ig.OlapResultView object with result object having the same structure as the original one and new visibleResult where the tuples which appear as children under specified tuple and member index are no longer present. + * + * @param axisName + * @param tupleIndex + * @param memberIndex + */ + collapseTupleMember(axisName: Object, tupleIndex: Object, memberIndex: Object): Object; - /** - * Creates a $.ig.OlapResultView view object with result object having the same structure as the original one and new visibleResult where the tuples which appear as children under specified tuple and member index are accessible as part of the visibleResult. - * - * @param axisName - * @param tupleIndex - * @param memberIndex - */ - expandTupleMember(axisName: Object, tupleIndex: Object, memberIndex: Object): Object; + /** + * Creates a $.ig.OlapResultView view object with result object having the same structure as the original one and new visibleResult where the tuples which appear as children under specified tuple and member index are accessible as part of the visibleResult. + * + * @param axisName + * @param tupleIndex + * @param memberIndex + */ + expandTupleMember(axisName: Object, tupleIndex: Object, memberIndex: Object): Object; - /** - * Creates a new $.ig.OlapResultView object as the axis specified by axisName of the original result object is extended with the tuples of the same axis found into supplied partialResult object. - * - * @param partialResult - * @param axisName - */ - extend(partialResult: Object, axisName: Object): Object; - } + /** + * Creates a new $.ig.OlapResultView object as the axis specified by axisName of the original result object is extended with the tuples of the same axis found into supplied partialResult object. + * + * @param partialResult + * @param axisName + */ + extend(partialResult: Object, axisName: Object): Object; +} } interface IgniteUIStatic { OlapResultView: typeof Infragistics.OlapResultView; @@ -7620,645 +7997,645 @@ interface OlapTableViewOptions { } declare namespace Infragistics { - class OlapTableView { - constructor(options: OlapTableViewOptions); +class OlapTableView { + constructor(options: OlapTableViewOptions); - /** - * Initializes the table view object as its rowHeaders, columnHeaders and resultCells are created for the result object the table view is related to. - * Applies the items from the columnSortDirections and levelDortDirections to produce the sorted result. - */ - initialize(): void; + /** + * Initializes the table view object as its rowHeaders, columnHeaders and resultCells are created for the result object the table view is related to. + * Applies the items from the columnSortDirections and levelDortDirections to produce the sorted result. + */ + initialize(): void; - /** - * Returns the configuration object this table view is created with. - */ - viewSettings(): Object; + /** + * Returns the configuration object this table view is created with. + */ + viewSettings(): Object; - /** - * Gets or sets the column sort direction items, which will be applied when the $.ig.OlapTableView is initialized. - * - tupleIndex (number): specifies the index of the tuple, which corresponds to a column in the column axis. - * - sortDirection (string: ascending|descending): indicates the sort direction for the column. The allowed values are 'ascending' (default) and 'descending'. - * - comparer (function): an optional function, which will be used to compare the cells from the column. The function should return a number: - * 1. If Cell1 < Cell2, return a value lower than 0. - * 2. If Cell1 == Cell2, return 0. - * 3. If Cell1 > Cell2, return a value greater than 0. - * - * @param columnSortDirections an array of objects, which have the following properties: - */ - columnSortDirections(columnSortDirections?: any[]): any[]; + /** + * Gets or sets the column sort direction items, which will be applied when the $.ig.OlapTableView is initialized. + * - tupleIndex (number): specifies the index of the tuple, which corresponds to a column in the column axis. + * - sortDirection (string: ascending|descending): indicates the sort direction for the column. The allowed values are 'ascending' (default) and 'descending'. + * - comparer (function): an optional function, which will be used to compare the cells from the column. The function should return a number: + * 1. If Cell1 < Cell2, return a value lower than 0. + * 2. If Cell1 == Cell2, return 0. + * 3. If Cell1 > Cell2, return a value greater than 0. + * + * @param columnSortDirections an array of objects, which have the following properties: + */ + columnSortDirections(columnSortDirections?: any[]): any[]; - /** - * Returns the column sort direction items, which were applied during the $.ig.OlapTableView initialization. - */ - appliedColumnSortDirections(): any[]; + /** + * Returns the column sort direction items, which were applied during the $.ig.OlapTableView initialization. + */ + appliedColumnSortDirections(): any[]; - /** - * Gets or sets the level sort direction items, which will be applied when the $.ig.OlapTableView is - * - levelUniqueName (string): the name of the level to be sorted. - * - sortDirection (string: ascending|descending): indicates the sort direction for the level. The allowed values are 'ascending' (default) and 'descending'. - * - sortBehavior (string: alphabetical|system): indicates the type of sorting to be applied. The allowed values are 'alphabetical' (default) and 'system'. - * - * @param levelSortDirections an array of objects, which have the following properties: - */ - levelSortDirections(levelSortDirections?: any[]): any[]; + /** + * Gets or sets the level sort direction items, which will be applied when the $.ig.OlapTableView is + * - levelUniqueName (string): the name of the level to be sorted. + * - sortDirection (string: ascending|descending): indicates the sort direction for the level. The allowed values are 'ascending' (default) and 'descending'. + * - sortBehavior (string:alphabetical|system): indicates the type of sorting to be applied. The allowed values are 'alphabetical' (default) and 'system'. + * + * @param levelSortDirections an array of objects, which have the following properties: + */ + levelSortDirections(levelSortDirections?: any[]): any[]; - /** - * Returns the level sort direction items, which were applied during the $.ig.OlapTableView initialization. - */ - appliedLevelSortDirections(): any[]; + /** + * Returns the level sort direction items, which were applied during the $.ig.OlapTableView initialization. + */ + appliedLevelSortDirections(): any[]; - /** - * Returns a javascript object, which maps the applied level sort directions to the axis name, hierarchy index in the axis and the level depth. - * It is used internally to determine, which $.ig.OlapTableViewHeaderCell needs to display a sorting indicator in the user interface. - */ - appliedSortDirectionsMap(): Object; + /** + * Returns a javascript object, which maps the applied level sort directions to the axis name, hierarchy index in the axis and the level depth. + * It is used internally to determine, which $.ig.OlapTableViewHeaderCell needs to display a sorting indicator in the user interface. + */ + appliedSortDirectionsMap(): Object; - /** - * Returns the table row headers. - */ - rowHeaders(): any[]; + /** + * Returns the table row headers. + */ + rowHeaders(): any[]; - /** - * Returns the table column headers. - */ - columnHeaders(): any[]; + /** + * Returns the table column headers. + */ + columnHeaders(): any[]; - /** - * Returns the table result cells ordered as if the grid is iterated row by row. - */ - resultCells(): any[]; + /** + * Returns the table result cells ordered as if the grid is iterated row by row. + */ + resultCells(): any[]; - /** - * Returns the sorted $.ig.OlapResult object. - */ - result(): Object; - } + /** + * Returns the sorted $.ig.OlapResult object. + */ + result(): Object; +} } interface IgniteUIStatic { OlapTableView: typeof Infragistics.OlapTableView; } declare namespace Infragistics { - class OlapTableViewHeaderCell { - /** - * Returns the caption for the header cell. - */ - caption(): string; +class OlapTableViewHeaderCell { + /** + * Returns the caption for the header cell. + */ + caption(): string; - /** - * Returns the expaned state for the header cell. - */ - isExpanded(): boolean; + /** + * Returns the expaned state for the header cell. + */ + isExpanded(): boolean; - /** - * Indicates whether the header cell can be expanded. - */ - isExpanable(): boolean; + /** + * Indicates whether the header cell can be expanded. + */ + isExpanable(): boolean; - /** - * Returns the row index for the header cell. - */ - rowIndex(): number; + /** + * Returns the row index for the header cell. + */ + rowIndex(): number; - /** - * Returns the row span for the header cell. - */ - rowSpan(): number; + /** + * Returns the row span for the header cell. + */ + rowSpan(): number; - /** - * Returns the column index for the header cell. - */ - columnIndex(): number; + /** + * Returns the column index for the header cell. + */ + columnIndex(): number; - /** - * Returns the column span for the header cell. - */ - columnSpan(): number; + /** + * Returns the column span for the header cell. + */ + columnSpan(): number; - /** - * Returns the name of the axis this header cell is related to. - */ - axisName(): string; + /** + * Returns the name of the axis this header cell is related to. + */ + axisName(): string; - /** - * Returns the index of tuple in the axis this header cell is related to. - */ - tupleIndex(): number; + /** + * Returns the index of tuple in the axis this header cell is related to. + */ + tupleIndex(): number; - /** - * Returns the index of the axis member in the tuple this header cell is related to. - */ - memberIndex(): number; - } + /** + * Returns the index of the axis member in the tuple this header cell is related to. + */ + memberIndex(): number; +} } declare namespace Infragistics { - class OlapTableViewResultCell { - /** - * Returns the value provided by $.ig.Cell object. - */ - value(): Object; +class OlapTableViewResultCell { + /** + * Returns the value provided by $.ig.Cell object. + */ + value(): Object; - /** - * Returns the formmated value to be displayed by the data cell. - */ - formattedValue(): string; + /** + * Returns the formmated value to be displayed by the data cell. + */ + formattedValue(): string; - /** - * Returns the ordinal of this cell used to determine its position into the data cells' grid. - */ - cellOrdinal(): number; + /** + * Returns the ordinal of this cell used to determine its position into the data cells' grid. + */ + cellOrdinal(): number; - /** - * Returns the index of $.ig.Cell object in $.ig.OlapResult object. - */ - resultCellIndex(): number; - } + /** + * Returns the index of $.ig.Cell object in $.ig.OlapResult object. + */ + resultCellIndex(): number; +} } declare namespace Infragistics { - class Catalog { - /** - * Returns the name of the catalog. - * - * @param value - */ - name(value: Object): string; +class Catalog { + /** + * Returns the name of the catalog. + * + * @param value + */ + name(value: Object): string; - /** - * Returns the unique name of the catalog. - * - * @param value - */ - uniqueName(value: Object): string; + /** + * Returns the unique name of the catalog. + * + * @param value + */ + uniqueName(value: Object): string; - /** - * Returns the caption of the catalog used when displaying the name of the catalog to the user. - * - * @param value - */ - caption(value: Object): string; + /** + * Returns the caption of the catalog used when displaying the name of the catalog to the user. + * + * @param value + */ + caption(value: Object): string; - /** - * Returns the description of the catalog which is a human-readable description of the catalog - * - * @param value - */ - description(value: Object): string; - } + /** + * Returns the description of the catalog which is a human-readable description of the catalog + * + * @param value + */ + description(value: Object): string; +} } declare namespace Infragistics { - class Cube { - /** - * Returns the name of the cube. - * - * @param value - */ - name(value: Object): string; +class Cube { + /** + * Returns the name of the cube. + * + * @param value + */ + name(value: Object): string; - /** - * Returns the unique name of the cube. - * - * @param value - */ - uniqueName(value: Object): string; + /** + * Returns the unique name of the cube. + * + * @param value + */ + uniqueName(value: Object): string; - /** - * Returns the caption of the cube used when displaying the name of the cube to the user. - * - * @param value - */ - caption(value: Object): string; + /** + * Returns the caption of the cube used when displaying the name of the cube to the user. + * + * @param value + */ + caption(value: Object): string; - /** - * Returns a user-friendly description of the cube. - * - * @param value - */ - description(value: Object): string; + /** + * Returns a user-friendly description of the cube. + * + * @param value + */ + description(value: Object): string; - /** - * Returns the type of the cube which is a value from the $.ig.CubeType enumeration. - * - * $.ig.CubeType.prototype.cube = 0; - * $.ig.CubeType.prototype.dimension = 1; - * $.ig.CubeType.prototype.unknown = 2; - * - * @param value - */ - cubeType(value: Object): number; + /** + * Returns the type of the cube which is a value from the $.ig.CubeType enumeration. + * + * $.ig.CubeType.prototype.cube = 0; + * $.ig.CubeType.prototype.dimension = 1; + * $.ig.CubeType.prototype.unknown = 2; + * + * @param value + */ + cubeType(value: Object): number; - /** - * Returns the date and time on which the cube was last processed. - * - * @param value - */ - lastProcessed(value: Object): Object; + /** + * Returns the date and time on which the cube was last processed. + * + * @param value + */ + lastProcessed(value: Object): Object; - /** - * Returns the date and time on which the cube was last updated. - * - * @param value - */ - lastUpdated(value: Object): Object; - } + /** + * Returns the date and time on which the cube was last updated. + * + * @param value + */ + lastUpdated(value: Object): Object; +} } declare namespace Infragistics { - class Dimension { - /** - * Returns the name of the dimension. - * - * @param value - */ - name(value: Object): string; +class Dimension { + /** + * Returns the name of the dimension. + * + * @param value + */ + name(value: Object): string; - /** - * Returns the unique name of the dimension. - * - * @param value - */ - uniqueName(value: Object): string; + /** + * Returns the unique name of the dimension. + * + * @param value + */ + uniqueName(value: Object): string; - /** - * Returns the caption of the dimension used when displaying the name of the dimension to the user. - * - * @param value - */ - caption(value: Object): string; + /** + * Returns the caption of the dimension used when displaying the name of the dimension to the user. + * + * @param value + */ + caption(value: Object): string; - /** - * Returns a user-friendly description of the dimension. - * - * @param value - */ - description(value: Object): string; + /** + * Returns a user-friendly description of the dimension. + * + * @param value + */ + description(value: Object): string; - /** - * Returns the type of the dimension which is a value from the $.ig.DimensionType enumeration. - * - * $.ig.DimensionType.prototype.unknown = 0; - * $.ig.DimensionType.prototype.time = 1; - * $.ig.DimensionType.prototype.measure = 2; - * $.ig.DimensionType.prototype.other = 3; - * $.ig.DimensionType.prototype.quantitative = 5; - * $.ig.DimensionType.prototype.accounts = 6; - * $.ig.DimensionType.prototype.customers = 7; - * $.ig.DimensionType.prototype.products = 8; - * $.ig.DimensionType.prototype.scenario = 9; - * $.ig.DimensionType.prototype.utility = 10; - * $.ig.DimensionType.prototype.currency = 11; - * $.ig.DimensionType.prototype.rates = 12; - * $.ig.DimensionType.prototype.channel = 13; - * $.ig.DimensionType.prototype.promotion = 14; - * $.ig.DimensionType.prototype.organization = 15; - * $.ig.DimensionType.prototype.billOfMaterials = 16; - * $.ig.DimensionType.prototype.geography = 17; - * - * @param value - */ - dimensionType(value: Object): number; - } + /** + * Returns the type of the dimension which is a value from the $.ig.DimensionType enumeration. + * + * $.ig.DimensionType.prototype.unknown = 0; + * $.ig.DimensionType.prototype.time = 1; + * $.ig.DimensionType.prototype.measure = 2; + * $.ig.DimensionType.prototype.other = 3; + * $.ig.DimensionType.prototype.quantitative = 5; + * $.ig.DimensionType.prototype.accounts = 6; + * $.ig.DimensionType.prototype.customers = 7; + * $.ig.DimensionType.prototype.products = 8; + * $.ig.DimensionType.prototype.scenario = 9; + * $.ig.DimensionType.prototype.utility = 10; + * $.ig.DimensionType.prototype.currency = 11; + * $.ig.DimensionType.prototype.rates = 12; + * $.ig.DimensionType.prototype.channel = 13; + * $.ig.DimensionType.prototype.promotion = 14; + * $.ig.DimensionType.prototype.organization = 15; + * $.ig.DimensionType.prototype.billOfMaterials = 16; + * $.ig.DimensionType.prototype.geography = 17; + * + * @param value + */ + dimensionType(value: Object): number; +} } declare namespace Infragistics { - class Hierarchy { - /** - * Returns the name of the hierarchy. - * - * @param value - */ - name(value: Object): string; +class Hierarchy { + /** + * Returns the name of the hierarchy. + * + * @param value + */ + name(value: Object): string; - /** - * Returns the unique name of the hierarchy. - * - * @param value - */ - uniqueName(value: Object): string; + /** + * Returns the unique name of the hierarchy. + * + * @param value + */ + uniqueName(value: Object): string; - /** - * Returns the caption of the hierarchy used when displaying the name of the hierarchy to the user. - * - * @param value - */ - caption(value: Object): string; + /** + * Returns the caption of the hierarchy used when displaying the name of the hierarchy to the user. + * + * @param value + */ + caption(value: Object): string; - /** - * Returns a user-friendly description of the hierarchy. - * - * @param value - */ - description(value: Object): string; + /** + * Returns a user-friendly description of the hierarchy. + * + * @param value + */ + description(value: Object): string; - /** - * Returns the unique name of the default member for the hierarchy. - * - * @param value - */ - defaultMember(value: Object): string; + /** + * Returns the unique name of the default member for the hierarchy. + * + * @param value + */ + defaultMember(value: Object): string; - /** - * Returns the unique name of the 'All' member for the hierarchy. - * - * @param value - */ - allMember(value: Object): string; + /** + * Returns the unique name of the 'All' member for the hierarchy. + * + * @param value + */ + allMember(value: Object): string; - /** - * Returns the unique name of the dimension that contains the hierarchy. - * - * @param value - */ - dimensionUniqueName(value: Object): string; + /** + * Returns the unique name of the dimension that contains the hierarchy. + * + * @param value + */ + dimensionUniqueName(value: Object): string; - /** - * Returns the source of the hierarchy which is a value from the $.ig.HierarchyOrigin enumeration. - * - * $.ig.HierarchyOrigin.prototype.userDefined = 1; - * Identifies user defined hierarchies. - * - * $.ig.HierarchyOrigin.prototype.systemEnabled = 2; - * Identifies attribute hierarchies. - * - * $.ig.HierarchyOrigin.prototype.systemInternal = 4; - * Identifies attributes with no attribute . - * - * @param value - */ - hierarchyOrigin(value: Object): number; + /** + * Returns the source of the hierarchy which is a value from the $.ig.HierarchyOrigin enumeration. + * + * $.ig.HierarchyOrigin.prototype.userDefined = 1; + * Identifies user defined hierarchies. + * + * $.ig.HierarchyOrigin.prototype.systemEnabled = 2; + * Identifies attribute hierarchies. + * + * $.ig.HierarchyOrigin.prototype.systemInternal = 4; + * Identifies attributes with no attribute . + * + * @param value + */ + hierarchyOrigin(value: Object): number; - /** - * Returns the hierarchy display folder path to be used when displaying the hierarchy in the user interface. - * Folder names will be separated by a semicolon (;). Nested folders are indicated by a backslash (\). - * - * @param value - */ - hierarchyDisplayFolder(value: Object): string; - } + /** + * Returns the hierarchy display folder path to be used when displaying the hierarchy in the user interface. + * Folder names will be separated by a semicolon (;). Nested folders are indicated by a backslash (\). + * + * @param value + */ + hierarchyDisplayFolder(value: Object): string; +} } declare namespace Infragistics { - class Measure { - /** - * Returns the name of the measure. - * - * @param value - */ - name(value: Object): string; +class Measure { + /** + * Returns the name of the measure. + * + * @param value + */ + name(value: Object): string; - /** - * Returns the unique name of the measure. - * - * @param value - */ - uniqueName(value: Object): string; + /** + * Returns the unique name of the measure. + * + * @param value + */ + uniqueName(value: Object): string; - /** - * Returns the caption of the measure used when displaying the name of the measure to the user. - * - * @param value - */ - caption(value: Object): string; + /** + * Returns the caption of the measure used when displaying the name of the measure to the user. + * + * @param value + */ + caption(value: Object): string; - /** - * Returns a user-friendly description of the measure. - * - * @param value - */ - description(value: Object): string; + /** + * Returns a user-friendly description of the measure. + * + * @param value + */ + description(value: Object): string; - /** - * Returns the name of the measure group this measure belongs to. - * - * @param value - */ - measureGroupName(value: Object): string; + /** + * Returns the name of the measure group this measure belongs to. + * + * @param value + */ + measureGroupName(value: Object): string; - /** - * Returns the aggregator type that identifies how a measure was derived. It is a value from the $.ig.AggregatorType enumeration. - * - * $.ig.AggregatorType.prototype.unknown = 0; - * The aggregated function is undefined. - * - * $.ig.AggregatorType.prototype.sum = 1; - * The aggregated function adds all values. - * - * $.ig.AggregatorType.prototype.count = 2; - * The aggregated function will count the number of the values. - * - * $.ig.AggregatorType.prototype.min = 3; - * The aggregated function will returns the smallest value. - * - * $.ig.AggregatorType.prototype.max = 4; - * The aggregated function will returns the largest value. - * - * $.ig.AggregatorType.prototype.average = 5; - * The aggregated function will returns the average of cells value. - * - * $.ig.AggregatorType.prototype.variance = 6; - * The aggregated function will estimates variance based on the sample. - * - * $.ig.AggregatorType.prototype.std = 7; - * The aggregated function will estimates the standart deviation based on sample. - * - * $.ig.AggregatorType.prototype.distinctCount = 8; - * The aggregated function will returns the number of distinct, nonempty tuples in a set. - * - * $.ig.AggregatorType.prototype.none = 9; - * No aggregation performed. - * - * $.ig.AggregatorType.prototype.averageOfChildren = 10; - * The aggregated function will returns the average of the measure's children. - * - * $.ig.AggregatorType.prototype.firstNonEmpty = 13; - * The aggregated function will returns the measure's first nonempty member. - * - * $.ig.AggregatorType.prototype.lastNonEmpty = 14; - * The aggregated function will returns the measure's last nonempty member. - * - * $.ig.AggregatorType.prototype.byAccount = 15; - * Aggregated by the aggregation function associated with the specified account type of an attribute in an account dimension. - * - * $.ig.AggregatorType.prototype.calculated = 127; - * The aggregated function will returns the result derived from a formula. - * - * @param value - */ - aggregatorType(value: Object): number; + /** + * Returns the aggregator type that identifies how a measure was derived. It is a value from the $.ig.AggregatorType enumeration. + * + * $.ig.AggregatorType.prototype.unknown = 0; + * The aggregated function is undefined. + * + * $.ig.AggregatorType.prototype.sum = 1; + * The aggregated function adds all values. + * + * $.ig.AggregatorType.prototype.count = 2; + * The aggregated function will count the number of the values. + * + * $.ig.AggregatorType.prototype.min = 3; + * The aggregated function will returns the smallest value. + * + * $.ig.AggregatorType.prototype.max = 4; + * The aggregated function will returns the largest value. + * + * $.ig.AggregatorType.prototype.average = 5; + * The aggregated function will returns the average of cells value. + * + * $.ig.AggregatorType.prototype.variance = 6; + * The aggregated function will estimates variance based on the sample. + * + * $.ig.AggregatorType.prototype.std = 7; + * The aggregated function will estimates the standart deviation based on sample. + * + * $.ig.AggregatorType.prototype.distinctCount = 8; + * The aggregated function will returns the number of distinct, nonempty tuples in a set. + * + * $.ig.AggregatorType.prototype.none = 9; + * No aggregation performed. + * + * $.ig.AggregatorType.prototype.averageOfChildren = 10; + * The aggregated function will returns the average of the measure's children. + * + * $.ig.AggregatorType.prototype.firstNonEmpty = 13; + * The aggregated function will returns the measure's first nonempty member. + * + * $.ig.AggregatorType.prototype.lastNonEmpty = 14; + * The aggregated function will returns the measure's last nonempty member. + * + * $.ig.AggregatorType.prototype.byAccount = 15; + * Aggregated by the aggregation function associated with the specified account type of an attribute in an account dimension. + * + * $.ig.AggregatorType.prototype.calculated = 127; + * The aggregated function will returns the result derived from a formula. + * + * @param value + */ + aggregatorType(value: Object): number; - /** - * Returns the default format string for the measure. - * - * @param value - */ - defaultFormatString(value: Object): string; + /** + * Returns the default format string for the measure. + * + * @param value + */ + defaultFormatString(value: Object): string; - /** - * Returns the measure display folder path to be used when displaying the measure in the user interface. - * Folder names will be separated by a semicolon (;). Nested folders are indicated by a backslash (\). - * - * @param value - */ - measureDisplayFolder(value: Object): string; - } + /** + * Returns the measure display folder path to be used when displaying the measure in the user interface. + * Folder names will be separated by a semicolon (;). Nested folders are indicated by a backslash (\). + * + * @param value + */ + measureDisplayFolder(value: Object): string; +} } declare namespace Infragistics { - class Level { - /** - * Returns the name of the level. - * - * @param value - */ - name(value: Object): string; +class Level { + /** + * Returns the name of the level. + * + * @param value + */ + name(value: Object): string; - /** - * Returns the unique name of the level. - * - * @param value - */ - uniqueName(value: Object): string; + /** + * Returns the unique name of the level. + * + * @param value + */ + uniqueName(value: Object): string; - /** - * Returns the caption of the level used when displaying the name of the level to the user. - * - * @param value - */ - caption(value: Object): string; + /** + * Returns the caption of the level used when displaying the name of the level to the user. + * + * @param value + */ + caption(value: Object): string; - /** - * Returns a user-friendly description of the level. - * - * @param value - */ - description(value: Object): string; + /** + * Returns a user-friendly description of the level. + * + * @param value + */ + description(value: Object): string; - /** - * Returns the distance of the level from the root of the level. Root level is zero (0) - * - * @param value - */ - depth(value: Object): number; + /** + * Returns the distance of the level from the root of the level. Root level is zero (0) + * + * @param value + */ + depth(value: Object): number; - /** - * Returns the unique name of the hierarchy that contains the level. - * - * @param value - */ - hierarchyUniqueName(value: Object): string; + /** + * Returns the unique name of the hierarchy that contains the level. + * + * @param value + */ + hierarchyUniqueName(value: Object): string; - /** - * Returns the unique name of the dimension that contains the level. - * - * @param value - */ - dimensionUniqueName(value: Object): string; + /** + * Returns the unique name of the dimension that contains the level. + * + * @param value + */ + dimensionUniqueName(value: Object): string; - /** - * Returns the count of all members in the level. - * - * @param value - */ - membersCount(value: Object): number; + /** + * Returns the count of all members in the level. + * + * @param value + */ + membersCount(value: Object): number; - /** - * Returns a value that defines how the level was sourced. - * - * @param value - */ - levelOrigin(value: Object): number; + /** + * Returns a value that defines how the level was sourced. + * + * @param value + */ + levelOrigin(value: Object): number; - /** - * Returns the ID of the attribute that the level is sorted on. - * - * @param value - */ - levelOrderingProperty(value: Object): number; - } + /** + * Returns the ID of the attribute that the level is sorted on. + * + * @param value + */ + levelOrderingProperty(value: Object): number; +} } declare namespace Infragistics { - class MeasureGroup { - /** - * Returns the name of the measure group. - * - * @param value - */ - name(value: Object): string; +class MeasureGroup { + /** + * Returns the name of the measure group. + * + * @param value + */ + name(value: Object): string; - /** - * Returns the caption of the measure group used when displaying the name of the measure group to the user. - * - * @param value - */ - caption(value: Object): string; + /** + * Returns the caption of the measure group used when displaying the name of the measure group to the user. + * + * @param value + */ + caption(value: Object): string; - /** - * Returns a user-friendly description of the measure group. - * - * @param value - */ - description(value: Object): string; + /** + * Returns a user-friendly description of the measure group. + * + * @param value + */ + description(value: Object): string; - /** - * Returns the name of the catalog to which this measure group belongs. - * - * @param value - */ - catalogName(value: Object): string; + /** + * Returns the name of the catalog to which this measure group belongs. + * + * @param value + */ + catalogName(value: Object): string; - /** - * Returns the name of the cube to which this measure group belongs - * - * @param value - */ - cubeName(value: Object): string; - } + /** + * Returns the name of the cube to which this measure group belongs + * + * @param value + */ + cubeName(value: Object): string; +} } declare namespace Infragistics { - class MeasureList { - /** - * Returns the caption of the measure list used when displaying the name of the measure list to the user. - * - * @param value - */ - caption(value: Object): string; +class MeasureList { + /** + * Returns the caption of the measure list used when displaying the name of the measure list to the user. + * + * @param value + */ + caption(value: Object): string; - /** - * Returns an array of $.ig.Measure objects this measure list is grouping. - * - * @param value - */ - measures(value: Object): any[]; - } + /** + * Returns an array of $.ig.Measure objects this measure list is grouping. + * + * @param value + */ + measures(value: Object): any[]; +} } declare namespace Infragistics { - class OlapResult { - /** - * Returns a value indicating whether the result object contains any data. - * - * @param value - */ - isEmpty(value: Object): boolean; +class OlapResult { + /** + * Returns a value indicating whether the result object contains any data. + * + * @param value + */ + isEmpty(value: Object): boolean; - /** - * Returns an array of $.ig.OlapResultAxis objects this result is built on. - * - * @param value - */ - axes(value: Object): any[]; + /** + * Returns an array of $.ig.OlapResultAxis objects this result is built on. + * + * @param value + */ + axes(value: Object): any[]; - /** - * Returns an array of $.ig.OlapResultCell objects which hold the result data. - * - * @param value - */ - cells(value: Object): any[]; - } + /** + * Returns an array of $.ig.OlapResultCell objects which hold the result data. + * + * @param value + */ + cells(value: Object): any[]; +} } interface OlapResultAxisOptions { @@ -8279,19 +8656,19 @@ interface OlapResultAxisOptions { } declare namespace Infragistics { - class OlapResultAxis { - constructor(options: OlapResultAxisOptions); +class OlapResultAxis { + constructor(options: OlapResultAxisOptions); - /** - * Returns an array of $.ig.OlapResultTuple objects which form the axis. - */ - tuples(): any[]; + /** + * Returns an array of $.ig.OlapResultTuple objects which form the axis. + */ + tuples(): any[]; - /** - * Returns the count of the $.ig.OlapResultAxisMember objects of each tuple. - */ - tupleSize(): number; - } + /** + * Returns the count of the $.ig.OlapResultAxisMember objects of each tuple. + */ + tupleSize(): number; +} } interface IgniteUIStatic { OlapResultAxis: typeof Infragistics.OlapResultAxis; @@ -8310,109 +8687,109 @@ interface OlapResultTupleOptions { } declare namespace Infragistics { - class OlapResultTuple { - constructor(options: OlapResultTupleOptions); +class OlapResultTuple { + constructor(options: OlapResultTupleOptions); - /** - * Returns an array of $.ig.OlapResultTuple objects which form the axis. - */ - members(): any[]; - } + /** + * Returns an array of $.ig.OlapResultTuple objects which form the axis. + */ + members(): any[]; +} } interface IgniteUIStatic { OlapResultTuple: typeof Infragistics.OlapResultTuple; } declare namespace Infragistics { - class OlapResultAxisMember { - /** - * Returns the unique name of the axis member. - * - * @param value - */ - uniqueName(value: Object): string; +class OlapResultAxisMember { + /** + * Returns the unique name of the axis member. + * + * @param value + */ + uniqueName(value: Object): string; - /** - * Returns the caption of the axis member used when displaying the name of the axis member to the user. - * - * @param value - */ - caption(value: Object): string; + /** + * Returns the caption of the axis member used when displaying the name of the axis member to the user. + * + * @param value + */ + caption(value: Object): string; - /** - * Returns the unique name of the level this member belongs to. - * - * @param value - */ - levelUniqueName(value: Object): string; + /** + * Returns the unique name of the level this member belongs to. + * + * @param value + */ + levelUniqueName(value: Object): string; - /** - * Returns the unique name of the hierarchy that contains the level. - * - * @param value - */ - hierarchyUniqueName(value: Object): string; + /** + * Returns the unique name of the hierarchy that contains the level. + * + * @param value + */ + hierarchyUniqueName(value: Object): string; - /** - * Returns the distance of member parent level from the root of the level. Root level is zero (0) - * - * @param value - */ - levelNumber(value: Object): number; + /** + * Returns the distance of member parent level from the root of the level. Root level is zero (0) + * + * @param value + */ + levelNumber(value: Object): number; - /** - * A bitmap of the information projected by childCount, drilledDown and parentSameAsPrev properties. - * - * @param value - */ - displayInfo(value: Object): number; + /** + * A bitmap of the information projected by childCount, drilledDown and parentSameAsPrev properties. + * + * @param value + */ + displayInfo(value: Object): number; - /** - * Returns the count of children members this member has. - * - * @param value - */ - childCount(value: Object): number; + /** + * Returns the count of children members this member has. + * + * @param value + */ + childCount(value: Object): number; - /** - * Returns a value that indicates whether at least one child of this member appears on the axis, immediately following all occurrences of that member. This can be used by applications to display a "+" or a "-" next to the member. - * - * @param value - */ - drilledDown(value: Object): boolean; + /** + * Returns a value that indicates whether at least one child of this member appears on the axis, immediately following all occurrences of that member. This can be used by applications to display a "+" or a "-" next to the member. + * + * @param value + */ + drilledDown(value: Object): boolean; - /** - * Returns a value that indicates whether the parent of this member is the same as the parent of the member preceding all occurrences of the current member. - * - * @param value - */ - parentSameAsPrev(value: Object): boolean; + /** + * Returns a value that indicates whether the parent of this member is the same as the parent of the member preceding all occurrences of the current member. + * + * @param value + */ + parentSameAsPrev(value: Object): boolean; - /** - * Returns a key value map of the members' properties. By default only 'PARENT_UNIQUE_NAME' and 'CHILDREN_CARDINALITY' properties are available. - * - * @param value - */ - properties(value: Object): Object; - } + /** + * Returns a key value map of the members' properties. By default only 'PARENT_UNIQUE_NAME' and 'CHILDREN_CARDINALITY' properties are available. + * + * @param value + */ + properties(value: Object): Object; +} } declare namespace Infragistics { - class OlapResultCell { - /** - * Returns the position of the cell when cells are iterated row by row. - * - * @param value - */ - cellOrdinal(value: Object): number; +class OlapResultCell { + /** + * Returns the position of the cell when cells are iterated row by row. + * + * @param value + */ + cellOrdinal(value: Object): number; - /** - * Returns a key value map of the cell's properties. Currently only 'Value' and 'FmtValue' properties are available. - * - * @param value - */ - properties(value: Object): Object; - } + /** + * Returns a key value map of the cell's properties. Currently only 'Value' and 'FmtValue' properties are available. + * + * @param value + */ + properties(value: Object): Object; +} } interface IgTemplatingRegExp { @@ -8423,26 +8800,26 @@ interface IgTemplatingRegExp { } declare namespace Infragistics { - class igTemplating { - constructor(regExp: IgTemplatingRegExp); +class igTemplating { + constructor(regExp: IgTemplatingRegExp); - /** - * 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. - */ - tmpl(template: string, data: Object, args?: any[]): string; - clearTmplCache(): void; + /** + * 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. + */ + tmpl(template: string, data: Object, args?: any[]): string; + clearTmplCache(): void; - /** - * Encoding < > ' and " - * - * @param value The string to be encoded. - */ - encode(value: string): string; - } + /** + * Encoding < > ' and " + * + * @param value The string to be encoded. + */ + encode(value: string): string; +} } interface IgniteUIStatic { igTemplating: typeof Infragistics.igTemplating; @@ -8577,46 +8954,46 @@ interface IgQRCodeBarcode { * * Valid values: * "undefined" If set, the QR code barcode sets internally the smallest version that will accommodate the data. - * "version1" Version1 defines size of 21x21 modules for the symbol. - * "version2" Version2 defines size of 25x25 modules for the symbol. - * "version3" Version3 defines size of 29x29 modules for the symbol. - * "version4" Version4 defines size of 33x33 modules for the symbol. - * "version5" Version5 defines size of 37x37 modules for the symbol. - * "version6" Version6 defines size of 41x41 modules for the symbol. - * "version7" Version7 defines size of 45x45 modules for the symbol. - * "version8" Version8 defines size of 49x49 modules for the symbol. - * "version9" Version9 defines size of 53x53 modules for the symbol. - * "version10" Version10 defines size of 57x57 modules for the symbol. - * "version11" Version11 defines size of 61x61 modules for the symbol. - * "version12" Version12 defines size of 65x65 modules for the symbol. - * "version13" Version13 defines size of 69x69 modules for the symbol. - * "version14" Version14 defines size of 73x73 modules for the symbol. - * "version15" Version15 defines size of 77x77 modules for the symbol. - * "version16" Version16 defines size of 81x81 modules for the symbol. - * "version17" Version17 defines size of 85x85 modules for the symbol. - * "version18" Version18 defines size of 89x89 modules for the symbol. - * "version19" Version19 defines size of 93x93 modules for the symbol. - * "version20" Version20 defines size of 97x97 modules for the symbol. - * "version21" Version21 defines size of 101x101 modules for the symbol. - * "version22" Version22 defines size of 105x105 modules for the symbol. - * "version23" Version23 defines size of 109x109 modules for the symbol. - * "version24" Version24 defines size of 113x113 modules for the symbol. - * "version25" Version25 defines size of 117x117 modules for the symbol. - * "version26" Version26 defines size of 121x121 modules for the symbol. - * "version27" Version27 defines size of 125x125 modules for the symbol. - * "version28" Version28 defines size of 129x129 modules for the symbol. - * "version29" Version29 defines size of 133x133 modules for the symbol. - * "version30" Version30 defines size of 137x137 modules for the symbol. - * "version31" Version31 defines size of 141x141 modules for the symbol. - * "version32" Version32 defines size of 145x145 modules for the symbol. - * "version33" Version33 defines size of 149x149 modules for the symbol. - * "version34" Version34 defines size of 153x153 modules for the symbol. - * "version35" Version35 defines size of 157x157 modules for the symbol. - * "version36" Version36 defines size of 161x161 modules for the symbol. - * "version37" Version37 defines size of 165x165 modules for the symbol. - * "version38" Version38 defines size of 169x169 modules for the symbol. - * "version39" Version39 defines size of 173x173 modules for the symbol. - * "version40" Version40 defines size of 177x177 modules for the symbol. + * "version1" Version1 defines size of 21x21 namespaces for the symbol. + * "version2" Version2 defines size of 25x25 namespaces for the symbol. + * "version3" Version3 defines size of 29x29 namespaces for the symbol. + * "version4" Version4 defines size of 33x33 namespaces for the symbol. + * "version5" Version5 defines size of 37x37 namespaces for the symbol. + * "version6" Version6 defines size of 41x41 namespaces for the symbol. + * "version7" Version7 defines size of 45x45 namespaces for the symbol. + * "version8" Version8 defines size of 49x49 namespaces for the symbol. + * "version9" Version9 defines size of 53x53 namespaces for the symbol. + * "version10" Version10 defines size of 57x57 namespaces for the symbol. + * "version11" Version11 defines size of 61x61 namespaces for the symbol. + * "version12" Version12 defines size of 65x65 namespaces for the symbol. + * "version13" Version13 defines size of 69x69 namespaces for the symbol. + * "version14" Version14 defines size of 73x73 namespaces for the symbol. + * "version15" Version15 defines size of 77x77 namespaces for the symbol. + * "version16" Version16 defines size of 81x81 namespaces for the symbol. + * "version17" Version17 defines size of 85x85 namespaces for the symbol. + * "version18" Version18 defines size of 89x89 namespaces for the symbol. + * "version19" Version19 defines size of 93x93 namespaces for the symbol. + * "version20" Version20 defines size of 97x97 namespaces for the symbol. + * "version21" Version21 defines size of 101x101 namespaces for the symbol. + * "version22" Version22 defines size of 105x105 namespaces for the symbol. + * "version23" Version23 defines size of 109x109 namespaces for the symbol. + * "version24" Version24 defines size of 113x113 namespaces for the symbol. + * "version25" Version25 defines size of 117x117 namespaces for the symbol. + * "version26" Version26 defines size of 121x121 namespaces for the symbol. + * "version27" Version27 defines size of 125x125 namespaces for the symbol. + * "version28" Version28 defines size of 129x129 namespaces for the symbol. + * "version29" Version29 defines size of 133x133 namespaces for the symbol. + * "version30" Version30 defines size of 137x137 namespaces for the symbol. + * "version31" Version31 defines size of 141x141 namespaces for the symbol. + * "version32" Version32 defines size of 145x145 namespaces for the symbol. + * "version33" Version33 defines size of 149x149 namespaces for the symbol. + * "version34" Version34 defines size of 153x153 namespaces for the symbol. + * "version35" Version35 defines size of 157x157 namespaces for the symbol. + * "version36" Version36 defines size of 161x161 namespaces for the symbol. + * "version37" Version37 defines size of 165x165 namespaces for the symbol. + * "version38" Version38 defines size of 169x169 namespaces for the symbol. + * "version39" Version39 defines size of 173x173 namespaces for the symbol. + * "version40" Version40 defines size of 177x177 namespaces for the symbol. */ sizeVersion?: string; @@ -9263,7 +9640,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. + * 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. */ @@ -9271,7 +9648,7 @@ 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. + * 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. @@ -9281,7 +9658,7 @@ 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. + * 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. @@ -9303,6 +9680,11 @@ interface IgBaseChartMethods { * Destroys widget. */ destroy(): void; + + /** + * Forces any pending deferred work to render on the chart before continuing + */ + flush(): void; } interface JQuery { data(propertyName: "igBaseChart"): IgBaseChartMethods; @@ -9323,6 +9705,7 @@ interface JQuery { igBaseChart(methodName: "chart"): Object; igBaseChart(methodName: "dataBind"): void; igBaseChart(methodName: "destroy"): void; + igBaseChart(methodName: "flush"): void; /** * The width of the chart. @@ -9599,6 +9982,30 @@ interface FormatLabelEvent { } interface FormatLabelEventUIParam { + /** + * Used to obtain reference to the bullet graph widget. + */ + owner?: any; + + /** + * Used to obtain the minimum value of the bullet graph scale. + */ + actualMinimumValue?: any; + + /** + * Used to obtain the maximum value of the bullet graph scale. + */ + actualMaximumValue?: any; + + /** + * Used to obtain the value on the the bullet graph scale associated with the label. + */ + value?: any; + + /** + * Used to obtain the string value of the label. + */ + label?: any; } interface AlignLabelEvent { @@ -9606,6 +10013,50 @@ interface AlignLabelEvent { } interface AlignLabelEventUIParam { + /** + * Used to obtain reference to gauge widget. + */ + owner?: any; + + /** + * Used to obtain the minimum value of the bullet graph scale. + */ + actualMinimumValue?: any; + + /** + * Used to obtain the maximum value of the bullet graph scale. + */ + actualMaximumValue?: any; + + /** + * Used to obtain the value on the the bullet graph scale associated with the label. + */ + value?: any; + + /** + * Used to obtain the string value of the label. + */ + label?: any; + + /** + * Used to obtain the width of the label. + */ + width?: any; + + /** + * Used to obtain the height of the label. + */ + height?: any; + + /** + * Used to obtain the X offset of the label on the bullet graph scale. + */ + offsetX?: any; + + /** + * Used to obtain the Y offset of the label on the bullet graph scale. + */ + offsetY?: any; } interface IgBulletGraph { @@ -9643,11 +10094,26 @@ interface IgBulletGraph { * Gets or sets the orientation of the scale. * * Valid values: - * "horizontal" - * "vertical" + * "horizontal" The scale has a horizontal orientation. + * "vertical" The scale has a vertical orientation. */ orientation?: string; + /** + * Gets or sets the background brush for the scale. + */ + scaleBackgroundBrush?: string; + + /** + * Gets or sets the background outline for the scale. + */ + scaleBackgroundOutline?: string; + + /** + * Gets or sets the background outline thickness for the scale. + */ + scaleBackgroundThickness?: number; + /** * Gets or sets a collection of brushes to be used as the palette for bullet graph ranges. * The value provided should be an array of css color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection. @@ -9913,8 +10379,38 @@ interface IgBulletGraph { * Gets or sets the font. */ font?: string; + + /** + * 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; + + /** + * Event which is raised when a label of the bullet graph is formatted. + * Function takes first argument evt and second argument ui. + * Use ui.owner to obtain reference to the bullet graph widget. + * Use ui.actualMinimumValue to obtain the minimum value of the bullet graph scale. + * Use ui.actualMaximumValue to obtain the maximum value of the bullet graph scale. + * Use ui.value to obtain the value on the the bullet graph scale associated with the label. + * Use ui.label to obtain the string value of the label. + */ formatLabel?: FormatLabelEvent; + + /** + * Event which is raised when a label of the bullet graph is aligned along the scale. + * Function takes first argument evt and second argument ui. + * Use ui.owner to obtain reference to gauge widget. + * Use ui.actualMinimumValue to obtain the minimum value of the bullet graph scale. + * Use ui.actualMaximumValue to obtain the maximum value of the bullet graph scale. + * Use ui.value to obtain the value on the the bullet graph scale associated with the label. + * Use ui.label to obtain the string value of the label. + * Use ui.width to obtain the width of the label. + * Use ui.height to obtain the height of the label. + * Use ui.offsetX to obtain the X offset of the label on the bullet graph scale. + * Use ui.offsetY to obtain the Y offset of the label on the bullet graph scale. + */ alignLabel?: AlignLabelEvent; /** @@ -10067,6 +10563,42 @@ interface JQuery { */ igBulletGraph(optionLiteral: 'option', optionName: "orientation", optionValue: string): void; + /** + * Gets the background brush for the scale. + */ + igBulletGraph(optionLiteral: 'option', optionName: "scaleBackgroundBrush"): string; + + /** + * Sets the background brush for the scale. + * + * @optionValue New value to be set. + */ + igBulletGraph(optionLiteral: 'option', optionName: "scaleBackgroundBrush", optionValue: string): void; + + /** + * Gets the background outline for the scale. + */ + igBulletGraph(optionLiteral: 'option', optionName: "scaleBackgroundOutline"): string; + + /** + * Sets the background outline for the scale. + * + * @optionValue New value to be set. + */ + igBulletGraph(optionLiteral: 'option', optionName: "scaleBackgroundOutline", optionValue: string): void; + + /** + * Gets the background outline thickness for the scale. + */ + igBulletGraph(optionLiteral: 'option', optionName: "scaleBackgroundThickness"): number; + + /** + * Sets the background outline thickness for the scale. + * + * @optionValue New value to be set. + */ + igBulletGraph(optionLiteral: 'option', optionName: "scaleBackgroundThickness", optionValue: number): void; + /** * Gets a collection of brushes to be used as the palette for bullet graph ranges. * The value provided should be an array of css color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection. @@ -10700,26 +11232,74 @@ interface JQuery { igBulletGraph(optionLiteral: 'option', optionName: "font", optionValue: string): 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. */ igBulletGraph(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. */ igBulletGraph(optionLiteral: 'option', optionName: "pixelScalingRatio", optionValue: number): void; /** + * Event which is raised when a label of the bullet graph is formatted. + * Function takes first argument evt and second argument ui. + * Use ui.owner to obtain reference to the bullet graph widget. + * Use ui.actualMinimumValue to obtain the minimum value of the bullet graph scale. + * Use ui.actualMaximumValue to obtain the maximum value of the bullet graph scale. + * Use ui.value to obtain the value on the the bullet graph scale associated with the label. + * Use ui.label to obtain the string value of the label. */ igBulletGraph(optionLiteral: 'option', optionName: "formatLabel"): FormatLabelEvent; /** + * Event which is raised when a label of the bullet graph is formatted. + * Function takes first argument evt and second argument ui. + * Use ui.owner to obtain reference to the bullet graph widget. + * Use ui.actualMinimumValue to obtain the minimum value of the bullet graph scale. + * Use ui.actualMaximumValue to obtain the maximum value of the bullet graph scale. + * Use ui.value to obtain the value on the the bullet graph scale associated with the label. + * Use ui.label to obtain the string value of the label. + * + * @optionValue Define event handler function. */ igBulletGraph(optionLiteral: 'option', optionName: "formatLabel", optionValue: FormatLabelEvent): void; /** + * Event which is raised when a label of the bullet graph is aligned along the scale. + * Function takes first argument evt and second argument ui. + * Use ui.owner to obtain reference to gauge widget. + * Use ui.actualMinimumValue to obtain the minimum value of the bullet graph scale. + * Use ui.actualMaximumValue to obtain the maximum value of the bullet graph scale. + * Use ui.value to obtain the value on the the bullet graph scale associated with the label. + * Use ui.label to obtain the string value of the label. + * Use ui.width to obtain the width of the label. + * Use ui.height to obtain the height of the label. + * Use ui.offsetX to obtain the X offset of the label on the bullet graph scale. + * Use ui.offsetY to obtain the Y offset of the label on the bullet graph scale. */ igBulletGraph(optionLiteral: 'option', optionName: "alignLabel"): AlignLabelEvent; /** + * Event which is raised when a label of the bullet graph is aligned along the scale. + * Function takes first argument evt and second argument ui. + * Use ui.owner to obtain reference to gauge widget. + * Use ui.actualMinimumValue to obtain the minimum value of the bullet graph scale. + * Use ui.actualMaximumValue to obtain the maximum value of the bullet graph scale. + * Use ui.value to obtain the value on the the bullet graph scale associated with the label. + * Use ui.label to obtain the string value of the label. + * Use ui.width to obtain the width of the label. + * Use ui.height to obtain the height of the label. + * Use ui.offsetX to obtain the X offset of the label on the bullet graph scale. + * Use ui.offsetY to obtain the Y offset of the label on the bullet graph scale. + * + * @optionValue Define event handler function. */ igBulletGraph(optionLiteral: 'option', optionName: "alignLabel", optionValue: AlignLabelEvent): void; igBulletGraph(options: IgBulletGraph): JQuery; @@ -10746,6 +11326,16 @@ interface IgCategoryChart { */ yAxisMaximumValue?: number; + /** + * Gets or sets the distance between the X-axis and the bottom of the chart. + */ + xAxisExtent?: number; + + /** + * Gets or sets the distance between the Y-axis and the left edge of the chart. + */ + yAxisExtent?: number; + /** * Gets or sets the left margin of chart title */ @@ -10838,16 +11428,6 @@ interface IgCategoryChart { */ yAxisLabelTextColor?: string; - /** - * Gets or sets CSS font property for labels on X-axis - */ - xAxisLabelTextStyle?: string; - - /** - * Gets or sets CSS font property for labels on Y-axis - */ - yAxisLabelTextStyle?: string; - /** * Gets or sets the left margin of chart subtitle */ @@ -10873,51 +11453,31 @@ interface IgCategoryChart { */ subtitleTextColor?: string; - /** - * Gets or sets CSS font property for the chart subtitle - */ - subtitleTextStyle?: string; - /** * Gets or sets color of chart title */ titleTextColor?: string; /** - * Gets or sets CSS font property for the chart title - */ - titleTextStyle?: string; - - /** - * Gets or sets the left margin of the chart content in the canvas + * Gets or sets the left margin of the chart content. */ leftMargin?: number; /** - * Gets or sets the top margin of the chart content in the canvas + * Gets or sets the top margin of the chart content. */ topMargin?: number; /** - * Gets or sets the right margin of the chart content in the canvas + * Gets or sets the right margin of the chart content. */ rightMargin?: number; /** - * Gets or sets the bottom margin around the chart content in the canvas + * Gets or sets the bottom margin around the chart content. */ bottomMargin?: number; - /** - * Gets or sets the extent area dedicated to the a title on the X-axis. If unspecified, this value is auto-calculated. - */ - xAxisTitleExtent?: number; - - /** - * Gets or sets the extent area dedicated to the a title on the Y-axis. If unspecified, this value is auto-calculated. - */ - yAxisTitleExtent?: number; - /** * Gets or sets the margin around a title on the X-axis */ @@ -10968,10 +11528,22 @@ interface IgCategoryChart { */ yAxisTitleBottomMargin?: number; + /** + * Gets or sets color of title on the X-axis + */ + xAxisTitleTextColor?: string; + + /** + * Gets or sets color of title on the Y-axis + */ + yAxisTitleTextColor?: string; + createWrappedTooltip?: any; + /** * Gets or sets the id of a template element to use for tooltips, or markup representing the tooltip template. */ tooltipTemplate?: string; + tooltipTemplates?: any; /** * Gets or sets function which takes an context object and returns a formatted label for the X-axis. @@ -10983,16 +11555,6 @@ interface IgCategoryChart { */ yAxisFormatLabel?: any; - /** - * Gets or sets color of title on the X-axis - */ - xAxisTitleTextColor?: string; - - /** - * Gets or sets color of title on the Y-axis - */ - yAxisTitleTextColor?: string; - /** * Gets or sets CSS font property for title on X-axis */ @@ -11004,6 +11566,26 @@ interface IgCategoryChart { yAxisTitleTextStyle?: string; widget?: any; + /** + * Gets or sets CSS font property for labels on X-axis + */ + xAxisLabelTextStyle?: string; + + /** + * Gets or sets CSS font property for labels on Y-axis + */ + yAxisLabelTextStyle?: string; + + /** + * Gets or sets CSS font property for the chart subtitle + */ + subtitleTextStyle?: string; + + /** + * Gets or sets CSS font property for the chart title + */ + titleTextStyle?: string; + /** * Gets or sets a collection of data items used to generate the chart. * Value of this property can be a list of objects containing one or more numeric properties. Additionally, if the objects in the list implement the IEnumerable interface, the Category Chart will attempt to delve into the sub-collections when reading through the data source. Databinding can be further configured by attributing the data item classes with the DataSeriesMemberIntentAttribute. @@ -11056,12 +11638,12 @@ interface IgCategoryChart { legend?: any; /** - * Gets or sets whether the chart should perform horizontal zoom when the user initiates a mouse wheel or mouse drag operation. + * Gets or sets whether the chart can be horizontally zoomed through user interaction. */ isHorizontalZoomEnabled?: boolean; /** - * Gets or sets whether the chart should perform vertical zoom when the user initiates a mouse wheel or mouse drag operation. + * Gets or sets whether the chart can be vertically zoomed through user interaction. */ isVerticalZoomEnabled?: boolean; @@ -11086,10 +11668,10 @@ interface IgCategoryChart { * Gets or sets horizontal alignment which determines the title position, relative to the left and right edges of the chart. * * Valid values: - * "left" - * "center" - * "right" - * "stretch" + * "left" Align the item to the left + * "center" Center the item + * "right" Align the item to the right + * "stretch" Stretch the item to the full width */ titleAlignment?: string; @@ -11097,29 +11679,29 @@ interface IgCategoryChart { * Gets or sets horizontal alignment which determines the subtitle position, relative to the left and right edges of the chart. * * Valid values: - * "left" - * "center" - * "right" - * "stretch" + * "left" Align the item to the left + * "center" Center the item + * "right" Align the item to the right + * "stretch" Stretch the item to the full width */ subtitleAlignment?: string; /** - * Gets or sets behavior that determines how unknown values will be plotted on the chart.Null and Double.NaN are two examples of unknown values. + * Gets or sets the behavior that determines how unknown values will be plotted on the chart.Null and Double.NaN are two examples of unknown values. * * * Valid values: - * "linearInterpolate" - * "dontPlot" + * "linearInterpolate" Plot the unknown value as the midpoint between surrounding known values using linear interpolation. + * "dontPlot" Do not plot the unknown value on the chart. */ unknownValuePlotting?: string; /** - * Gets or sets behavior for markers in each series which are placed too close together for the current view, resulting in a collision. + * Gets or sets the behavior for markers in each series which are placed too close together for the current view, resulting in a collision. * * Valid values: - * "none" - * "omit" + * "none" Collision avoidance is disabled. + * "omit" Items colliding with other items will be hidden from view. */ markerCollisionAvoidance?: string; @@ -11132,26 +11714,26 @@ interface IgCategoryChart { * Gets or sets the method that determines how to animate series plots when the chart is loading into view * * Valid values: - * "auto" - * "fromZero" - * "sweepFromLeft" - * "sweepFromRight" - * "sweepFromTop" - * "sweepFromBottom" - * "sweepFromCenter" - * "accordionFromLeft" - * "accordionFromRight" - * "accordionFromTop" - * "accordionFromBottom" - * "expand" - * "sweepFromCategoryAxisMinimum" - * "sweepFromCategoryAxisMaximum" - * "sweepFromValueAxisMinimum" - * "sweepFromValueAxisMaximum" - * "accordionFromCategoryAxisMinimum" - * "accordionFromCategoryAxisMaximum" - * "accordionFromValueAxisMinimum" - * "accordionFromValueAxisMaximum" + * "auto" Series transitions in an automatically chosen based on type of series and its orientation + * "fromZero" Series transitions in from the reference value of the value axis. + * "sweepFromLeft" Series sweeps in from the left + * "sweepFromRight" Series sweeps in from the right + * "sweepFromTop" Series sweeps in from the top. + * "sweepFromBottom" Series sweeps in from the bottom. + * "sweepFromCenter" Series sweeps in from the center. + * "accordionFromLeft" Series accordions in from the left. + * "accordionFromRight" Series accordions in from the right. + * "accordionFromTop" Series accordions in from the top. + * "accordionFromBottom" Series accordions in from the bottom. + * "expand" Series expands from the value midpoints. + * "sweepFromCategoryAxisMinimum" Series sweeps in from the category axis minimum. + * "sweepFromCategoryAxisMaximum" Series sweeps in from the category axis maximum. + * "sweepFromValueAxisMinimum" Series sweeps in from the value axis minimum. + * "sweepFromValueAxisMaximum" Series sweeps in from the value axis maximum. + * "accordionFromCategoryAxisMinimum" Series accordions in from the category axis minimum. + * "accordionFromCategoryAxisMaximum" Series accordions in from the category axis maximum. + * "accordionFromValueAxisMinimum" Series accordions in from the value axis minimum. + * "accordionFromValueAxisMaximum" Series accordions in from the value axis maximum. */ transitionInMode?: string; @@ -11159,11 +11741,11 @@ interface IgCategoryChart { * Gets or sets the arrival speed used for animating series plots when the chart is loading into view * * Valid values: - * "auto" - * "normal" - * "valueScaled" - * "indexScaled" - * "random" + * "auto" A speed type is automatically selected. + * "normal" All speeds are normal, data points will arrive at the same time. + * "valueScaled" Data points will arrive later if their value is further from the start point. + * "indexScaled" Data points will arrive later if their index is further from the axis origin. + * "random" Data points will arrive at random times. */ transitionInSpeedType?: string; @@ -11192,7 +11774,7 @@ interface IgCategoryChart { xAxisOverlap?: number; /** - * Gets or sets the distance between each labels and grid line along the Y-axis. + * Gets or sets the distance between each label and grid line along the Y-axis. */ yAxisInterval?: number; @@ -11343,16 +11925,6 @@ interface IgCategoryChart { */ yAxisLabelAngle?: number; - /** - * Gets or sets the distance between the X-axis and the bottom of the chart. - */ - xAxisExtent?: number; - - /** - * Gets or sets the distance between the Y-axis and the left edge of the chart. - */ - yAxisExtent?: number; - /** * Gets or sets the angle of rotation for the X-axis title. */ @@ -11379,20 +11951,20 @@ interface IgCategoryChart { * Gets or sets the formula used for calculating trend lines in this chart. * * Valid values: - * "none" - * "linearFit" - * "quadraticFit" - * "cubicFit" - * "quarticFit" - * "quinticFit" - * "logarithmicFit" - * "exponentialFit" - * "powerLawFit" - * "simpleAverage" - * "exponentialAverage" - * "modifiedAverage" - * "cumulativeAverage" - * "weightedAverage" + * "none" No trend line will be displayed. + * "linearFit" Linear fit. + * "quadraticFit" Quadratic polynomial fit. + * "cubicFit" Cubic polynomial fit. + * "quarticFit" Quartic polynomial fit. + * "quinticFit" Quintic polynomial fit. + * "logarithmicFit" Logarithmic fit. + * "exponentialFit" Exponential fit. + * "powerLawFit" Powerlaw fit. + * "simpleAverage" Simple moving average. + * "exponentialAverage" Exponential moving average. + * "modifiedAverage" Modified moving average. + * "cumulativeAverage" Cumulative moving average. + * "weightedAverage" Weighted moving average. */ trendLineType?: string; @@ -11402,13 +11974,13 @@ interface IgCategoryChart { thickness?: number; /** - * Gets or sets collection of marker shapes used for representing data points of series in this chart. + * Gets or sets the collection of marker shapes used for representing data points of series in this chart. * When MarkerTypes is null or empty, each series' marker type will be set to none or automatic, depending on the series type. */ markerTypes?: any; /** - * Gets or sets the palette of brushes used for coloring fill of data point markers. + * Gets or sets the palette of brushes used as the fill color for data point markers. * The value provided should be an array of css color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection. */ markerBrushes?: any; @@ -11444,10 +12016,10 @@ interface IgCategoryChart { * Gets or sets the horizontal alignment of the X-axis title. * * Valid values: - * "left" - * "center" - * "right" - * "stretch" + * "left" Align the item to the left + * "center" Center the item + * "right" Align the item to the right + * "stretch" Stretch the item to the full width */ xAxisTitleAlignment?: string; @@ -11455,10 +12027,10 @@ interface IgCategoryChart { * Gets or sets the vertical alignment of the Y-axis title. * * Valid values: - * "top" - * "center" - * "bottom" - * "stretch" + * "top" Align the item to the top + * "center" Center the item + * "bottom" Align the item to the bottom + * "stretch" Stretch the item to the full height */ yAxisTitleAlignment?: string; @@ -11466,10 +12038,10 @@ interface IgCategoryChart { * Gets or sets the horizontal alignment of X-axis labels. * * Valid values: - * "left" - * "center" - * "right" - * "stretch" + * "left" Align the item to the left + * "center" Center the item + * "right" Align the item to the right + * "stretch" Stretch the item to the full width */ xAxisLabelHorizontalAlignment?: string; @@ -11477,10 +12049,10 @@ interface IgCategoryChart { * Gets or sets the horizontal alignment of Y-axis labels. * * Valid values: - * "left" - * "center" - * "right" - * "stretch" + * "left" Align the item to the left + * "center" Center the item + * "right" Align the item to the right + * "stretch" Stretch the item to the full width */ yAxisLabelHorizontalAlignment?: string; @@ -11488,10 +12060,10 @@ interface IgCategoryChart { * Gets or sets the vertical alignment of X-axis labels. * * Valid values: - * "top" - * "center" - * "bottom" - * "stretch" + * "top" Align the item to the top + * "center" Center the item + * "bottom" Align the item to the bottom + * "stretch" Stretch the item to the full height */ xAxisLabelVerticalAlignment?: string; @@ -11499,10 +12071,10 @@ interface IgCategoryChart { * Gets or sets the vertical alignment of Y-axis labels. * * Valid values: - * "top" - * "center" - * "bottom" - * "stretch" + * "top" Align the item to the top + * "center" Center the item + * "bottom" Align the item to the bottom + * "stretch" Stretch the item to the full height */ yAxisLabelVerticalAlignment?: string; @@ -11510,8 +12082,8 @@ interface IgCategoryChart { * Gets or sets the visibility of X-axis labels. * * Valid values: - * "visible" - * "collapsed" + * "visible" Display the element. + * "collapsed" Do not display the element. */ xAxisLabelVisibility?: string; @@ -11519,10 +12091,15 @@ interface IgCategoryChart { * Gets or sets the visibility of Y-axis labels. * * Valid values: - * "visible" - * "collapsed" + * "visible" Display the element. + * "collapsed" Do not display the element. */ yAxisLabelVisibility?: string; + + /** + * Brushes to use for drawing negative elements, when using a chart type with contextual coloring, such as Waterfall. + * The value provided should be an array of css color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection. + */ negativeOutlines?: any; /** @@ -11689,7 +12266,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. + * 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. */ @@ -11697,7 +12274,7 @@ 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. + * 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. @@ -11707,7 +12284,7 @@ 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. + * 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. @@ -11724,6 +12301,11 @@ interface IgCategoryChartMethods { * Binds data to the chart */ dataBind(): void; + + /** + * Forces any pending deferred work to render on the chart before continuing + */ + flush(): void; } interface JQuery { data(propertyName: "igCategoryChart"): IgCategoryChartMethods; @@ -11746,6 +12328,7 @@ interface JQuery { igCategoryChart(methodName: "notifyRemoveItem", dataSource: Object, index: number, oldItem: Object): Object; igCategoryChart(methodName: "chart"): Object; igCategoryChart(methodName: "dataBind"): void; + igCategoryChart(methodName: "flush"): void; /** * Gets the data value corresponding to the minimum value of the Y-axis. @@ -11771,6 +12354,30 @@ interface JQuery { */ igCategoryChart(optionLiteral: 'option', optionName: "yAxisMaximumValue", optionValue: number): void; + /** + * Gets the distance between the X-axis and the bottom of the chart. + */ + igCategoryChart(optionLiteral: 'option', optionName: "xAxisExtent"): number; + + /** + * Sets the distance between the X-axis and the bottom of the chart. + * + * @optionValue New value to be set. + */ + igCategoryChart(optionLiteral: 'option', optionName: "xAxisExtent", optionValue: number): void; + + /** + * Gets the distance between the Y-axis and the left edge of the chart. + */ + igCategoryChart(optionLiteral: 'option', optionName: "yAxisExtent"): number; + + /** + * Sets the distance between the Y-axis and the left edge of the chart. + * + * @optionValue New value to be set. + */ + igCategoryChart(optionLiteral: 'option', optionName: "yAxisExtent", optionValue: number): void; + /** * Gets the left margin of chart title */ @@ -11991,30 +12598,6 @@ interface JQuery { */ igCategoryChart(optionLiteral: 'option', optionName: "yAxisLabelTextColor", optionValue: string): void; - /** - * Gets CSS font property for labels on X-axis - */ - igCategoryChart(optionLiteral: 'option', optionName: "xAxisLabelTextStyle"): string; - - /** - * Sets CSS font property for labels on X-axis - * - * @optionValue New value to be set. - */ - igCategoryChart(optionLiteral: 'option', optionName: "xAxisLabelTextStyle", optionValue: string): void; - - /** - * Gets CSS font property for labels on Y-axis - */ - igCategoryChart(optionLiteral: 'option', optionName: "yAxisLabelTextStyle"): string; - - /** - * Sets CSS font property for labels on Y-axis - * - * @optionValue New value to be set. - */ - igCategoryChart(optionLiteral: 'option', optionName: "yAxisLabelTextStyle", optionValue: string): void; - /** * Gets the left margin of chart subtitle */ @@ -12075,18 +12658,6 @@ interface JQuery { */ igCategoryChart(optionLiteral: 'option', optionName: "subtitleTextColor", optionValue: string): void; - /** - * Gets CSS font property for the chart subtitle - */ - igCategoryChart(optionLiteral: 'option', optionName: "subtitleTextStyle"): string; - - /** - * Sets CSS font property for the chart subtitle - * - * @optionValue New value to be set. - */ - igCategoryChart(optionLiteral: 'option', optionName: "subtitleTextStyle", optionValue: string): void; - /** * Gets color of chart title */ @@ -12100,89 +12671,53 @@ interface JQuery { igCategoryChart(optionLiteral: 'option', optionName: "titleTextColor", optionValue: string): void; /** - * Gets CSS font property for the chart title - */ - igCategoryChart(optionLiteral: 'option', optionName: "titleTextStyle"): string; - - /** - * Sets CSS font property for the chart title - * - * @optionValue New value to be set. - */ - igCategoryChart(optionLiteral: 'option', optionName: "titleTextStyle", optionValue: string): void; - - /** - * Gets the left margin of the chart content in the canvas + * Gets the left margin of the chart content. */ igCategoryChart(optionLiteral: 'option', optionName: "leftMargin"): number; /** - * Sets the left margin of the chart content in the canvas + * Sets the left margin of the chart content. * * @optionValue New value to be set. */ igCategoryChart(optionLiteral: 'option', optionName: "leftMargin", optionValue: number): void; /** - * Gets the top margin of the chart content in the canvas + * Gets the top margin of the chart content. */ igCategoryChart(optionLiteral: 'option', optionName: "topMargin"): number; /** - * Sets the top margin of the chart content in the canvas + * Sets the top margin of the chart content. * * @optionValue New value to be set. */ igCategoryChart(optionLiteral: 'option', optionName: "topMargin", optionValue: number): void; /** - * Gets the right margin of the chart content in the canvas + * Gets the right margin of the chart content. */ igCategoryChart(optionLiteral: 'option', optionName: "rightMargin"): number; /** - * Sets the right margin of the chart content in the canvas + * Sets the right margin of the chart content. * * @optionValue New value to be set. */ igCategoryChart(optionLiteral: 'option', optionName: "rightMargin", optionValue: number): void; /** - * Gets the bottom margin around the chart content in the canvas + * Gets the bottom margin around the chart content. */ igCategoryChart(optionLiteral: 'option', optionName: "bottomMargin"): number; /** - * Sets the bottom margin around the chart content in the canvas + * Sets the bottom margin around the chart content. * * @optionValue New value to be set. */ igCategoryChart(optionLiteral: 'option', optionName: "bottomMargin", optionValue: number): void; - /** - * Gets the extent area dedicated to the a title on the X-axis. If unspecified, this value is auto-calculated. - */ - igCategoryChart(optionLiteral: 'option', optionName: "xAxisTitleExtent"): number; - - /** - * Sets the extent area dedicated to the a title on the X-axis. If unspecified, this value is auto-calculated. - * - * @optionValue New value to be set. - */ - igCategoryChart(optionLiteral: 'option', optionName: "xAxisTitleExtent", optionValue: number): void; - - /** - * Gets the extent area dedicated to the a title on the Y-axis. If unspecified, this value is auto-calculated. - */ - igCategoryChart(optionLiteral: 'option', optionName: "yAxisTitleExtent"): number; - - /** - * Sets the extent area dedicated to the a title on the Y-axis. If unspecified, this value is auto-calculated. - * - * @optionValue New value to be set. - */ - igCategoryChart(optionLiteral: 'option', optionName: "yAxisTitleExtent", optionValue: number): void; - /** * Gets the margin around a title on the X-axis */ @@ -12303,6 +12838,38 @@ interface JQuery { */ igCategoryChart(optionLiteral: 'option', optionName: "yAxisTitleBottomMargin", optionValue: number): void; + /** + * Gets color of title on the X-axis + */ + igCategoryChart(optionLiteral: 'option', optionName: "xAxisTitleTextColor"): string; + + /** + * Sets color of title on the X-axis + * + * @optionValue New value to be set. + */ + igCategoryChart(optionLiteral: 'option', optionName: "xAxisTitleTextColor", optionValue: string): void; + + /** + * Gets color of title on the Y-axis + */ + igCategoryChart(optionLiteral: 'option', optionName: "yAxisTitleTextColor"): string; + + /** + * Sets color of title on the Y-axis + * + * @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; + /** * Gets the id of a template element to use for tooltips, or markup representing the tooltip template. */ @@ -12315,6 +12882,14 @@ interface JQuery { */ igCategoryChart(optionLiteral: 'option', optionName: "tooltipTemplate", optionValue: string): void; + /** + */ + igCategoryChart(optionLiteral: 'option', optionName: "tooltipTemplates"): any; + + /** + */ + igCategoryChart(optionLiteral: 'option', optionName: "tooltipTemplates", optionValue: any): void; + /** * Gets function which takes an context object and returns a formatted label for the X-axis. */ @@ -12339,30 +12914,6 @@ interface JQuery { */ igCategoryChart(optionLiteral: 'option', optionName: "yAxisFormatLabel", optionValue: any): void; - /** - * Gets color of title on the X-axis - */ - igCategoryChart(optionLiteral: 'option', optionName: "xAxisTitleTextColor"): string; - - /** - * Sets color of title on the X-axis - * - * @optionValue New value to be set. - */ - igCategoryChart(optionLiteral: 'option', optionName: "xAxisTitleTextColor", optionValue: string): void; - - /** - * Gets color of title on the Y-axis - */ - igCategoryChart(optionLiteral: 'option', optionName: "yAxisTitleTextColor"): string; - - /** - * Sets color of title on the Y-axis - * - * @optionValue New value to be set. - */ - igCategoryChart(optionLiteral: 'option', optionName: "yAxisTitleTextColor", optionValue: string): void; - /** * Gets CSS font property for title on X-axis */ @@ -12395,6 +12946,54 @@ interface JQuery { */ igCategoryChart(optionLiteral: 'option', optionName: "widget", optionValue: any): void; + /** + * Gets CSS font property for labels on X-axis + */ + igCategoryChart(optionLiteral: 'option', optionName: "xAxisLabelTextStyle"): string; + + /** + * Sets CSS font property for labels on X-axis + * + * @optionValue New value to be set. + */ + igCategoryChart(optionLiteral: 'option', optionName: "xAxisLabelTextStyle", optionValue: string): void; + + /** + * Gets CSS font property for labels on Y-axis + */ + igCategoryChart(optionLiteral: 'option', optionName: "yAxisLabelTextStyle"): string; + + /** + * Sets CSS font property for labels on Y-axis + * + * @optionValue New value to be set. + */ + igCategoryChart(optionLiteral: 'option', optionName: "yAxisLabelTextStyle", optionValue: string): void; + + /** + * Gets CSS font property for the chart subtitle + */ + igCategoryChart(optionLiteral: 'option', optionName: "subtitleTextStyle"): string; + + /** + * Sets CSS font property for the chart subtitle + * + * @optionValue New value to be set. + */ + igCategoryChart(optionLiteral: 'option', optionName: "subtitleTextStyle", optionValue: string): void; + + /** + * Gets CSS font property for the chart title + */ + igCategoryChart(optionLiteral: 'option', optionName: "titleTextStyle"): string; + + /** + * Sets CSS font property for the chart title + * + * @optionValue New value to be set. + */ + igCategoryChart(optionLiteral: 'option', optionName: "titleTextStyle", optionValue: string): void; + /** * Gets a collection of data items used to generate the chart. * Value of this property can be a list of objects containing one or more numeric properties. Additionally, if the objects in the list implement the IEnumerable interface, the Category Chart will attempt to delve into the sub-collections when reading through the data source. Databinding can be further configured by attributing the data item classes with the DataSeriesMemberIntentAttribute. @@ -12488,24 +13087,24 @@ interface JQuery { igCategoryChart(optionLiteral: 'option', optionName: "legend", optionValue: any): void; /** - * Gets whether the chart should perform horizontal zoom when the user initiates a mouse wheel or mouse drag operation. + * Gets whether the chart can be horizontally zoomed through user interaction. */ igCategoryChart(optionLiteral: 'option', optionName: "isHorizontalZoomEnabled"): boolean; /** - * Sets whether the chart should perform horizontal zoom when the user initiates a mouse wheel or mouse drag operation. + * Sets whether the chart can be horizontally zoomed through user interaction. * * @optionValue New value to be set. */ igCategoryChart(optionLiteral: 'option', optionName: "isHorizontalZoomEnabled", optionValue: boolean): void; /** - * Gets whether the chart should perform vertical zoom when the user initiates a mouse wheel or mouse drag operation. + * Gets whether the chart can be vertically zoomed through user interaction. */ igCategoryChart(optionLiteral: 'option', optionName: "isVerticalZoomEnabled"): boolean; /** - * Sets whether the chart should perform vertical zoom when the user initiates a mouse wheel or mouse drag operation. + * Sets whether the chart can be vertically zoomed through user interaction. * * @optionValue New value to be set. */ @@ -12576,13 +13175,13 @@ interface JQuery { igCategoryChart(optionLiteral: 'option', optionName: "subtitleAlignment", optionValue: string): void; /** - * Gets behavior that determines how unknown values will be plotted on the chart.Null and Double.NaN are two examples of unknown values. + * 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; /** - * Sets behavior that determines how unknown values will be plotted on the chart.Null and Double.NaN are two examples of unknown values. + * Sets the behavior that determines how unknown values will be plotted on the chart.Null and Double.NaN are two examples of unknown values. * * * @optionValue New value to be set. @@ -12590,12 +13189,12 @@ interface JQuery { igCategoryChart(optionLiteral: 'option', optionName: "unknownValuePlotting", optionValue: string): void; /** - * Gets behavior for markers in each series which are placed too close together for the current view, resulting in a collision. + * 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; /** - * Sets behavior for markers in each series which are placed too close together for the current view, resulting in a collision. + * Sets the behavior for markers in each series which are placed too close together for the current view, resulting in a collision. * * @optionValue New value to be set. */ @@ -12694,12 +13293,12 @@ interface JQuery { igCategoryChart(optionLiteral: 'option', optionName: "xAxisOverlap", optionValue: number): void; /** - * Gets the distance between each labels and grid line along the Y-axis. + * Gets the distance between each label and grid line along the Y-axis. */ igCategoryChart(optionLiteral: 'option', optionName: "yAxisInterval"): number; /** - * Sets the distance between each labels and grid line along the Y-axis. + * Sets the distance between each label and grid line along the Y-axis. * * @optionValue New value to be set. */ @@ -13057,30 +13656,6 @@ interface JQuery { */ igCategoryChart(optionLiteral: 'option', optionName: "yAxisLabelAngle", optionValue: number): void; - /** - * Gets the distance between the X-axis and the bottom of the chart. - */ - igCategoryChart(optionLiteral: 'option', optionName: "xAxisExtent"): number; - - /** - * Sets the distance between the X-axis and the bottom of the chart. - * - * @optionValue New value to be set. - */ - igCategoryChart(optionLiteral: 'option', optionName: "xAxisExtent", optionValue: number): void; - - /** - * Gets the distance between the Y-axis and the left edge of the chart. - */ - igCategoryChart(optionLiteral: 'option', optionName: "yAxisExtent"): number; - - /** - * Sets the distance between the Y-axis and the left edge of the chart. - * - * @optionValue New value to be set. - */ - igCategoryChart(optionLiteral: 'option', optionName: "yAxisExtent", optionValue: number): void; - /** * Gets the angle of rotation for the X-axis title. */ @@ -13158,13 +13733,13 @@ interface JQuery { igCategoryChart(optionLiteral: 'option', optionName: "thickness", optionValue: number): void; /** - * Gets collection of marker shapes used for representing data points of series in this chart. + * Gets the collection of marker shapes used for representing data points of series in this chart. * When MarkerTypes is null or empty, each series' marker type will be set to none or automatic, depending on the series type. */ igCategoryChart(optionLiteral: 'option', optionName: "markerTypes"): any; /** - * Sets collection of marker shapes used for representing data points of series in this chart. + * Sets the collection of marker shapes used for representing data points of series in this chart. * When MarkerTypes is null or empty, each series' marker type will be set to none or automatic, depending on the series type. * * @optionValue New value to be set. @@ -13172,13 +13747,13 @@ interface JQuery { igCategoryChart(optionLiteral: 'option', optionName: "markerTypes", optionValue: any): void; /** - * Gets the palette of brushes used for coloring fill of data point markers. + * Gets the palette of brushes used as the fill color for data point markers. * The value provided should be an array of css color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection. */ igCategoryChart(optionLiteral: 'option', optionName: "markerBrushes"): any; /** - * Sets the palette of brushes used for coloring fill of data point markers. + * Sets the palette of brushes used as the fill color for data point markers. * The value provided should be an array of css color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection. * * @optionValue New value to be set. @@ -13346,10 +13921,16 @@ interface JQuery { igCategoryChart(optionLiteral: 'option', optionName: "yAxisLabelVisibility", optionValue: string): void; /** + * Brushes to use for drawing negative elements, when using a chart type with contextual coloring, such as Waterfall. + * The value provided should be an array of css color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection. */ igCategoryChart(optionLiteral: 'option', optionName: "negativeOutlines"): any; /** + * Brushes to use for drawing negative elements, when using a chart type with contextual coloring, such as Waterfall. + * The value provided should be an array of css color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection. + * + * @optionValue New value to be set. */ igCategoryChart(optionLiteral: 'option', optionName: "negativeOutlines", optionValue: any): void; @@ -13780,7 +14361,7 @@ interface IgDataChartAxes { coercionMethods?: any; /** - * Gets or sets the axis label format string. + * Gets or sets the label mapping property to use for axis labels. */ label?: any; @@ -15569,15 +16150,25 @@ interface IgDataChart { windowRect?: any; /** - * Gets or sets the current Chart's horizontal zoomability. + * Gets or sets the current Chart's horizontal zoomability. This option is deprecated - please use `isHorizontalZoomEnabled` instead. */ horizontalZoomable?: boolean; /** - * Gets or sets the current Chart's vertical zoomability. + * Gets or sets the current Chart's vertical zoomability. This option is deprecated - please use `isVerticalZoomEnabled` instead. */ verticalZoomable?: boolean; + /** + * Gets or sets the current Chart's horizontal zoomability. + */ + isHorizontalZoomEnabled?: boolean; + + /** + * Gets or sets the current Chart's vertical zoomability. + */ + isVerticalZoomEnabled?: boolean; + /** * 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. * @@ -16362,7 +16953,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. + * 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. */ @@ -16370,7 +16961,7 @@ 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. + * 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. @@ -16380,7 +16971,7 @@ 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. + * 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. @@ -16398,7 +16989,7 @@ 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. + * 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. @@ -16407,7 +16998,7 @@ 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. + * 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. @@ -16452,6 +17043,13 @@ interface IgDataChartMethods { */ 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. + */ + getActualInterval(targetName: string): void; + /** * Creates a print preview page with the chart, hiding all other elements on the page. */ @@ -16890,6 +17488,11 @@ interface IgPieChart { */ labelMemberPath?: string; + /** + * Gets or sets the property name that contains the legend labels. + */ + legendLabelMemberPath?: string; + /** * Gets or Sets the property name that contains the values. */ @@ -17286,6 +17889,16 @@ interface IgPieChartMethods { * Exports visual data from the pie chart to aid in unit testing */ exportVisualData(): void; + + /** + * Returns data that the pie chart is bound to. + */ + getData(): Object; + + /** + * Forces any pending deferred work to render on the chart before continuing + */ + flush(): void; } interface JQuery { data(propertyName: "igPieChart"): IgPieChartMethods; @@ -17316,6 +17929,7 @@ interface JQuery { igDataChart(methodName: "exportVisualData"): void; igDataChart(methodName: "getActualMinimumValue", targetName: string): void; igDataChart(methodName: "getActualMaximumValue", targetName: string): void; + igDataChart(methodName: "getActualInterval", targetName: string): void; igDataChart(methodName: "print"): void; igDataChart(methodName: "renderSeries", targetName: string, animate: boolean): void; igDataChart(methodName: "getItemIndex", targetName: string, worldPoint: Object): number; @@ -17429,28 +18043,52 @@ interface JQuery { igDataChart(optionLiteral: 'option', optionName: "windowRect", optionValue: any): void; /** - * Gets the current Chart's horizontal zoomability. + * Gets the current Chart's horizontal zoomability. This option is deprecated - please use `isHorizontalZoomEnabled` instead. */ igDataChart(optionLiteral: 'option', optionName: "horizontalZoomable"): boolean; /** - * Sets the current Chart's horizontal zoomability. + * Sets the current Chart's horizontal zoomability. This option is deprecated - please use `isHorizontalZoomEnabled` instead. * * @optionValue New value to be set. */ igDataChart(optionLiteral: 'option', optionName: "horizontalZoomable", optionValue: boolean): void; /** - * Gets the current Chart's vertical zoomability. + * Gets the current Chart's vertical zoomability. This option is deprecated - please use `isVerticalZoomEnabled` instead. */ igDataChart(optionLiteral: 'option', optionName: "verticalZoomable"): boolean; + /** + * Sets the current Chart's vertical zoomability. This option is deprecated - please use `isVerticalZoomEnabled` instead. + * + * @optionValue New value to be set. + */ + igDataChart(optionLiteral: 'option', optionName: "verticalZoomable", optionValue: boolean): void; + + /** + * Gets the current Chart's horizontal zoomability. + */ + igDataChart(optionLiteral: 'option', optionName: "isHorizontalZoomEnabled"): boolean; + + /** + * Sets the current Chart's horizontal zoomability. + * + * @optionValue New value to be set. + */ + igDataChart(optionLiteral: 'option', optionName: "isHorizontalZoomEnabled", optionValue: boolean): void; + + /** + * Gets the current Chart's vertical zoomability. + */ + igDataChart(optionLiteral: 'option', optionName: "isVerticalZoomEnabled"): boolean; + /** * Sets the current Chart's vertical zoomability. * * @optionValue New value to be set. */ - igDataChart(optionLiteral: 'option', optionName: "verticalZoomable", optionValue: boolean): void; + igDataChart(optionLiteral: 'option', optionName: "isVerticalZoomEnabled", optionValue: boolean): void; /** * 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. @@ -18939,6 +19577,8 @@ interface JQuery { igPieChart(methodName: "widget"): void; igPieChart(methodName: "print"): void; igPieChart(methodName: "exportVisualData"): void; + igPieChart(methodName: "getData"): Object; + igPieChart(methodName: "flush"): void; /** * The width of the chart. It can be set as a number in pixels, string (px) or percentage (%). @@ -19036,6 +19676,18 @@ interface JQuery { */ igPieChart(optionLiteral: 'option', optionName: "labelMemberPath", optionValue: string): void; + /** + * Gets the property name that contains the legend labels. + */ + igPieChart(optionLiteral: 'option', optionName: "legendLabelMemberPath"): string; + + /** + * Sets the property name that contains the legend labels. + * + * @optionValue New value to be set. + */ + igPieChart(optionLiteral: 'option', optionName: "legendLabelMemberPath", optionValue: string): void; + /** * Gets or Sets the property name that contains the values. */ @@ -21444,8 +22096,8 @@ interface IgComboMethods { /** * Forces an update of the igCombo value according to the current text in the igCombo input. * - * The refresh is primarily intended to be used with [allowCustomValue](ui.igcombo#options:allowCustomValue) set to true. - * The refresh will take the current text and, if no selection is applied, will set it as igCombo value provided that [allowCustomValue](ui.igcombo#options:allowCustomValue) true. + * The refresh is primarily intended to be used with [allowCustomValue](ui.igcombo#options:allowCustomValue) set to true. + * The refresh will take the current text and, if no selection is applied, will set it as igCombo value provided that [allowCustomValue](ui.igcombo#options:allowCustomValue) true. */ refreshValue(): Object; @@ -21566,14 +22218,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; @@ -21583,14 +22235,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; @@ -21600,14 +22252,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; @@ -21616,13 +22268,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; @@ -21632,8 +22284,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; @@ -21643,8 +22295,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; @@ -21654,8 +22306,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; @@ -21664,8 +22316,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; @@ -21871,14 +22523,14 @@ interface JQuery { /** * Sets URL which is used for sending JSON on request for remote filtering (MVC for example). That option is required when [load on demand](ui.igcombo#options:loadOnDemandSettings) is - * [enabled](ui.igcombo#options:loadOnDemandSettings.enabled) and its [type](ui.igcombo#options:filteringType) is remote. + * [enabled](ui.igcombo#options:loadOnDemandSettings.enabled) and its [type](ui.igcombo#options:filteringType) is remote. * */ igCombo(optionLiteral: 'option', optionName: "dataSourceUrl"): string; /** * Sets URL which is used for sending JSON on request for remote filtering (MVC for example). That option is required when [load on demand](ui.igcombo#options:loadOnDemandSettings) is - * [enabled](ui.igcombo#options:loadOnDemandSettings.enabled) and its [type](ui.igcombo#options:filteringType) is remote. + * [enabled](ui.igcombo#options:loadOnDemandSettings.enabled) and its [type](ui.igcombo#options:filteringType) is remote. * * * @optionValue New value to be set. @@ -21985,14 +22637,14 @@ interface JQuery { /** * Gets/Sets a template used to render an item in list. The igCombo utilizes igTemplating for generating node content templates. - * More info on the templating engine can be found here: http://www.igniteui.com/help/infragistics-templating-engine. + * More info on the templating engine can be found here: http://www.igniteui.com/help/infragistics-templating-engine. * */ igCombo(optionLiteral: 'option', optionName: "itemTemplate"): string; /** * /Sets a template used to render an item in list. The igCombo utilizes igTemplating for generating node content templates. - * More info on the templating engine can be found here: http://www.igniteui.com/help/infragistics-templating-engine. + * More info on the templating engine can be found here: http://www.igniteui.com/help/infragistics-templating-engine. * * * @optionValue New value to be set. @@ -23334,7 +23986,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. + * Note: If the state of the dialog changes, then stateChanging and stateChanged events are raised. * * @param state New state. */ @@ -23347,10 +23999,10 @@ interface IgDialogMethods { /** * Closes the dialog if it is opened. - * Notes: - * 1. If the state of the dialog changes, then stateChanging and stateChanged events are raised. - * 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. + * Notes: + * 1. If the state of the dialog changes, then stateChanging and stateChanged events are raised. + * 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. */ @@ -23358,42 +24010,42 @@ interface IgDialogMethods { /** * Opens the dialog if it is closed. Notes: - * 1. If the state of the dialog changes, then stateChanging and stateChanged events are raised. - * 2. That method does not change minimized or maximized state of the dialog. It means that if the dialog was in minimized or maximized stated when closed by "close" method, then the dialog will open in minimized or maximized state respectively. + * 1. If the state of the dialog changes, then stateChanging and stateChanged events are raised. + * 2. That method does not change minimized or maximized state of the dialog. It means that if the dialog was in minimized or maximized stated when closed by "close" method, then the dialog will open in minimized or maximized state respectively. */ open(): Object; /** * Minimizes the dialog if it is not minimized. - * Note: If the state of the dialog changes, then stateChanging and stateChanged events are raised. + * Note: If the state of the dialog changes, then stateChanging and stateChanged events are raised. */ minimize(): Object; /** * Maximizes the dialog if it is not maximized. - * Note: If the state of the dialog changes, then stateChanging and stateChanged events are raised. + * Note: If the state of the dialog changes, then stateChanging and stateChanged events are raised. */ maximize(): Object; /** * Sets the normal state for the dialog if it was maximized or minimized. - * Note: If the state of the dialog changes, then stateChanging and stateChanged events are raised. + * Note: If the state of the dialog changes, then stateChanging and stateChanged events are raised. */ restore(): Object; /** * Pins the dialog if it is not pinned. - * When the dialog is pinned, then the html element of the dialog is moved to the original container where the target element was located and position:absolute is removed. - * The pinned dialog does not support modal state, maximized state and it can not be moved. - * Notes: - * 1. If the parent element of the original target-element is invisible, then the pinned dialog becomes invisible as well. - * 2. If the state of the dialog changes, then stateChanging and stateChanged events are raised. + * When the dialog is pinned, then the html element of the dialog is moved to the original container where the target element was located and position:absolute is removed. + * The pinned dialog does not support modal state, maximized state and it can not be moved. + * Notes: + * 1. If the parent element of the original target-element is invisible, then the pinned dialog becomes invisible as well. + * 2. If the state of the dialog changes, then stateChanging and stateChanged events are raised. */ pin(): Object; /** * Unpins the dialog if it is pinned. - * Note: If the state of the dialog changes, then stateChanging and stateChanged events are raised. + * Note: If the state of the dialog changes, then stateChanging and stateChanged events are raised. */ unpin(): Object; @@ -24255,11 +24907,11 @@ interface IgDoughnutChartSeries { * Gets or sets the position of chart labels. * * Valid values: - * "none" - * "center" - * "insideEnd" - * "outsideEnd" - * "bestFit" + * "none" No labels will be displayed. + * "center" Labels will be displayed in the center. + * "insideEnd" Labels will be displayed inside and by the edge of the container. + * "outsideEnd" Labels will be displayed outside the container. + * "bestFit" Labels will automatically decide their location. */ labelsPosition?: string; @@ -24267,8 +24919,8 @@ interface IgDoughnutChartSeries { * Gets or sets whether the leader lines are visible. * * Valid values: - * "visible" - * "collapsed" + * "visible" Display the element. + * "collapsed" Do not display the element. */ leaderLineVisibility?: string; @@ -24281,9 +24933,9 @@ interface IgDoughnutChartSeries { * Gets or sets what type of leader lines will be used for the outside end labels. * * Valid values: - * "straight" - * "arc" - * "spline" + * "straight" A straight line is drawn between the slice and its label. + * "arc" A curved line is drawn between the slice and its label. The line follows makes a natural turn from the slice to the label. + * "spline" A curved line is drawn between the slice and its label. The line starts radially from the slice and then turns to the label. */ leaderLineType?: string; @@ -24301,8 +24953,8 @@ interface IgDoughnutChartSeries { * Gets or sets whether to use numeric or percent-based threshold value. * * Valid values: - * "number" - * "percent" + * "number" Data value is compared directly to the value of OthersCategoryThreshold. + * "percent" Data value is compared to OthersCategoryThreshold as a percentage of the total. */ othersCategoryType?: string; @@ -24327,7 +24979,7 @@ interface IgDoughnutChartSeries { formatLegendLabel?: any; /** - * Gets or sets the pixel amount, by which the labels are offset from the edge of the slices. + * Gets or sets the pixel amount by which the labels are offset from the edge of the slices. */ labelExtent?: number; @@ -24343,15 +24995,13 @@ interface IgDoughnutChartSeries { selectedStyle?: any; /** - * Gets or sets the Brushes property. - * The brushes property defines the palette from which automatically assigned slice brushes are selected. + * Gets or sets the palette of brushes to use for coloring the slices. * The value provided should be an array of css color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection. */ brushes?: any; /** - * Gets or sets the Outlines property. - * The Outlines property defines the palette from which automatically assigned slice outlines are selected. + * Gets or sets the palette of brushes to use for outlines on the slices. * The value provided should be an array of css color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection. */ outlines?: any; @@ -24614,6 +25264,13 @@ interface IgDoughnutChartMethods { */ destroy(): void; + /** + * Returns data source of the series. + * + * @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. * @@ -24628,11 +25285,6 @@ interface IgDoughnutChartMethods { */ getDataItem(index: Object): Object; - /** - * Get reference of actual data used by chart. - */ - getData(): any[]; - /** * Adds a new item to the data source and notifies the chart. * @@ -24675,7 +25327,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. + * 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. */ @@ -24683,7 +25335,7 @@ 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. + * 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. @@ -24693,7 +25345,7 @@ 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. + * 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. @@ -24724,9 +25376,9 @@ interface JQuery { igDoughnutChart(methodName: "exportVisualData"): Object; igDoughnutChart(methodName: "flush"): void; igDoughnutChart(methodName: "destroy"): void; + igDoughnutChart(methodName: "getData", series: string): Object; igDoughnutChart(methodName: "findIndexOfItem", item: Object): number; igDoughnutChart(methodName: "getDataItem", index: Object): Object; - igDoughnutChart(methodName: "getData"): any[]; igDoughnutChart(methodName: "addItem", item: Object): Object; igDoughnutChart(methodName: "insertItem", item: Object, index: number): Object; igDoughnutChart(methodName: "removeItem", index: number): Object; @@ -25822,7 +26474,7 @@ interface IgTextEditor { /** * Gets/Sets list of items which are used as a source for the drop-down list. - * Items in the list can be of type string, number or object. The items are directly rendered without any casting, or manipulation. + * Items in the list can be of type string. * */ listItems?: any[]; @@ -25922,13 +26574,13 @@ interface IgTextEditor { textMode?: string; /** - * Gets/Sets the ability of the editor to automatically change the hoverd item into the opened dropdown list to its oposide side. When the last item is reached and the spin down is clicked, the first item gets hovered and vice versa. This option has no effect there is no drop-down list. + * Gets/Sets the ability of the editor to automatically move the dropdown list selection item from one end to the opposite side. When the last item is reached and spin down is performed, the first item gets selected and vice versa. This option has no effect there is no drop-down list. * */ spinWrapAround?: boolean; /** - * Gets/Sets if the editor should only allow values set into the list of items. This validation is done only when the editor is blured, or enter key is pressed + * Gets/Sets if the editor should only allow values from the list of items. Matching is case-insensitive. * */ isLimitedToListValues?: boolean; @@ -26324,7 +26976,7 @@ interface IgTextEditorMethods { getSelectedListItem(): string; /** - * Gets the selected text from the editor in edit mode. This can be done on key event like keydown or keyup. This method can be used only when the editor is focused. If you call this method in display mode (The editor input is blured) the returned value will be an empty string. + * Gets the selected text from the editor in edit mode. This can be done inside key event handlers, like keydown or keyup. This method can be used only when the editor is focused. If you invoke this method in display mode, when the editor input is blurred, the returned value will be an empty string. */ getSelectedText(): string; @@ -26340,7 +26992,7 @@ 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. + * Note: The method raises [textChanged](ui.igtexteditor#events:textChanged) event. * * @param string The string to be inserted. */ @@ -26355,12 +27007,12 @@ interface IgTextEditorMethods { select(start: number, end: number): void; /** - * Hovers the previous item in the drop-down list if the list is opened. + * Selects the previous item from the drop-down list. */ spinUp(): void; /** - * Hovers the next item in the drop-down list if the list is opened. + * Selects the next item from the drop-down list. */ spinDown(): void; @@ -26441,7 +27093,7 @@ interface JQuery { interface IgNumericEditor { /** * Gets/Sets list of items which are used as a source for the drop-down list. - * Items in the list can be of type string, number or object. The items are directly rendered without any casting, or manipulation. + * Items in the list can be of type number. * */ listItems?: any[]; @@ -26456,6 +27108,7 @@ interface IgNumericEditor { * Gets/Sets the character, which is used as negative sign. * Note: This option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. + * Note: This option's value should not be equal to the value of [groupSeparator](ui.igNumericEditor#options:groupSeparator) or [decimalSeparator](ui.igNumericEditor#options:decimalSeparator) options. * */ negativeSign?: string; @@ -26472,6 +27125,7 @@ interface IgNumericEditor { * Gets/Sets the character, which is used as decimal separator. * Note: this option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. + * Note: This option's value should not be equal to the value of [groupSeparator](ui.igNumericEditor#options:groupSeparator) or [negativeSign](ui.igNumericEditor#options:negativeSign) options. * */ decimalSeparator?: string; @@ -26479,8 +27133,9 @@ interface IgNumericEditor { /** * Gets/Sets the character, which is used as separator for groups (like thousands). * That option has effect only in display mode(no focus). - * Note: this option has priority over possible regional settings. + * Note: This option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. + * Note: This option's value should not be equal to the value of [decimalSeparator](ui.igNumericEditor#options:decimalSeparator) or [negativeSign](ui.igNumericEditor#options:negativeSign) options. * */ groupSeparator?: string; @@ -26491,32 +27146,42 @@ interface IgNumericEditor { * If the sum of all values in array is smaller than the length of integer part, then the last item in array is used for all following groups. * Count of groups starts from the decimal point (from right to left). * That option has effect only in display mode(no focus). - * Note: this option has priority over possible regional settings. + * Note: The numbers in the array must be positive integers. + * Note: This option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. * */ groups?: any[]; /** - * Gets/Sets the maximum number of decimal places which are used in display mode(no focus). + * Gets/Sets the maximum number of decimal places supported by the editor. * Note: this option has priority over possible regional settings. * Note: In case of min decimals value higher than max decimals - max decimals are equaled to min decimals property. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. + * Note: This option supports values between 0 and 15, when dataMode is 'double' (default) and values between 0 and 7 in 'float' mode. * */ maxDecimals?: number; /** - * Gets/Sets the minimum number of decimal places which are used in display (no focus) state. + * Gets/Sets the minimum number of decimal places supported by the editor. * If number of digits in fractional part of number is less than the value of this option, then the "0" characters are used to fill missing digits. * Note: This option has priority over possible regional settings. * Note: In case of min decimals value higher than max decimals - max decimals are equaled to min decimals property. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. - * Note: This option supports values below or equal to 20. + * Note: This option supports values between 0 and 15, when dataMode is 'double' (default) and values between 0 and 7 in 'float' mode. * */ minDecimals?: number; + /** + * Gets/Sets whether the last decimal place will be rounded, when the maxDecimal option is defined and applied. + * For example if the initial editor value is set to 123.4567, maxDecimals option is set to 3 and roundDecimals is enabled, + * then editor will round the value and will display it as 123.457. If roundDecimals is disabled then editor value will be truncated to 123.456. + * + */ + roundDecimals?: boolean; + /** * Gets/Sets the horizontal alignment of the text in the editor. * @@ -26575,7 +27240,7 @@ interface IgNumericEditor { spinDelta?: number; /** - * Gets/Sets support for scientific format in edit mode. + * Gets/Sets support for scientific format. * 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. * @@ -26592,10 +27257,17 @@ interface IgNumericEditor { /** * Gets/Set the ability of the editor to automatically set value in the editor to the opposite side of the limit, when the spin action reaches minimum or maximum limit. + * This applies to [minValue](ui.%%WidgetNameLowered%%#options:minValue) and [maxValue](ui.%%WidgetNameLowered%%#options:maxValue) or cycling through list items if [isLimitedToListValues](ui.%%WidgetNameLowered%%#options:isLimitedToListValues) is enabled. * */ spinWrapAround?: boolean; + /** + * Gets/Sets if the editor should only allow values from the list of items. Enabling this also causes spin actions to cycle through list items instead. + * + */ + isLimitedToListValues?: boolean; + /** * Removed from numeric editor options */ @@ -26699,12 +27371,6 @@ interface IgNumericEditor { */ selectionOnFocus?: string; - /** - * Gets/Sets if the editor should only allow values set into the list of items. This validation is done only when the editor is blured, or enter key is pressed - * - */ - isLimitedToListValues?: boolean; - /** * Gets/Sets if the editor should revert it's value to the previously valid value in case the value on blur, or enter key is not valid. If the opiton is set to false, editor calls clear functionality. * @@ -26894,26 +27560,26 @@ interface IgNumericEditorMethods { getSelectionEnd(): void; /** - * Increments value in editor according to the parameter. + * 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. */ spinUp(delta?: number): void; /** - * Decrements value in editor according to the parameter. + * 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. */ spinDown(delta?: number): void; /** - * Moves the hovered index to the item that appears above the current one in the list. + * This method is deprecated in favor of [spinUp](ui.%%WidgetNameLowered%%#options:spinUp). */ selectListIndexUp(): void; /** - * Moves the hovered index to the item that appears above the current one in the list. + * This method is deprecated in favor of [spinDown](ui.%%WidgetNameLowered%%#options:spinDown). */ selectListIndexDown(): void; @@ -26971,7 +27637,7 @@ 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. + * Note: The method raises [textChanged](ui.igtexteditor#events:textChanged) event. * * @param string The string to be inserted. */ @@ -27016,7 +27682,7 @@ interface IgCurrencyEditor { /** * Gets/Sets list of items which are used as a source for the drop-down list. - * Items in the list can be of type string, number or object. The items are directly rendered without any casting, or manipulation. + * Items in the list can be of type number. * */ listItems?: any[]; @@ -27031,6 +27697,7 @@ interface IgCurrencyEditor { * Gets/Sets the character, which is used as negative sign. * Note: This option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. + * Note: This option's value should not be equal to the value of [groupSeparator](ui.igNumericEditor#options:groupSeparator) or [decimalSeparator](ui.igNumericEditor#options:decimalSeparator) options. * */ negativeSign?: string; @@ -27047,6 +27714,7 @@ interface IgCurrencyEditor { * Gets/Sets the character, which is used as decimal separator. * Note: this option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. + * Note: This option's value should not be equal to the value of [groupSeparator](ui.igNumericEditor#options:groupSeparator) or [negativeSign](ui.igNumericEditor#options:negativeSign) options. * */ decimalSeparator?: string; @@ -27054,8 +27722,9 @@ interface IgCurrencyEditor { /** * Gets/Sets the character, which is used as separator for groups (like thousands). * That option has effect only in display mode(no focus). - * Note: this option has priority over possible regional settings. + * Note: This option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. + * Note: This option's value should not be equal to the value of [decimalSeparator](ui.igNumericEditor#options:decimalSeparator) or [negativeSign](ui.igNumericEditor#options:negativeSign) options. * */ groupSeparator?: string; @@ -27066,32 +27735,42 @@ interface IgCurrencyEditor { * If the sum of all values in array is smaller than the length of integer part, then the last item in array is used for all following groups. * Count of groups starts from the decimal point (from right to left). * That option has effect only in display mode(no focus). - * Note: this option has priority over possible regional settings. + * Note: The numbers in the array must be positive integers. + * Note: This option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. * */ groups?: any[]; /** - * Gets/Sets the maximum number of decimal places which are used in display mode(no focus). + * Gets/Sets the maximum number of decimal places supported by the editor. * Note: this option has priority over possible regional settings. * Note: In case of min decimals value higher than max decimals - max decimals are equaled to min decimals property. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. + * Note: This option supports values between 0 and 15, when dataMode is 'double' (default) and values between 0 and 7 in 'float' mode. * */ maxDecimals?: number; /** - * Gets/Sets the minimum number of decimal places which are used in display (no focus) state. + * Gets/Sets the minimum number of decimal places supported by the editor. * If number of digits in fractional part of number is less than the value of this option, then the "0" characters are used to fill missing digits. * Note: This option has priority over possible regional settings. * Note: In case of min decimals value higher than max decimals - max decimals are equaled to min decimals property. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. - * Note: This option supports values below or equal to 20. + * Note: This option supports values between 0 and 15, when dataMode is 'double' (default) and values between 0 and 7 in 'float' mode. * */ minDecimals?: number; + /** + * Gets/Sets whether the last decimal place will be rounded, when the maxDecimal option is defined and applied. + * For example if the initial editor value is set to 123.4567, maxDecimals option is set to 3 and roundDecimals is enabled, + * then editor will round the value and will display it as 123.457. If roundDecimals is disabled then editor value will be truncated to 123.456. + * + */ + roundDecimals?: boolean; + /** * Gets/Sets the horizontal alignment of the text in the editor. * @@ -27150,7 +27829,7 @@ interface IgCurrencyEditor { spinDelta?: number; /** - * Gets/Sets support for scientific format in edit mode. + * Gets/Sets support for scientific format. * 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. * @@ -27167,10 +27846,17 @@ interface IgCurrencyEditor { /** * Gets/Set the ability of the editor to automatically set value in the editor to the opposite side of the limit, when the spin action reaches minimum or maximum limit. + * This applies to [minValue](ui.%%WidgetNameLowered%%#options:minValue) and [maxValue](ui.%%WidgetNameLowered%%#options:maxValue) or cycling through list items if [isLimitedToListValues](ui.%%WidgetNameLowered%%#options:isLimitedToListValues) is enabled. * */ spinWrapAround?: boolean; + /** + * Gets/Sets if the editor should only allow values from the list of items. Enabling this also causes spin actions to cycle through list items instead. + * + */ + isLimitedToListValues?: boolean; + /** * Removed from numeric editor options */ @@ -27274,12 +27960,6 @@ interface IgCurrencyEditor { */ selectionOnFocus?: string; - /** - * Gets/Sets if the editor should only allow values set into the list of items. This validation is done only when the editor is blured, or enter key is pressed - * - */ - isLimitedToListValues?: boolean; - /** * Gets/Sets if the editor should revert it's value to the previously valid value in case the value on blur, or enter key is not valid. If the opiton is set to false, editor calls clear functionality. * @@ -27410,26 +28090,26 @@ interface IgCurrencyEditorMethods { getSelectionEnd(): void; /** - * Increments value in editor according to the parameter. + * 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. */ spinUp(delta?: number): void; /** - * Decrements value in editor according to the parameter. + * 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. */ spinDown(delta?: number): void; /** - * Moves the hovered index to the item that appears above the current one in the list. + * This method is deprecated in favor of [spinUp](ui.%%WidgetNameLowered%%#options:spinUp). */ selectListIndexUp(): void; /** - * Moves the hovered index to the item that appears above the current one in the list. + * This method is deprecated in favor of [spinDown](ui.%%WidgetNameLowered%%#options:spinDown). */ selectListIndexDown(): void; @@ -27497,7 +28177,7 @@ interface IgPercentEditor { /** * Gets/Sets list of items which are used as a source for the drop-down list. - * Items in the list can be of type string, number or object. The items are directly rendered without any casting, or manipulation. + * Items in the list can be of type number. * */ listItems?: any[]; @@ -27512,6 +28192,7 @@ interface IgPercentEditor { * Gets/Sets the character, which is used as negative sign. * Note: This option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. + * Note: This option's value should not be equal to the value of [groupSeparator](ui.igNumericEditor#options:groupSeparator) or [decimalSeparator](ui.igNumericEditor#options:decimalSeparator) options. * */ negativeSign?: string; @@ -27528,6 +28209,7 @@ interface IgPercentEditor { * Gets/Sets the character, which is used as decimal separator. * Note: this option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. + * Note: This option's value should not be equal to the value of [groupSeparator](ui.igNumericEditor#options:groupSeparator) or [negativeSign](ui.igNumericEditor#options:negativeSign) options. * */ decimalSeparator?: string; @@ -27535,8 +28217,9 @@ interface IgPercentEditor { /** * Gets/Sets the character, which is used as separator for groups (like thousands). * That option has effect only in display mode(no focus). - * Note: this option has priority over possible regional settings. + * Note: This option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. + * Note: This option's value should not be equal to the value of [decimalSeparator](ui.igNumericEditor#options:decimalSeparator) or [negativeSign](ui.igNumericEditor#options:negativeSign) options. * */ groupSeparator?: string; @@ -27547,32 +28230,42 @@ interface IgPercentEditor { * If the sum of all values in array is smaller than the length of integer part, then the last item in array is used for all following groups. * Count of groups starts from the decimal point (from right to left). * That option has effect only in display mode(no focus). - * Note: this option has priority over possible regional settings. + * Note: The numbers in the array must be positive integers. + * Note: This option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. * */ groups?: any[]; /** - * Gets/Sets the maximum number of decimal places which are used in display mode(no focus). + * Gets/Sets the maximum number of decimal places supported by the editor. * Note: this option has priority over possible regional settings. * Note: In case of min decimals value higher than max decimals - max decimals are equaled to min decimals property. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. + * Note: This option supports values between 0 and 15, when dataMode is 'double' (default) and values between 0 and 7 in 'float' mode. * */ maxDecimals?: number; /** - * Gets/Sets the minimum number of decimal places which are used in display (no focus) state. + * Gets/Sets the minimum number of decimal places supported by the editor. * If number of digits in fractional part of number is less than the value of this option, then the "0" characters are used to fill missing digits. * Note: This option has priority over possible regional settings. * Note: In case of min decimals value higher than max decimals - max decimals are equaled to min decimals property. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. - * Note: This option supports values below or equal to 20. + * Note: This option supports values between 0 and 15, when dataMode is 'double' (default) and values between 0 and 7 in 'float' mode. * */ minDecimals?: number; + /** + * Gets/Sets whether the last decimal place will be rounded, when the maxDecimal option is defined and applied. + * For example if the initial editor value is set to 123.4567, maxDecimals option is set to 3 and roundDecimals is enabled, + * then editor will round the value and will display it as 123.457. If roundDecimals is disabled then editor value will be truncated to 123.456. + * + */ + roundDecimals?: boolean; + /** * Gets/Sets the horizontal alignment of the text in the editor. * @@ -27604,7 +28297,7 @@ interface IgPercentEditor { allowNullValue?: boolean; /** - * Gets/Sets support for scientific format in edit mode. + * Gets/Sets support for scientific format. * 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. * @@ -27621,10 +28314,17 @@ interface IgPercentEditor { /** * Gets/Set the ability of the editor to automatically set value in the editor to the opposite side of the limit, when the spin action reaches minimum or maximum limit. + * This applies to [minValue](ui.%%WidgetNameLowered%%#options:minValue) and [maxValue](ui.%%WidgetNameLowered%%#options:maxValue) or cycling through list items if [isLimitedToListValues](ui.%%WidgetNameLowered%%#options:isLimitedToListValues) is enabled. * */ spinWrapAround?: boolean; + /** + * Gets/Sets if the editor should only allow values from the list of items. Enabling this also causes spin actions to cycle through list items instead. + * + */ + isLimitedToListValues?: boolean; + /** * Removed from numeric editor options */ @@ -27728,12 +28428,6 @@ interface IgPercentEditor { */ selectionOnFocus?: string; - /** - * Gets/Sets if the editor should only allow values set into the list of items. This validation is done only when the editor is blured, or enter key is pressed - * - */ - isLimitedToListValues?: boolean; - /** * Gets/Sets if the editor should revert it's value to the previously valid value in case the value on blur, or enter key is not valid. If the opiton is set to false, editor calls clear functionality. * @@ -27841,7 +28535,7 @@ interface IgPercentEditor { 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. + * Note: the method raises the [textChanged](ui.igpercenteditor#events:textChanged) event. * * @param string The string to be inserted. */ @@ -27872,26 +28566,26 @@ interface IgPercentEditorMethods { getSelectionEnd(): void; /** - * Increments value in editor according to the parameter. + * 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. */ spinUp(delta?: number): void; /** - * Decrements value in editor according to the parameter. + * 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. */ spinDown(delta?: number): void; /** - * Moves the hovered index to the item that appears above the current one in the list. + * This method is deprecated in favor of [spinUp](ui.%%WidgetNameLowered%%#options:spinUp). */ selectListIndexUp(): void; /** - * Moves the hovered index to the item that appears above the current one in the list. + * This method is deprecated in favor of [spinDown](ui.%%WidgetNameLowered%%#options:spinDown). */ selectListIndexDown(): void; @@ -27914,7 +28608,9 @@ interface IgMaskEditor { /** * Gets visibility of the clear button. That option can be set only on initialization. * - * clear A button to clear the value is located on the right side of the editor. + * + * Valid values: + * "clear" A button to clear the value is located on the right side of the editor. */ buttonType?: string; @@ -27941,7 +28637,7 @@ interface IgMaskEditor { inputMask?: string; /** - * Gets/Sets type of value returned by the get of [value](ui.igmaskeditor#methods:value) method. That also affects functionality of the set value(val) method and the copy/paste operations of browser. + * 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. * * * Valid values: @@ -27961,7 +28657,7 @@ interface IgMaskEditor { unfilledCharsPrompt?: string; /** - * Gets/Sets character which is used as replacement of not-filled required position in mask when editor is in display mode (not focused). Note that this option is visible, only when the [revertIfNotValid](ui.igmaskeditor#options:revertIfNotValid) option is set to false. + * Gets/Sets character which is used as replacement of not-filled required position in mask when editor is in display mode (not focused). * */ padChar?: string; @@ -28247,7 +28943,7 @@ interface IgMaskEditorMethods { clearButton(): string; /** - * Gets the selected text from the editor in edit mode. This can be done on key event like keydown or keyup. This method can be used only when the editor is focused. If you call this method in display mode (The editor input is blured) the returned value will be an empty string. + * Gets the selected text from the editor in edit mode. This can be done inside key event handlers, like keydown or keyup. This method can be used only when the editor is focused. If you invoke this method in display mode, when the editor input is blurred, the returned value will be an empty string. */ getSelectedText(): string; @@ -28263,7 +28959,7 @@ 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. + * Note: The method raises [textChanged](ui.igtexteditor#events:textChanged) event. * * @param string The string to be inserted. */ @@ -28284,21 +28980,21 @@ interface JQuery { interface IgDateEditor { /** * Gets/Sets the value of the editor. Date object can be set as value. String can be set and the editor will pass it to the Date object constructor and use the corresponding Date object as the value. MVC date format can be used too. - * Note! This option doesn't use the displayInputFormat to extract the date. + * Note! This option doesn't use the dateInputFormat to extract the date. * */ value?: Object; /** * Gets the minimum value which can be entered in editor by user. 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. - * Note! This option doesn't use the displayInputFormat to extract the date. + * Note! This option doesn't use the dateInputFormat to extract the date. * */ minValue?: Object; /** * Gets the maximum value which can be entered in editor by user. 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. - * Note! This option doesn't use the displayInputFormat to extract the date. + * Note! This option doesn't use the dateInputFormat to extract the date. * */ maxValue?: Object; @@ -28377,17 +29073,27 @@ interface IgDateEditor { dateInputFormat?: string; /** - * Gets/Sets the value type returned by the get of value() method. That also affects functionality of the set value(val) method and the copy/paste operations of browser. - * Note: That is used as default. + * Gets the value type returned by the get of value() method and option. Also affects how the value is stored for form submit. + * The [enableUTCDates](ui.%%WidgetNameLowered%%#options:enableUTCDates) option can be used to output an UTC ISO string instead. + * For example 10:00 AM from a client with local offset of 5 hours ahead of GMT will be serialized as: + * "2016-11-11T10:00:00+05:00" * * * Valid values: - * "date" The Date object is used. When that mode is set the value send to the server on submit is string value converter from the javascript Date object using "toISOString" method. - * "displayModeText" The String object is used and the "text" in display mode (no focus) format (pattern). - * "editModeText" The String object is used and the "text" in edit mode (focus) format (pattern). + * "date" The value method returns a Date object. When this mode is set the value sent to the server on submit is serialized as ISO 8061 string with local time and zone values by default. + * "displayModeText" The "text" in display mode (no focus) format (pattern) is used to be send to the server and is returned from the value() method (returns a string object). + * "editModeText" The "text" in edit mode (focus) format (pattern) is used to be send to the server and is returned from the value() method (returns a string object). */ dataMode?: string; + /** + * Gets/Sets time zone offset from UTC, in minutes. The client date values are displayed with this offset instead of the local one. + * Note: It is recommended that this option is used with an UTC value (e.g. "2016-11-03T14:08:08.504Z") so the outcome is consistent. + * Values with ambiguous time zone could map to unpredictable times depending on the user agent local zone. + * + */ + displayTimeOffset?: any; + /** * Gets visibility of the spin and clear buttons. That option can be set only on initialization. Combinations like 'spin,clear' are supported too. * @@ -28399,7 +29105,10 @@ interface IgDateEditor { buttonType?: string; /** - * Gets/Sets delta-value which is used to increment or decrement value in editor on spin events. If value is set to negative value an exception is thrown. Non integer value is supported only for dataMode double and float. + * Gets/Sets delta-value which is used to increment or decrement the editor date on spin actions. + * When not editing (focused) the delta is applied on the day if available in the input mask or the lowest available period. + * When in edit mode the time period, where the cursor is positioned, is incremented or decremented with the defined delta value. + * The value can be only a positive integer number, otherwise it will be set as 1, or in the cases with double or float the the whole part will be taken. * */ spinDelta?: number; @@ -28413,14 +29122,8 @@ interface IgDateEditor { limitSpinToCurrentField?: boolean; /** - * Gets/Sets formatting of the dates as UTC. - * That option is supported only when dataMode option is 'date' and Date objects are used to get/set value of editor. - * Notes: - * That option affects only functionality of get/set value method and the Date-value, which was set on initialization. - * When application uses the set-value, then internal Date-value and displayed-text is incremented by TimezoneOffset. - * When application uses the get-value, then editor returns internal Date-value decremented by TimezoneOffset. - * When that option is modified after initialization, then displayed text and internal Date-value are not affected. - * It is not recommended to change that option without resetting Date-value. + * Enables/Disables serializing client date as UTC ISO 8061 string instead of using the local time and zone values. + * The option is only applied in "date" [dataMode](ui.%%WidgetNameLowered%%#options:dataMode). * */ enableUTCDates?: boolean; @@ -28443,7 +29146,7 @@ interface IgDateEditor { * 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 * */ - nullValue?: string|number; + nullValue?: string|number|Date; /** * This option is inherited from a parent widget and it's not applicable for igDateEditor @@ -28711,19 +29414,21 @@ interface IgDateEditorMethods { /** * Gets/Sets editor value. * - * Note! This option doesn't use the displayInputFormat to extract the date + * 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"/). */ value(newValue?: Object): Object; /** - * Gets selected date. + * Gets selected date as a date object. This method can be used when dataMode is set as either displayModeText or editModeText. + * In such cases the value() method will not return date object and getSelectedDate() can be used to replace that functionality. */ getSelectedDate(): Object; /** - * Sets selected date. + * Sets selected date. This method can be used when dataMode is set as either displayModeText or editModeText. + * In such cases the value() cannot accept a date object as a new value and getSelectedDate() can be used to replace that functionality. * * @param date */ @@ -28854,21 +29559,21 @@ interface IgDatePicker { /** * Gets/Sets the value of the editor. Date object can be set as value. String can be set and the editor will pass it to the Date object constructor and use the corresponding Date object as the value. MVC date format can be used too. - * Note! This option doesn't use the displayInputFormat to extract the date. + * Note! This option doesn't use the dateInputFormat to extract the date. * */ value?: Object; /** * Gets the minimum value which can be entered in editor by user. 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. - * Note! This option doesn't use the displayInputFormat to extract the date. + * Note! This option doesn't use the dateInputFormat to extract the date. * */ minValue?: Object; /** * Gets the maximum value which can be entered in editor by user. 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. - * Note! This option doesn't use the displayInputFormat to extract the date. + * Note! This option doesn't use the dateInputFormat to extract the date. * */ maxValue?: Object; @@ -28947,19 +29652,32 @@ interface IgDatePicker { dateInputFormat?: string; /** - * Gets/Sets the value type returned by the get of value() method. That also affects functionality of the set value(val) method and the copy/paste operations of browser. - * Note: That is used as default. + * Gets the value type returned by the get of value() method and option. Also affects how the value is stored for form submit. + * The [enableUTCDates](ui.%%WidgetNameLowered%%#options:enableUTCDates) option can be used to output an UTC ISO string instead. + * For example 10:00 AM from a client with local offset of 5 hours ahead of GMT will be serialized as: + * "2016-11-11T10:00:00+05:00" * * * Valid values: - * "date" The Date object is used. When that mode is set the value send to the server on submit is string value converter from the javascript Date object using "toISOString" method. - * "displayModeText" The String object is used and the "text" in display mode (no focus) format (pattern). - * "editModeText" The String object is used and the "text" in edit mode (focus) format (pattern). + * "date" The value method returns a Date object. When this mode is set the value sent to the server on submit is serialized as ISO 8061 string with local time and zone values by default. + * "displayModeText" The "text" in display mode (no focus) format (pattern) is used to be send to the server and is returned from the value() method (returns a string object). + * "editModeText" The "text" in edit mode (focus) format (pattern) is used to be send to the server and is returned from the value() method (returns a string object). */ dataMode?: string; /** - * Gets/Sets delta-value which is used to increment or decrement value in editor on spin events. If value is set to negative value an exception is thrown. Non integer value is supported only for dataMode double and float. + * Gets/Sets time zone offset from UTC, in minutes. The client date values are displayed with this offset instead of the local one. + * Note: It is recommended that this option is used with an UTC value (e.g. "2016-11-03T14:08:08.504Z") so the outcome is consistent. + * Values with ambiguous time zone could map to unpredictable times depending on the user agent local zone. + * + */ + displayTimeOffset?: any; + + /** + * Gets/Sets delta-value which is used to increment or decrement the editor date on spin actions. + * When not editing (focused) the delta is applied on the day if available in the input mask or the lowest available period. + * When in edit mode the time period, where the cursor is positioned, is incremented or decremented with the defined delta value. + * The value can be only a positive integer number, otherwise it will be set as 1, or in the cases with double or float the the whole part will be taken. * */ spinDelta?: number; @@ -28973,14 +29691,8 @@ interface IgDatePicker { limitSpinToCurrentField?: boolean; /** - * Gets/Sets formatting of the dates as UTC. - * That option is supported only when dataMode option is 'date' and Date objects are used to get/set value of editor. - * Notes: - * That option affects only functionality of get/set value method and the Date-value, which was set on initialization. - * When application uses the set-value, then internal Date-value and displayed-text is incremented by TimezoneOffset. - * When application uses the get-value, then editor returns internal Date-value decremented by TimezoneOffset. - * When that option is modified after initialization, then displayed text and internal Date-value are not affected. - * It is not recommended to change that option without resetting Date-value. + * Enables/Disables serializing client date as UTC ISO 8061 string instead of using the local time and zone values. + * The option is only applied in "date" [dataMode](ui.%%WidgetNameLowered%%#options:dataMode). * */ enableUTCDates?: boolean; @@ -29003,7 +29715,7 @@ interface IgDatePicker { * 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 * */ - nullValue?: string|number; + nullValue?: string|number|Date; /** * This option is inherited from a parent widget and it's not applicable for igDateEditor @@ -29291,19 +30003,21 @@ interface IgDatePickerMethods { /** * Gets/Sets editor value. * - * Note! This option doesn't use the displayInputFormat to extract the date + * 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"/). */ value(newValue?: Object): Object; /** - * Gets selected date. + * Gets selected date as a date object. This method can be used when dataMode is set as either displayModeText or editModeText. + * In such cases the value() method will not return date object and getSelectedDate() can be used to replace that functionality. */ getSelectedDate(): Object; /** - * Sets selected date. + * Sets selected date. This method can be used when dataMode is set as either displayModeText or editModeText. + * In such cases the value() cannot accept a date object as a new value and getSelectedDate() can be used to replace that functionality. * * @param date */ @@ -29573,10 +30287,10 @@ interface IgCheckboxEditorMethods { /** * Gets/Sets Current checked state/Value of the igCheckboxEditor that will be submitted by the HTML form. - * 1. If the [value](ui.igcheckboxeditor#options:value) option IS NOT defined, then 'value' method will match the checked state of the editor. - * This option is used when the checkbox is intended to operate as a Boolean editor. In that case the return type is bool. - * 2. If the [value](ui.igcheckboxeditor#options:value) option IS defined, then 'value' method will return the value that will be submitted when the editor is checked and the form is submitted. - * To get checked state regardless of the 'value' option, use $(".selector").igCheckboxEditor("option", "checked"); + * 1. If the [value](ui.igcheckboxeditor#options:value) option IS NOT defined, then 'value' method will match the checked state of the editor. + * This option is used when the checkbox is intended to operate as a Boolean editor. In that case the return type is bool. + * 2. If the [value](ui.igcheckboxeditor#options:value) option IS defined, then 'value' method will return the value that will be submitted when the editor is checked and the form is submitted. + * To get checked state regardless of the 'value' option, use $(".selector").igCheckboxEditor("option", "checked"); * * @param newValue */ @@ -30149,14 +30863,14 @@ interface JQuery { /** * Gets/Sets list of items which are used as a source for the drop-down list. - * Items in the list can be of type string, number or object. The items are directly rendered without any casting, or manipulation. + * Items in the list can be of type string. * */ igTextEditor(optionLiteral: 'option', optionName: "listItems"): any[]; /** * /Sets list of items which are used as a source for the drop-down list. - * Items in the list can be of type string, number or object. The items are directly rendered without any casting, or manipulation. + * Items in the list can be of type string. * * * @optionValue New value to be set. @@ -30342,13 +31056,13 @@ interface JQuery { igTextEditor(optionLiteral: 'option', optionName: "textMode", optionValue: string): void; /** - * Gets/Sets the ability of the editor to automatically change the hoverd item into the opened dropdown list to its oposide side. When the last item is reached and the spin down is clicked, the first item gets hovered and vice versa. This option has no effect there is no drop-down list. + * Gets/Sets the ability of the editor to automatically move the dropdown list selection item from one end to the opposite side. When the last item is reached and spin down is performed, the first item gets selected and vice versa. This option has no effect there is no drop-down list. * */ igTextEditor(optionLiteral: 'option', optionName: "spinWrapAround"): boolean; /** - * /Sets the ability of the editor to automatically change the hoverd item into the opened dropdown list to its oposide side. When the last item is reached and the spin down is clicked, the first item gets hovered and vice versa. This option has no effect there is no drop-down list. + * /Sets the ability of the editor to automatically move the dropdown list selection item from one end to the opposite side. When the last item is reached and spin down is performed, the first item gets selected and vice versa. This option has no effect there is no drop-down list. * * * @optionValue New value to be set. @@ -30356,13 +31070,13 @@ interface JQuery { igTextEditor(optionLiteral: 'option', optionName: "spinWrapAround", optionValue: boolean): void; /** - * Gets/Sets if the editor should only allow values set into the list of items. This validation is done only when the editor is blured, or enter key is pressed + * Gets/Sets if the editor should only allow values from the list of items. Matching is case-insensitive. * */ igTextEditor(optionLiteral: 'option', optionName: "isLimitedToListValues"): boolean; /** - * /Sets if the editor should only allow values set into the list of items. This validation is done only when the editor is blured, or enter key is pressed + * /Sets if the editor should only allow values from the list of items. Matching is case-insensitive. * * * @optionValue New value to be set. @@ -31117,14 +31831,14 @@ interface JQuery { /** * Gets/Sets list of items which are used as a source for the drop-down list. - * Items in the list can be of type string, number or object. The items are directly rendered without any casting, or manipulation. + * Items in the list can be of type number. * */ igNumericEditor(optionLiteral: 'option', optionName: "listItems"): any[]; /** * /Sets list of items which are used as a source for the drop-down list. - * Items in the list can be of type string, number or object. The items are directly rendered without any casting, or manipulation. + * Items in the list can be of type number. * * * @optionValue New value to be set. @@ -31149,6 +31863,7 @@ interface JQuery { * Gets/Sets the character, which is used as negative sign. * Note: This option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. + * Note: This option's value should not be equal to the value of [groupSeparator](ui.igNumericEditor#options:groupSeparator) or [decimalSeparator](ui.igNumericEditor#options:decimalSeparator) options. * */ igNumericEditor(optionLiteral: 'option', optionName: "negativeSign"): string; @@ -31157,6 +31872,7 @@ interface JQuery { * /Sets the character, which is used as negative sign. * Note: This option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. + * Note: This option's value should not be equal to the value of [groupSeparator](ui.igNumericEditor#options:groupSeparator) or [decimalSeparator](ui.igNumericEditor#options:decimalSeparator) options. * * * @optionValue New value to be set. @@ -31185,6 +31901,7 @@ interface JQuery { * Gets/Sets the character, which is used as decimal separator. * Note: this option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. + * Note: This option's value should not be equal to the value of [groupSeparator](ui.igNumericEditor#options:groupSeparator) or [negativeSign](ui.igNumericEditor#options:negativeSign) options. * */ igNumericEditor(optionLiteral: 'option', optionName: "decimalSeparator"): string; @@ -31193,6 +31910,7 @@ interface JQuery { * /Sets the character, which is used as decimal separator. * Note: this option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. + * Note: This option's value should not be equal to the value of [groupSeparator](ui.igNumericEditor#options:groupSeparator) or [negativeSign](ui.igNumericEditor#options:negativeSign) options. * * * @optionValue New value to be set. @@ -31202,8 +31920,9 @@ interface JQuery { /** * Gets/Sets the character, which is used as separator for groups (like thousands). * That option has effect only in display mode(no focus). - * Note: this option has priority over possible regional settings. + * Note: This option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. + * Note: This option's value should not be equal to the value of [decimalSeparator](ui.igNumericEditor#options:decimalSeparator) or [negativeSign](ui.igNumericEditor#options:negativeSign) options. * */ igNumericEditor(optionLiteral: 'option', optionName: "groupSeparator"): string; @@ -31211,8 +31930,9 @@ interface JQuery { /** * /Sets the character, which is used as separator for groups (like thousands). * That option has effect only in display mode(no focus). - * Note: this option has priority over possible regional settings. + * Note: This option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. + * Note: This option's value should not be equal to the value of [decimalSeparator](ui.igNumericEditor#options:decimalSeparator) or [negativeSign](ui.igNumericEditor#options:negativeSign) options. * * * @optionValue New value to be set. @@ -31225,7 +31945,8 @@ interface JQuery { * If the sum of all values in array is smaller than the length of integer part, then the last item in array is used for all following groups. * Count of groups starts from the decimal point (from right to left). * That option has effect only in display mode(no focus). - * Note: this option has priority over possible regional settings. + * Note: The numbers in the array must be positive integers. + * Note: This option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. * */ @@ -31237,7 +31958,8 @@ interface JQuery { * If the sum of all values in array is smaller than the length of integer part, then the last item in array is used for all following groups. * Count of groups starts from the decimal point (from right to left). * That option has effect only in display mode(no focus). - * Note: this option has priority over possible regional settings. + * Note: The numbers in the array must be positive integers. + * Note: This option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. * * @@ -31246,19 +31968,21 @@ interface JQuery { igNumericEditor(optionLiteral: 'option', optionName: "groups", optionValue: any[]): void; /** - * Gets/Sets the maximum number of decimal places which are used in display mode(no focus). + * Gets/Sets the maximum number of decimal places supported by the editor. * Note: this option has priority over possible regional settings. * Note: In case of min decimals value higher than max decimals - max decimals are equaled to min decimals property. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. + * Note: This option supports values between 0 and 15, when dataMode is 'double' (default) and values between 0 and 7 in 'float' mode. * */ igNumericEditor(optionLiteral: 'option', optionName: "maxDecimals"): number; /** - * /Sets the maximum number of decimal places which are used in display mode(no focus). + * /Sets the maximum number of decimal places supported by the editor. * Note: this option has priority over possible regional settings. * Note: In case of min decimals value higher than max decimals - max decimals are equaled to min decimals property. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. + * Note: This option supports values between 0 and 15, when dataMode is 'double' (default) and values between 0 and 7 in 'float' mode. * * * @optionValue New value to be set. @@ -31266,29 +31990,47 @@ interface JQuery { igNumericEditor(optionLiteral: 'option', optionName: "maxDecimals", optionValue: number): void; /** - * Gets/Sets the minimum number of decimal places which are used in display (no focus) state. + * Gets/Sets the minimum number of decimal places supported by the editor. * If number of digits in fractional part of number is less than the value of this option, then the "0" characters are used to fill missing digits. * Note: This option has priority over possible regional settings. * Note: In case of min decimals value higher than max decimals - max decimals are equaled to min decimals property. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. - * Note: This option supports values below or equal to 20. + * Note: This option supports values between 0 and 15, when dataMode is 'double' (default) and values between 0 and 7 in 'float' mode. * */ igNumericEditor(optionLiteral: 'option', optionName: "minDecimals"): number; /** - * /Sets the minimum number of decimal places which are used in display (no focus) state. + * /Sets the minimum number of decimal places supported by the editor. * If number of digits in fractional part of number is less than the value of this option, then the "0" characters are used to fill missing digits. * Note: This option has priority over possible regional settings. * Note: In case of min decimals value higher than max decimals - max decimals are equaled to min decimals property. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. - * Note: This option supports values below or equal to 20. + * Note: This option supports values between 0 and 15, when dataMode is 'double' (default) and values between 0 and 7 in 'float' mode. * * * @optionValue New value to be set. */ igNumericEditor(optionLiteral: 'option', optionName: "minDecimals", optionValue: number): void; + /** + * Gets/Sets whether the last decimal place will be rounded, when the maxDecimal option is defined and applied. + * For example if the initial editor value is set to 123.4567, maxDecimals option is set to 3 and roundDecimals is enabled, + * then editor will round the value and will display it as 123.457. If roundDecimals is disabled then editor value will be truncated to 123.456. + * + */ + igNumericEditor(optionLiteral: 'option', optionName: "roundDecimals"): boolean; + + /** + * /Sets whether the last decimal place will be rounded, when the maxDecimal option is defined and applied. + * For example if the initial editor value is set to 123.4567, maxDecimals option is set to 3 and roundDecimals is enabled, + * then editor will round the value and will display it as 123.457. If roundDecimals is disabled then editor value will be truncated to 123.456. + * + * + * @optionValue New value to be set. + */ + igNumericEditor(optionLiteral: 'option', optionName: "roundDecimals", optionValue: boolean): void; + /** * Gets/Sets the horizontal alignment of the text in the editor. * @@ -31382,7 +32124,7 @@ interface JQuery { igNumericEditor(optionLiteral: 'option', optionName: "spinDelta", optionValue: number): void; /** - * Gets/Sets support for scientific format in edit mode. + * Gets/Sets support for scientific format. * 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. * @@ -31391,7 +32133,7 @@ interface JQuery { igNumericEditor(optionLiteral: 'option', optionName: "scientificFormat"): string; /** - * /Sets support for scientific format in edit mode. + * /Sets support for scientific format. * 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. * @@ -31403,18 +32145,34 @@ interface JQuery { /** * Gets/Set the ability of the editor to automatically set value in the editor to the opposite side of the limit, when the spin action reaches minimum or maximum limit. + * This applies to [minValue](ui.%%WidgetNameLowered%%#options:minValue) and [maxValue](ui.%%WidgetNameLowered%%#options:maxValue) or cycling through list items if [isLimitedToListValues](ui.%%WidgetNameLowered%%#options:isLimitedToListValues) is enabled. * */ igNumericEditor(optionLiteral: 'option', optionName: "spinWrapAround"): boolean; /** * /Set the ability of the editor to automatically set value in the editor to the opposite side of the limit, when the spin action reaches minimum or maximum limit. + * This applies to [minValue](ui.%%WidgetNameLowered%%#options:minValue) and [maxValue](ui.%%WidgetNameLowered%%#options:maxValue) or cycling through list items if [isLimitedToListValues](ui.%%WidgetNameLowered%%#options:isLimitedToListValues) is enabled. * * * @optionValue New value to be set. */ igNumericEditor(optionLiteral: 'option', optionName: "spinWrapAround", optionValue: boolean): void; + /** + * Gets/Sets if the editor should only allow values from the list of items. Enabling this also causes spin actions to cycle through list items instead. + * + */ + igNumericEditor(optionLiteral: 'option', optionName: "isLimitedToListValues"): boolean; + + /** + * /Sets if the editor should only allow values from the list of items. Enabling this also causes spin actions to cycle through list items instead. + * + * + * @optionValue New value to be set. + */ + igNumericEditor(optionLiteral: 'option', optionName: "isLimitedToListValues", optionValue: boolean): void; + /** * Removed from numeric editor options */ @@ -31625,20 +32383,6 @@ interface JQuery { */ igNumericEditor(optionLiteral: 'option', optionName: "selectionOnFocus", optionValue: string): void; - /** - * Gets/Sets if the editor should only allow values set into the list of items. This validation is done only when the editor is blured, or enter key is pressed - * - */ - igNumericEditor(optionLiteral: 'option', optionName: "isLimitedToListValues"): boolean; - - /** - * /Sets if the editor should only allow values set into the list of items. This validation is done only when the editor is blured, or enter key is pressed - * - * - * @optionValue New value to be set. - */ - igNumericEditor(optionLiteral: 'option', optionName: "isLimitedToListValues", optionValue: boolean): void; - /** * Gets/Sets if the editor should revert it's value to the previously valid value in case the value on blur, or enter key is not valid. If the opiton is set to false, editor calls clear functionality. * @@ -32041,14 +32785,14 @@ interface JQuery { /** * Gets/Sets list of items which are used as a source for the drop-down list. - * Items in the list can be of type string, number or object. The items are directly rendered without any casting, or manipulation. + * Items in the list can be of type number. * */ igCurrencyEditor(optionLiteral: 'option', optionName: "listItems"): any[]; /** * /Sets list of items which are used as a source for the drop-down list. - * Items in the list can be of type string, number or object. The items are directly rendered without any casting, or manipulation. + * Items in the list can be of type number. * * * @optionValue New value to be set. @@ -32073,6 +32817,7 @@ interface JQuery { * Gets/Sets the character, which is used as negative sign. * Note: This option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. + * Note: This option's value should not be equal to the value of [groupSeparator](ui.igNumericEditor#options:groupSeparator) or [decimalSeparator](ui.igNumericEditor#options:decimalSeparator) options. * */ igCurrencyEditor(optionLiteral: 'option', optionName: "negativeSign"): string; @@ -32081,6 +32826,7 @@ interface JQuery { * /Sets the character, which is used as negative sign. * Note: This option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. + * Note: This option's value should not be equal to the value of [groupSeparator](ui.igNumericEditor#options:groupSeparator) or [decimalSeparator](ui.igNumericEditor#options:decimalSeparator) options. * * * @optionValue New value to be set. @@ -32109,6 +32855,7 @@ interface JQuery { * Gets/Sets the character, which is used as decimal separator. * Note: this option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. + * Note: This option's value should not be equal to the value of [groupSeparator](ui.igNumericEditor#options:groupSeparator) or [negativeSign](ui.igNumericEditor#options:negativeSign) options. * */ igCurrencyEditor(optionLiteral: 'option', optionName: "decimalSeparator"): string; @@ -32117,6 +32864,7 @@ interface JQuery { * /Sets the character, which is used as decimal separator. * Note: this option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. + * Note: This option's value should not be equal to the value of [groupSeparator](ui.igNumericEditor#options:groupSeparator) or [negativeSign](ui.igNumericEditor#options:negativeSign) options. * * * @optionValue New value to be set. @@ -32126,8 +32874,9 @@ interface JQuery { /** * Gets/Sets the character, which is used as separator for groups (like thousands). * That option has effect only in display mode(no focus). - * Note: this option has priority over possible regional settings. + * Note: This option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. + * Note: This option's value should not be equal to the value of [decimalSeparator](ui.igNumericEditor#options:decimalSeparator) or [negativeSign](ui.igNumericEditor#options:negativeSign) options. * */ igCurrencyEditor(optionLiteral: 'option', optionName: "groupSeparator"): string; @@ -32135,8 +32884,9 @@ interface JQuery { /** * /Sets the character, which is used as separator for groups (like thousands). * That option has effect only in display mode(no focus). - * Note: this option has priority over possible regional settings. + * Note: This option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. + * Note: This option's value should not be equal to the value of [decimalSeparator](ui.igNumericEditor#options:decimalSeparator) or [negativeSign](ui.igNumericEditor#options:negativeSign) options. * * * @optionValue New value to be set. @@ -32149,7 +32899,8 @@ interface JQuery { * If the sum of all values in array is smaller than the length of integer part, then the last item in array is used for all following groups. * Count of groups starts from the decimal point (from right to left). * That option has effect only in display mode(no focus). - * Note: this option has priority over possible regional settings. + * Note: The numbers in the array must be positive integers. + * Note: This option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. * */ @@ -32161,7 +32912,8 @@ interface JQuery { * If the sum of all values in array is smaller than the length of integer part, then the last item in array is used for all following groups. * Count of groups starts from the decimal point (from right to left). * That option has effect only in display mode(no focus). - * Note: this option has priority over possible regional settings. + * Note: The numbers in the array must be positive integers. + * Note: This option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. * * @@ -32170,19 +32922,21 @@ interface JQuery { igCurrencyEditor(optionLiteral: 'option', optionName: "groups", optionValue: any[]): void; /** - * Gets/Sets the maximum number of decimal places which are used in display mode(no focus). + * Gets/Sets the maximum number of decimal places supported by the editor. * Note: this option has priority over possible regional settings. * Note: In case of min decimals value higher than max decimals - max decimals are equaled to min decimals property. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. + * Note: This option supports values between 0 and 15, when dataMode is 'double' (default) and values between 0 and 7 in 'float' mode. * */ igCurrencyEditor(optionLiteral: 'option', optionName: "maxDecimals"): number; /** - * /Sets the maximum number of decimal places which are used in display mode(no focus). + * /Sets the maximum number of decimal places supported by the editor. * Note: this option has priority over possible regional settings. * Note: In case of min decimals value higher than max decimals - max decimals are equaled to min decimals property. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. + * Note: This option supports values between 0 and 15, when dataMode is 'double' (default) and values between 0 and 7 in 'float' mode. * * * @optionValue New value to be set. @@ -32190,29 +32944,47 @@ interface JQuery { igCurrencyEditor(optionLiteral: 'option', optionName: "maxDecimals", optionValue: number): void; /** - * Gets/Sets the minimum number of decimal places which are used in display (no focus) state. + * Gets/Sets the minimum number of decimal places supported by the editor. * If number of digits in fractional part of number is less than the value of this option, then the "0" characters are used to fill missing digits. * Note: This option has priority over possible regional settings. * Note: In case of min decimals value higher than max decimals - max decimals are equaled to min decimals property. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. - * Note: This option supports values below or equal to 20. + * Note: This option supports values between 0 and 15, when dataMode is 'double' (default) and values between 0 and 7 in 'float' mode. * */ igCurrencyEditor(optionLiteral: 'option', optionName: "minDecimals"): number; /** - * /Sets the minimum number of decimal places which are used in display (no focus) state. + * /Sets the minimum number of decimal places supported by the editor. * If number of digits in fractional part of number is less than the value of this option, then the "0" characters are used to fill missing digits. * Note: This option has priority over possible regional settings. * Note: In case of min decimals value higher than max decimals - max decimals are equaled to min decimals property. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. - * Note: This option supports values below or equal to 20. + * Note: This option supports values between 0 and 15, when dataMode is 'double' (default) and values between 0 and 7 in 'float' mode. * * * @optionValue New value to be set. */ igCurrencyEditor(optionLiteral: 'option', optionName: "minDecimals", optionValue: number): void; + /** + * Gets/Sets whether the last decimal place will be rounded, when the maxDecimal option is defined and applied. + * For example if the initial editor value is set to 123.4567, maxDecimals option is set to 3 and roundDecimals is enabled, + * then editor will round the value and will display it as 123.457. If roundDecimals is disabled then editor value will be truncated to 123.456. + * + */ + igCurrencyEditor(optionLiteral: 'option', optionName: "roundDecimals"): boolean; + + /** + * /Sets whether the last decimal place will be rounded, when the maxDecimal option is defined and applied. + * For example if the initial editor value is set to 123.4567, maxDecimals option is set to 3 and roundDecimals is enabled, + * then editor will round the value and will display it as 123.457. If roundDecimals is disabled then editor value will be truncated to 123.456. + * + * + * @optionValue New value to be set. + */ + igCurrencyEditor(optionLiteral: 'option', optionName: "roundDecimals", optionValue: boolean): void; + /** * Gets/Sets the horizontal alignment of the text in the editor. * @@ -32306,7 +33078,7 @@ interface JQuery { igCurrencyEditor(optionLiteral: 'option', optionName: "spinDelta", optionValue: number): void; /** - * Gets/Sets support for scientific format in edit mode. + * Gets/Sets support for scientific format. * 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. * @@ -32315,7 +33087,7 @@ interface JQuery { igCurrencyEditor(optionLiteral: 'option', optionName: "scientificFormat"): string; /** - * /Sets support for scientific format in edit mode. + * /Sets support for scientific format. * 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. * @@ -32327,18 +33099,34 @@ interface JQuery { /** * Gets/Set the ability of the editor to automatically set value in the editor to the opposite side of the limit, when the spin action reaches minimum or maximum limit. + * This applies to [minValue](ui.%%WidgetNameLowered%%#options:minValue) and [maxValue](ui.%%WidgetNameLowered%%#options:maxValue) or cycling through list items if [isLimitedToListValues](ui.%%WidgetNameLowered%%#options:isLimitedToListValues) is enabled. * */ igCurrencyEditor(optionLiteral: 'option', optionName: "spinWrapAround"): boolean; /** * /Set the ability of the editor to automatically set value in the editor to the opposite side of the limit, when the spin action reaches minimum or maximum limit. + * This applies to [minValue](ui.%%WidgetNameLowered%%#options:minValue) and [maxValue](ui.%%WidgetNameLowered%%#options:maxValue) or cycling through list items if [isLimitedToListValues](ui.%%WidgetNameLowered%%#options:isLimitedToListValues) is enabled. * * * @optionValue New value to be set. */ igCurrencyEditor(optionLiteral: 'option', optionName: "spinWrapAround", optionValue: boolean): void; + /** + * Gets/Sets if the editor should only allow values from the list of items. Enabling this also causes spin actions to cycle through list items instead. + * + */ + igCurrencyEditor(optionLiteral: 'option', optionName: "isLimitedToListValues"): boolean; + + /** + * /Sets if the editor should only allow values from the list of items. Enabling this also causes spin actions to cycle through list items instead. + * + * + * @optionValue New value to be set. + */ + igCurrencyEditor(optionLiteral: 'option', optionName: "isLimitedToListValues", optionValue: boolean): void; + /** * Removed from numeric editor options */ @@ -32549,20 +33337,6 @@ interface JQuery { */ igCurrencyEditor(optionLiteral: 'option', optionName: "selectionOnFocus", optionValue: string): void; - /** - * Gets/Sets if the editor should only allow values set into the list of items. This validation is done only when the editor is blured, or enter key is pressed - * - */ - igCurrencyEditor(optionLiteral: 'option', optionName: "isLimitedToListValues"): boolean; - - /** - * /Sets if the editor should only allow values set into the list of items. This validation is done only when the editor is blured, or enter key is pressed - * - * - * @optionValue New value to be set. - */ - igCurrencyEditor(optionLiteral: 'option', optionName: "isLimitedToListValues", optionValue: boolean): void; - /** * Gets/Sets if the editor should revert it's value to the previously valid value in case the value on blur, or enter key is not valid. If the opiton is set to false, editor calls clear functionality. * @@ -32878,14 +33652,14 @@ interface JQuery { /** * Gets/Sets list of items which are used as a source for the drop-down list. - * Items in the list can be of type string, number or object. The items are directly rendered without any casting, or manipulation. + * Items in the list can be of type number. * */ igPercentEditor(optionLiteral: 'option', optionName: "listItems"): any[]; /** * /Sets list of items which are used as a source for the drop-down list. - * Items in the list can be of type string, number or object. The items are directly rendered without any casting, or manipulation. + * Items in the list can be of type number. * * * @optionValue New value to be set. @@ -32910,6 +33684,7 @@ interface JQuery { * Gets/Sets the character, which is used as negative sign. * Note: This option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. + * Note: This option's value should not be equal to the value of [groupSeparator](ui.igNumericEditor#options:groupSeparator) or [decimalSeparator](ui.igNumericEditor#options:decimalSeparator) options. * */ igPercentEditor(optionLiteral: 'option', optionName: "negativeSign"): string; @@ -32918,6 +33693,7 @@ interface JQuery { * /Sets the character, which is used as negative sign. * Note: This option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. + * Note: This option's value should not be equal to the value of [groupSeparator](ui.igNumericEditor#options:groupSeparator) or [decimalSeparator](ui.igNumericEditor#options:decimalSeparator) options. * * * @optionValue New value to be set. @@ -32946,6 +33722,7 @@ interface JQuery { * Gets/Sets the character, which is used as decimal separator. * Note: this option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. + * Note: This option's value should not be equal to the value of [groupSeparator](ui.igNumericEditor#options:groupSeparator) or [negativeSign](ui.igNumericEditor#options:negativeSign) options. * */ igPercentEditor(optionLiteral: 'option', optionName: "decimalSeparator"): string; @@ -32954,6 +33731,7 @@ interface JQuery { * /Sets the character, which is used as decimal separator. * Note: this option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. + * Note: This option's value should not be equal to the value of [groupSeparator](ui.igNumericEditor#options:groupSeparator) or [negativeSign](ui.igNumericEditor#options:negativeSign) options. * * * @optionValue New value to be set. @@ -32963,8 +33741,9 @@ interface JQuery { /** * Gets/Sets the character, which is used as separator for groups (like thousands). * That option has effect only in display mode(no focus). - * Note: this option has priority over possible regional settings. + * Note: This option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. + * Note: This option's value should not be equal to the value of [decimalSeparator](ui.igNumericEditor#options:decimalSeparator) or [negativeSign](ui.igNumericEditor#options:negativeSign) options. * */ igPercentEditor(optionLiteral: 'option', optionName: "groupSeparator"): string; @@ -32972,8 +33751,9 @@ interface JQuery { /** * /Sets the character, which is used as separator for groups (like thousands). * That option has effect only in display mode(no focus). - * Note: this option has priority over possible regional settings. + * Note: This option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. + * Note: This option's value should not be equal to the value of [decimalSeparator](ui.igNumericEditor#options:decimalSeparator) or [negativeSign](ui.igNumericEditor#options:negativeSign) options. * * * @optionValue New value to be set. @@ -32986,7 +33766,8 @@ interface JQuery { * If the sum of all values in array is smaller than the length of integer part, then the last item in array is used for all following groups. * Count of groups starts from the decimal point (from right to left). * That option has effect only in display mode(no focus). - * Note: this option has priority over possible regional settings. + * Note: The numbers in the array must be positive integers. + * Note: This option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. * */ @@ -32998,7 +33779,8 @@ interface JQuery { * If the sum of all values in array is smaller than the length of integer part, then the last item in array is used for all following groups. * Count of groups starts from the decimal point (from right to left). * That option has effect only in display mode(no focus). - * Note: this option has priority over possible regional settings. + * Note: The numbers in the array must be positive integers. + * Note: This option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. * * @@ -33007,19 +33789,21 @@ interface JQuery { igPercentEditor(optionLiteral: 'option', optionName: "groups", optionValue: any[]): void; /** - * Gets/Sets the maximum number of decimal places which are used in display mode(no focus). + * Gets/Sets the maximum number of decimal places supported by the editor. * Note: this option has priority over possible regional settings. * Note: In case of min decimals value higher than max decimals - max decimals are equaled to min decimals property. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. + * Note: This option supports values between 0 and 15, when dataMode is 'double' (default) and values between 0 and 7 in 'float' mode. * */ igPercentEditor(optionLiteral: 'option', optionName: "maxDecimals"): number; /** - * /Sets the maximum number of decimal places which are used in display mode(no focus). + * /Sets the maximum number of decimal places supported by the editor. * Note: this option has priority over possible regional settings. * Note: In case of min decimals value higher than max decimals - max decimals are equaled to min decimals property. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. + * Note: This option supports values between 0 and 15, when dataMode is 'double' (default) and values between 0 and 7 in 'float' mode. * * * @optionValue New value to be set. @@ -33027,29 +33811,47 @@ interface JQuery { igPercentEditor(optionLiteral: 'option', optionName: "maxDecimals", optionValue: number): void; /** - * Gets/Sets the minimum number of decimal places which are used in display (no focus) state. + * Gets/Sets the minimum number of decimal places supported by the editor. * If number of digits in fractional part of number is less than the value of this option, then the "0" characters are used to fill missing digits. * Note: This option has priority over possible regional settings. * Note: In case of min decimals value higher than max decimals - max decimals are equaled to min decimals property. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. - * Note: This option supports values below or equal to 20. + * Note: This option supports values between 0 and 15, when dataMode is 'double' (default) and values between 0 and 7 in 'float' mode. * */ igPercentEditor(optionLiteral: 'option', optionName: "minDecimals"): number; /** - * /Sets the minimum number of decimal places which are used in display (no focus) state. + * /Sets the minimum number of decimal places supported by the editor. * If number of digits in fractional part of number is less than the value of this option, then the "0" characters are used to fill missing digits. * Note: This option has priority over possible regional settings. * Note: In case of min decimals value higher than max decimals - max decimals are equaled to min decimals property. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. - * Note: This option supports values below or equal to 20. + * Note: This option supports values between 0 and 15, when dataMode is 'double' (default) and values between 0 and 7 in 'float' mode. * * * @optionValue New value to be set. */ igPercentEditor(optionLiteral: 'option', optionName: "minDecimals", optionValue: number): void; + /** + * Gets/Sets whether the last decimal place will be rounded, when the maxDecimal option is defined and applied. + * For example if the initial editor value is set to 123.4567, maxDecimals option is set to 3 and roundDecimals is enabled, + * then editor will round the value and will display it as 123.457. If roundDecimals is disabled then editor value will be truncated to 123.456. + * + */ + igPercentEditor(optionLiteral: 'option', optionName: "roundDecimals"): boolean; + + /** + * /Sets whether the last decimal place will be rounded, when the maxDecimal option is defined and applied. + * For example if the initial editor value is set to 123.4567, maxDecimals option is set to 3 and roundDecimals is enabled, + * then editor will round the value and will display it as 123.457. If roundDecimals is disabled then editor value will be truncated to 123.456. + * + * + * @optionValue New value to be set. + */ + igPercentEditor(optionLiteral: 'option', optionName: "roundDecimals", optionValue: boolean): void; + /** * Gets/Sets the horizontal alignment of the text in the editor. * @@ -33109,7 +33911,7 @@ interface JQuery { igPercentEditor(optionLiteral: 'option', optionName: "allowNullValue", optionValue: boolean): void; /** - * Gets/Sets support for scientific format in edit mode. + * Gets/Sets support for scientific format. * 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. * @@ -33118,7 +33920,7 @@ interface JQuery { igPercentEditor(optionLiteral: 'option', optionName: "scientificFormat"): string; /** - * /Sets support for scientific format in edit mode. + * /Sets support for scientific format. * 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. * @@ -33130,18 +33932,34 @@ interface JQuery { /** * Gets/Set the ability of the editor to automatically set value in the editor to the opposite side of the limit, when the spin action reaches minimum or maximum limit. + * This applies to [minValue](ui.%%WidgetNameLowered%%#options:minValue) and [maxValue](ui.%%WidgetNameLowered%%#options:maxValue) or cycling through list items if [isLimitedToListValues](ui.%%WidgetNameLowered%%#options:isLimitedToListValues) is enabled. * */ igPercentEditor(optionLiteral: 'option', optionName: "spinWrapAround"): boolean; /** * /Set the ability of the editor to automatically set value in the editor to the opposite side of the limit, when the spin action reaches minimum or maximum limit. + * This applies to [minValue](ui.%%WidgetNameLowered%%#options:minValue) and [maxValue](ui.%%WidgetNameLowered%%#options:maxValue) or cycling through list items if [isLimitedToListValues](ui.%%WidgetNameLowered%%#options:isLimitedToListValues) is enabled. * * * @optionValue New value to be set. */ igPercentEditor(optionLiteral: 'option', optionName: "spinWrapAround", optionValue: boolean): void; + /** + * Gets/Sets if the editor should only allow values from the list of items. Enabling this also causes spin actions to cycle through list items instead. + * + */ + igPercentEditor(optionLiteral: 'option', optionName: "isLimitedToListValues"): boolean; + + /** + * /Sets if the editor should only allow values from the list of items. Enabling this also causes spin actions to cycle through list items instead. + * + * + * @optionValue New value to be set. + */ + igPercentEditor(optionLiteral: 'option', optionName: "isLimitedToListValues", optionValue: boolean): void; + /** * Removed from numeric editor options */ @@ -33352,20 +34170,6 @@ interface JQuery { */ igPercentEditor(optionLiteral: 'option', optionName: "selectionOnFocus", optionValue: string): void; - /** - * Gets/Sets if the editor should only allow values set into the list of items. This validation is done only when the editor is blured, or enter key is pressed - * - */ - igPercentEditor(optionLiteral: 'option', optionName: "isLimitedToListValues"): boolean; - - /** - * /Sets if the editor should only allow values set into the list of items. This validation is done only when the editor is blured, or enter key is pressed - * - * - * @optionValue New value to be set. - */ - igPercentEditor(optionLiteral: 'option', optionName: "isLimitedToListValues", optionValue: boolean): void; - /** * Gets/Sets if the editor should revert it's value to the previously valid value in case the value on blur, or enter key is not valid. If the opiton is set to false, editor calls clear functionality. * @@ -33615,14 +34419,12 @@ interface JQuery { /** * Gets visibility of the clear button. That option can be set only on initialization. * - * clear A button to clear the value is located on the right side of the editor. */ igMaskEditor(optionLiteral: 'option', optionName: "buttonType"): string; /** * Visibility of the clear button. That option can be set only on initialization. * - * clear A button to clear the value is located on the right side of the editor. * * @optionValue New value to be set. */ @@ -33675,13 +34477,13 @@ interface JQuery { igMaskEditor(optionLiteral: 'option', optionName: "inputMask", optionValue: string): void; /** - * Gets/Sets type of value returned by the get of [value](ui.igmaskeditor#methods:value) method. That also affects functionality of the set value(val) method and the copy/paste operations of browser. + * 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; /** - * /Sets type of value returned by the get of [value](ui.igmaskeditor#methods:value) method. That also affects functionality of the set value(val) method and the copy/paste operations of browser. + * 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. * * * @optionValue New value to be set. @@ -33703,13 +34505,13 @@ interface JQuery { igMaskEditor(optionLiteral: 'option', optionName: "unfilledCharsPrompt", optionValue: string): void; /** - * Gets/Sets character which is used as replacement of not-filled required position in mask when editor is in display mode (not focused). Note that this option is visible, only when the [revertIfNotValid](ui.igmaskeditor#options:revertIfNotValid) option is set to false. + * Gets/Sets character which is used as replacement of not-filled required position in mask when editor is in display mode (not focused). * */ igMaskEditor(optionLiteral: 'option', optionName: "padChar"): string; /** - * /Sets character which is used as replacement of not-filled required position in mask when editor is in display mode (not focused). Note that this option is visible, only when the [revertIfNotValid](ui.igmaskeditor#options:revertIfNotValid) option is set to false. + * /Sets character which is used as replacement of not-filled required position in mask when editor is in display mode (not focused). * * * @optionValue New value to be set. @@ -34289,14 +35091,14 @@ interface JQuery { /** * Gets/Sets the value of the editor. Date object can be set as value. String can be set and the editor will pass it to the Date object constructor and use the corresponding Date object as the value. MVC date format can be used too. - * Note! This option doesn't use the displayInputFormat to extract the date. + * Note! This option doesn't use the dateInputFormat to extract the date. * */ igDateEditor(optionLiteral: 'option', optionName: "value"): Object; /** * /Sets the value of the editor. Date object can be set as value. String can be set and the editor will pass it to the Date object constructor and use the corresponding Date object as the value. MVC date format can be used too. - * Note! This option doesn't use the displayInputFormat to extract the date. + * Note! This option doesn't use the dateInputFormat to extract the date. * * * @optionValue New value to be set. @@ -34305,14 +35107,14 @@ interface JQuery { /** * Gets the minimum value which can be entered in editor by user. 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. - * Note! This option doesn't use the displayInputFormat to extract the date. + * Note! This option doesn't use the dateInputFormat to extract the date. * */ igDateEditor(optionLiteral: 'option', optionName: "minValue"): Object; /** * The minimum value which can be entered in editor by user. 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. - * Note! This option doesn't use the displayInputFormat to extract the date. + * Note! This option doesn't use the dateInputFormat to extract the date. * * * @optionValue New value to be set. @@ -34321,14 +35123,14 @@ interface JQuery { /** * Gets the maximum value which can be entered in editor by user. 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. - * Note! This option doesn't use the displayInputFormat to extract the date. + * Note! This option doesn't use the dateInputFormat to extract the date. * */ igDateEditor(optionLiteral: 'option', optionName: "maxValue"): Object; /** * The maximum value which can be entered in editor by user. 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. - * Note! This option doesn't use the displayInputFormat to extract the date. + * Note! This option doesn't use the dateInputFormat to extract the date. * * * @optionValue New value to be set. @@ -34486,21 +35288,43 @@ interface JQuery { igDateEditor(optionLiteral: 'option', optionName: "dateInputFormat", optionValue: string): void; /** - * Gets/Sets the value type returned by the get of value() method. That also affects functionality of the set value(val) method and the copy/paste operations of browser. - * Note: That is used as default. + * Gets the value type returned by the get of value() method and option. Also affects how the value is stored for form submit. + * The [enableUTCDates](ui.%%WidgetNameLowered%%#options:enableUTCDates) option can be used to output an UTC ISO string instead. + * For example 10:00 AM from a client with local offset of 5 hours ahead of GMT will be serialized as: + * "2016-11-11T10:00:00+05:00" * */ igDateEditor(optionLiteral: 'option', optionName: "dataMode"): string; /** - * /Sets the value type returned by the get of value() method. That also affects functionality of the set value(val) method and the copy/paste operations of browser. - * Note: That is used as default. + * The value type returned by the get of value() method and option. Also affects how the value is stored for form submit. + * The [enableUTCDates](ui.%%WidgetNameLowered%%#options:enableUTCDates) option can be used to output an UTC ISO string instead. + * For example 10:00 AM from a client with local offset of 5 hours ahead of GMT will be serialized as: + * "2016-11-11T10:00:00+05:00" * * * @optionValue New value to be set. */ igDateEditor(optionLiteral: 'option', optionName: "dataMode", optionValue: string): void; + /** + * Gets/Sets time zone offset from UTC, in minutes. The client date values are displayed with this offset instead of the local one. + * Note: It is recommended that this option is used with an UTC value (e.g. "2016-11-03T14:08:08.504Z") so the outcome is consistent. + * Values with ambiguous time zone could map to unpredictable times depending on the user agent local zone. + * + */ + igDateEditor(optionLiteral: 'option', optionName: "displayTimeOffset"): any; + + /** + * /Sets time zone offset from UTC, in minutes. The client date values are displayed with this offset instead of the local one. + * Note: It is recommended that this option is used with an UTC value (e.g. "2016-11-03T14:08:08.504Z") so the outcome is consistent. + * Values with ambiguous time zone could map to unpredictable times depending on the user agent local zone. + * + * + * @optionValue New value to be set. + */ + igDateEditor(optionLiteral: 'option', optionName: "displayTimeOffset", optionValue: any): void; + /** * Gets visibility of the spin and clear buttons. That option can be set only on initialization. Combinations like 'spin,clear' are supported too. * @@ -34516,13 +35340,19 @@ interface JQuery { igDateEditor(optionLiteral: 'option', optionName: "buttonType", optionValue: string): void; /** - * Gets/Sets delta-value which is used to increment or decrement value in editor on spin events. If value is set to negative value an exception is thrown. Non integer value is supported only for dataMode double and float. + * Gets/Sets delta-value which is used to increment or decrement the editor date on spin actions. + * When not editing (focused) the delta is applied on the day if available in the input mask or the lowest available period. + * When in edit mode the time period, where the cursor is positioned, is incremented or decremented with the defined delta value. + * The value can be only a positive integer number, otherwise it will be set as 1, or in the cases with double or float the the whole part will be taken. * */ igDateEditor(optionLiteral: 'option', optionName: "spinDelta"): number; /** - * /Sets delta-value which is used to increment or decrement value in editor on spin events. If value is set to negative value an exception is thrown. Non integer value is supported only for dataMode double and float. + * /Sets delta-value which is used to increment or decrement the editor date on spin actions. + * When not editing (focused) the delta is applied on the day if available in the input mask or the lowest available period. + * When in edit mode the time period, where the cursor is positioned, is incremented or decremented with the defined delta value. + * The value can be only a positive integer number, otherwise it will be set as 1, or in the cases with double or float the the whole part will be taken. * * * @optionValue New value to be set. @@ -34548,27 +35378,15 @@ interface JQuery { igDateEditor(optionLiteral: 'option', optionName: "limitSpinToCurrentField", optionValue: boolean): void; /** - * Gets/Sets formatting of the dates as UTC. - * That option is supported only when dataMode option is 'date' and Date objects are used to get/set value of editor. - * Notes: - * That option affects only functionality of get/set value method and the Date-value, which was set on initialization. - * When application uses the set-value, then internal Date-value and displayed-text is incremented by TimezoneOffset. - * When application uses the get-value, then editor returns internal Date-value decremented by TimezoneOffset. - * When that option is modified after initialization, then displayed text and internal Date-value are not affected. - * It is not recommended to change that option without resetting Date-value. + * Enables/Disables serializing client date as UTC ISO 8061 string instead of using the local time and zone values. + * The option is only applied in "date" [dataMode](ui.%%WidgetNameLowered%%#options:dataMode). * */ igDateEditor(optionLiteral: 'option', optionName: "enableUTCDates"): boolean; /** - * /Sets formatting of the dates as UTC. - * That option is supported only when dataMode option is 'date' and Date objects are used to get/set value of editor. - * Notes: - * That option affects only functionality of get/set value method and the Date-value, which was set on initialization. - * When application uses the set-value, then internal Date-value and displayed-text is incremented by TimezoneOffset. - * When application uses the get-value, then editor returns internal Date-value decremented by TimezoneOffset. - * When that option is modified after initialization, then displayed text and internal Date-value are not affected. - * It is not recommended to change that option without resetting Date-value. + * Enables/Disables serializing client date as UTC ISO 8061 string instead of using the local time and zone values. + * The option is only applied in "date" [dataMode](ui.%%WidgetNameLowered%%#options:dataMode). * * * @optionValue New value to be set. @@ -34611,7 +35429,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; + igDateEditor(optionLiteral: 'option', optionName: "nullValue"): string|number|Date; /** * /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 @@ -34619,7 +35437,7 @@ interface JQuery { * * @optionValue New value to be set. */ - igDateEditor(optionLiteral: 'option', optionName: "nullValue", optionValue: string|number): void; + igDateEditor(optionLiteral: 'option', optionName: "nullValue", optionValue: string|number|Date): void; /** * This option is inherited from a parent widget and it's not applicable for igDateEditor @@ -35326,14 +36144,14 @@ interface JQuery { /** * Gets/Sets the value of the editor. Date object can be set as value. String can be set and the editor will pass it to the Date object constructor and use the corresponding Date object as the value. MVC date format can be used too. - * Note! This option doesn't use the displayInputFormat to extract the date. + * Note! This option doesn't use the dateInputFormat to extract the date. * */ igDatePicker(optionLiteral: 'option', optionName: "value"): Object; /** * /Sets the value of the editor. Date object can be set as value. String can be set and the editor will pass it to the Date object constructor and use the corresponding Date object as the value. MVC date format can be used too. - * Note! This option doesn't use the displayInputFormat to extract the date. + * Note! This option doesn't use the dateInputFormat to extract the date. * * * @optionValue New value to be set. @@ -35342,14 +36160,14 @@ interface JQuery { /** * Gets the minimum value which can be entered in editor by user. 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. - * Note! This option doesn't use the displayInputFormat to extract the date. + * Note! This option doesn't use the dateInputFormat to extract the date. * */ igDatePicker(optionLiteral: 'option', optionName: "minValue"): Object; /** * The minimum value which can be entered in editor by user. 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. - * Note! This option doesn't use the displayInputFormat to extract the date. + * Note! This option doesn't use the dateInputFormat to extract the date. * * * @optionValue New value to be set. @@ -35358,14 +36176,14 @@ interface JQuery { /** * Gets the maximum value which can be entered in editor by user. 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. - * Note! This option doesn't use the displayInputFormat to extract the date. + * Note! This option doesn't use the dateInputFormat to extract the date. * */ igDatePicker(optionLiteral: 'option', optionName: "maxValue"): Object; /** * The maximum value which can be entered in editor by user. 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. - * Note! This option doesn't use the displayInputFormat to extract the date. + * Note! This option doesn't use the dateInputFormat to extract the date. * * * @optionValue New value to be set. @@ -35523,15 +36341,19 @@ interface JQuery { igDatePicker(optionLiteral: 'option', optionName: "dateInputFormat", optionValue: string): void; /** - * Gets/Sets the value type returned by the get of value() method. That also affects functionality of the set value(val) method and the copy/paste operations of browser. - * Note: That is used as default. + * Gets the value type returned by the get of value() method and option. Also affects how the value is stored for form submit. + * The [enableUTCDates](ui.%%WidgetNameLowered%%#options:enableUTCDates) option can be used to output an UTC ISO string instead. + * For example 10:00 AM from a client with local offset of 5 hours ahead of GMT will be serialized as: + * "2016-11-11T10:00:00+05:00" * */ igDatePicker(optionLiteral: 'option', optionName: "dataMode"): string; /** - * /Sets the value type returned by the get of value() method. That also affects functionality of the set value(val) method and the copy/paste operations of browser. - * Note: That is used as default. + * The value type returned by the get of value() method and option. Also affects how the value is stored for form submit. + * The [enableUTCDates](ui.%%WidgetNameLowered%%#options:enableUTCDates) option can be used to output an UTC ISO string instead. + * For example 10:00 AM from a client with local offset of 5 hours ahead of GMT will be serialized as: + * "2016-11-11T10:00:00+05:00" * * * @optionValue New value to be set. @@ -35539,13 +36361,37 @@ interface JQuery { igDatePicker(optionLiteral: 'option', optionName: "dataMode", optionValue: string): void; /** - * Gets/Sets delta-value which is used to increment or decrement value in editor on spin events. If value is set to negative value an exception is thrown. Non integer value is supported only for dataMode double and float. + * Gets/Sets time zone offset from UTC, in minutes. The client date values are displayed with this offset instead of the local one. + * Note: It is recommended that this option is used with an UTC value (e.g. "2016-11-03T14:08:08.504Z") so the outcome is consistent. + * Values with ambiguous time zone could map to unpredictable times depending on the user agent local zone. + * + */ + igDatePicker(optionLiteral: 'option', optionName: "displayTimeOffset"): any; + + /** + * /Sets time zone offset from UTC, in minutes. The client date values are displayed with this offset instead of the local one. + * Note: It is recommended that this option is used with an UTC value (e.g. "2016-11-03T14:08:08.504Z") so the outcome is consistent. + * Values with ambiguous time zone could map to unpredictable times depending on the user agent local zone. + * + * + * @optionValue New value to be set. + */ + igDatePicker(optionLiteral: 'option', optionName: "displayTimeOffset", optionValue: any): void; + + /** + * Gets/Sets delta-value which is used to increment or decrement the editor date on spin actions. + * When not editing (focused) the delta is applied on the day if available in the input mask or the lowest available period. + * When in edit mode the time period, where the cursor is positioned, is incremented or decremented with the defined delta value. + * The value can be only a positive integer number, otherwise it will be set as 1, or in the cases with double or float the the whole part will be taken. * */ igDatePicker(optionLiteral: 'option', optionName: "spinDelta"): number; /** - * /Sets delta-value which is used to increment or decrement value in editor on spin events. If value is set to negative value an exception is thrown. Non integer value is supported only for dataMode double and float. + * /Sets delta-value which is used to increment or decrement the editor date on spin actions. + * When not editing (focused) the delta is applied on the day if available in the input mask or the lowest available period. + * When in edit mode the time period, where the cursor is positioned, is incremented or decremented with the defined delta value. + * The value can be only a positive integer number, otherwise it will be set as 1, or in the cases with double or float the the whole part will be taken. * * * @optionValue New value to be set. @@ -35571,27 +36417,15 @@ interface JQuery { igDatePicker(optionLiteral: 'option', optionName: "limitSpinToCurrentField", optionValue: boolean): void; /** - * Gets/Sets formatting of the dates as UTC. - * That option is supported only when dataMode option is 'date' and Date objects are used to get/set value of editor. - * Notes: - * That option affects only functionality of get/set value method and the Date-value, which was set on initialization. - * When application uses the set-value, then internal Date-value and displayed-text is incremented by TimezoneOffset. - * When application uses the get-value, then editor returns internal Date-value decremented by TimezoneOffset. - * When that option is modified after initialization, then displayed text and internal Date-value are not affected. - * It is not recommended to change that option without resetting Date-value. + * Enables/Disables serializing client date as UTC ISO 8061 string instead of using the local time and zone values. + * The option is only applied in "date" [dataMode](ui.%%WidgetNameLowered%%#options:dataMode). * */ igDatePicker(optionLiteral: 'option', optionName: "enableUTCDates"): boolean; /** - * /Sets formatting of the dates as UTC. - * That option is supported only when dataMode option is 'date' and Date objects are used to get/set value of editor. - * Notes: - * That option affects only functionality of get/set value method and the Date-value, which was set on initialization. - * When application uses the set-value, then internal Date-value and displayed-text is incremented by TimezoneOffset. - * When application uses the get-value, then editor returns internal Date-value decremented by TimezoneOffset. - * When that option is modified after initialization, then displayed text and internal Date-value are not affected. - * It is not recommended to change that option without resetting Date-value. + * Enables/Disables serializing client date as UTC ISO 8061 string instead of using the local time and zone values. + * The option is only applied in "date" [dataMode](ui.%%WidgetNameLowered%%#options:dataMode). * * * @optionValue New value to be set. @@ -35634,7 +36468,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; + igDatePicker(optionLiteral: 'option', optionName: "nullValue"): string|number|Date; /** * /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 @@ -35642,7 +36476,7 @@ interface JQuery { * * @optionValue New value to be set. */ - igDatePicker(optionLiteral: 'option', optionName: "nullValue", optionValue: string|number): void; + igDatePicker(optionLiteral: 'option', optionName: "nullValue", optionValue: string|number|Date): void; /** * This option is inherited from a parent widget and it's not applicable for igDateEditor @@ -36718,15 +37552,13 @@ interface IgFunnelChart { valueMemberPath?: string; /** - * Gets or sets the Brushes property. - * The brushes property defines the palette from which automatically assigned brushes are selected. + * Gets or sets the palette of brushes to use for coloring the slices. * The value provided should be an array of css color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection. */ brushes?: any; /** - * Gets or sets the Outlines property. - * The Outlines property defines the palette from which automatically assigned Outlines are selected. + * Gets or sets the palette of brushes to use for outlines on the slices. * The value provided should be an array of css color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection. */ outlines?: any; @@ -36750,8 +37582,8 @@ interface IgFunnelChart { * Gets or sets whether the inner labels are visible. * * Valid values: - * "visible" - * "collapsed" + * "visible" Display the element. + * "collapsed" Do not display the element. */ innerLabelVisibility?: string; @@ -36759,8 +37591,8 @@ interface IgFunnelChart { * Gets or sets whether the outer labels are visible. * * Valid values: - * "visible" - * "collapsed" + * "visible" Display the element. + * "collapsed" Do not display the element. */ outerLabelVisibility?: string; @@ -36873,6 +37705,12 @@ interface IgFunnelChart { * Gets or sets the thickness of outline around slices. */ outlineThickness?: 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; outerLabelTextColor?: any; textColor?: any; @@ -37079,7 +37917,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. + * 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. */ @@ -37087,7 +37925,7 @@ 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. + * 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. @@ -37097,7 +37935,7 @@ 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. + * 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. @@ -37114,6 +37952,11 @@ interface IgFunnelChartMethods { * Binds data to the chart */ dataBind(): void; + + /** + * Forces any pending deferred work to render on the chart before continuing + */ + flush(): void; } interface JQuery { data(propertyName: "igFunnelChart"): IgFunnelChartMethods; @@ -37139,6 +37982,7 @@ interface JQuery { igFunnelChart(methodName: "notifyRemoveItem", dataSource: Object, index: number, oldItem: Object): Object; igFunnelChart(methodName: "chart"): Object; igFunnelChart(methodName: "dataBind"): void; + igFunnelChart(methodName: "flush"): void; /** * Gets values for upper and lower bezier points. That option has effect only when useBezierCurve is enabled. @@ -37205,15 +38049,13 @@ interface JQuery { igFunnelChart(optionLiteral: 'option', optionName: "valueMemberPath", optionValue: string): void; /** - * Gets the Brushes property. - * The brushes property defines the palette from which automatically assigned brushes are selected. + * Gets the palette of brushes to use for coloring the slices. * The value provided should be an array of css color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection. */ igFunnelChart(optionLiteral: 'option', optionName: "brushes"): any; /** - * Sets the Brushes property. - * The brushes property defines the palette from which automatically assigned brushes are selected. + * Sets the palette of brushes to use for coloring the slices. * The value provided should be an array of css color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection. * * @optionValue New value to be set. @@ -37221,15 +38063,13 @@ interface JQuery { igFunnelChart(optionLiteral: 'option', optionName: "brushes", optionValue: any): void; /** - * Gets the Outlines property. - * The Outlines property defines the palette from which automatically assigned Outlines are selected. + * Gets the palette of brushes to use for outlines on the slices. * The value provided should be an array of css color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection. */ igFunnelChart(optionLiteral: 'option', optionName: "outlines"): any; /** - * Sets the Outlines property. - * The Outlines property defines the palette from which automatically assigned Outlines are selected. + * Sets the palette of brushes to use for outlines on the slices. * The value provided should be an array of css color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection. * * @optionValue New value to be set. @@ -37533,10 +38373,18 @@ interface JQuery { igFunnelChart(optionLiteral: 'option', optionName: "outlineThickness", optionValue: 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. */ igFunnelChart(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. */ igFunnelChart(optionLiteral: 'option', optionName: "pixelScalingRatio", optionValue: number): void; @@ -37787,6 +38635,1955 @@ interface JQuery { igFunnelChart(optionLiteral: 'option', optionName: string, optionValue: any): JQuery; igFunnelChart(methodName: string, ...methodParams: any[]): any; } +interface RowsRequestingEvent { + (event: Event, ui: RowsRequestingEventUIParam): void; +} + +interface RowsRequestingEventUIParam { +} + +interface RowsRequestedEvent { + (event: Event, ui: RowsRequestedEventUIParam): void; +} + +interface RowsRequestedEventUIParam { +} + +interface IgGridAppendRowsOnDemand { + /** + * Defines local or remote type of appending rows on demand in igGrid + * + * + * Valid values: + * "remote" request data from the remote endpoint + * "local" loading data on the client-side + */ + type?: string; + + /** + * Default number of records per chunk + * + */ + chunkSize?: number; + + /** + * The property in the response that will hold the total number of records in the data source + * + */ + recordCountKey?: string; + + /** + * Denotes the name of the encoded URL parameter that will state what is the currently requested chunk size + * + */ + chunkSizeUrlKey?: string; + + /** + * Denotes the name of the encoded URL parameter that will state what is the currently requested chunk index + * + */ + chunkIndexUrlKey?: string; + + /** + * Initial chunk index position + * + */ + defaultChunkIndex?: number; + + /** + * Current chunk index position + * + */ + currentChunkIndex?: number; + + /** + * denotes the append rows on demand request method + * + * + * Valid values: + * "auto" new record will be appended to the grid while the user scrolls the scrollbar + * "button" a button will be rendered at the bottom of the grid. The user should press it to load more rows + */ + loadTrigger?: string; + + /** + * Specifies caption text for the "load more data" button. + * + */ + loadMoreDataButtonText?: string; + + /** + * Event fired before the rows are requested from the remote endpoint. + * Return false in order to cancel requesting of rows. + */ + rowsRequesting?: RowsRequestingEvent; + + /** + * Event fired after the requested rows are returned from the remote endpoint, but before grid data rebinds + */ + rowsRequested?: RowsRequestedEvent; + + /** + * Option for igGridAppendRowsOnDemand + */ + [optionName: string]: any; +} +interface IgGridAppendRowsOnDemandMethods { + /** + * Destroys the append rows on demand widget + */ + destroy(): void; + + /** + * Loads the next chunk of data. + */ + nextChunk(): void; +} +interface JQuery { + data(propertyName: "igGridAppendRowsOnDemand"): IgGridAppendRowsOnDemandMethods; +} + +interface JQuery { + igGridAppendRowsOnDemand(methodName: "destroy"): void; + igGridAppendRowsOnDemand(methodName: "nextChunk"): void; + + /** + * Defines local or remote type of appending rows on demand in igGrid + * + */ + igGridAppendRowsOnDemand(optionLiteral: 'option', optionName: "type"): string; + + /** + * Defines local or remote type of appending rows on demand in igGrid + * + * + * @optionValue New value to be set. + */ + igGridAppendRowsOnDemand(optionLiteral: 'option', optionName: "type", optionValue: string): void; + + /** + * Default number of records per chunk + * + */ + igGridAppendRowsOnDemand(optionLiteral: 'option', optionName: "chunkSize"): number; + + /** + * Default number of records per chunk + * + * + * @optionValue New value to be set. + */ + igGridAppendRowsOnDemand(optionLiteral: 'option', optionName: "chunkSize", optionValue: number): void; + + /** + * The property in the response that will hold the total number of records in the data source + * + */ + igGridAppendRowsOnDemand(optionLiteral: 'option', optionName: "recordCountKey"): string; + + /** + * The property in the response that will hold the total number of records in the data source + * + * + * @optionValue New value to be set. + */ + igGridAppendRowsOnDemand(optionLiteral: 'option', optionName: "recordCountKey", optionValue: string): void; + + /** + * Denotes the name of the encoded URL parameter that will state what is the currently requested chunk size + * + */ + igGridAppendRowsOnDemand(optionLiteral: 'option', optionName: "chunkSizeUrlKey"): string; + + /** + * Denotes the name of the encoded URL parameter that will state what is the currently requested chunk size + * + * + * @optionValue New value to be set. + */ + igGridAppendRowsOnDemand(optionLiteral: 'option', optionName: "chunkSizeUrlKey", optionValue: string): void; + + /** + * Denotes the name of the encoded URL parameter that will state what is the currently requested chunk index + * + */ + igGridAppendRowsOnDemand(optionLiteral: 'option', optionName: "chunkIndexUrlKey"): string; + + /** + * Denotes the name of the encoded URL parameter that will state what is the currently requested chunk index + * + * + * @optionValue New value to be set. + */ + igGridAppendRowsOnDemand(optionLiteral: 'option', optionName: "chunkIndexUrlKey", optionValue: string): void; + + /** + * Initial chunk index position + * + */ + igGridAppendRowsOnDemand(optionLiteral: 'option', optionName: "defaultChunkIndex"): number; + + /** + * Initial chunk index position + * + * + * @optionValue New value to be set. + */ + igGridAppendRowsOnDemand(optionLiteral: 'option', optionName: "defaultChunkIndex", optionValue: number): void; + + /** + * Current chunk index position + * + */ + igGridAppendRowsOnDemand(optionLiteral: 'option', optionName: "currentChunkIndex"): number; + + /** + * Current chunk index position + * + * + * @optionValue New value to be set. + */ + igGridAppendRowsOnDemand(optionLiteral: 'option', optionName: "currentChunkIndex", optionValue: number): void; + + /** + * Denotes the append rows on demand request method + * + */ + igGridAppendRowsOnDemand(optionLiteral: 'option', optionName: "loadTrigger"): string; + + /** + * Denotes the append rows on demand request method + * + * + * @optionValue New value to be set. + */ + igGridAppendRowsOnDemand(optionLiteral: 'option', optionName: "loadTrigger", optionValue: string): void; + + /** + * Gets caption text for the "load more data" button. + * + */ + igGridAppendRowsOnDemand(optionLiteral: 'option', optionName: "loadMoreDataButtonText"): string; + + /** + * Sets caption text for the "load more data" button. + * + * + * @optionValue New value to be set. + */ + igGridAppendRowsOnDemand(optionLiteral: 'option', optionName: "loadMoreDataButtonText", optionValue: string): void; + + /** + * Event fired before the rows are requested from the remote endpoint. + * Return false in order to cancel requesting of rows. + */ + igGridAppendRowsOnDemand(optionLiteral: 'option', optionName: "rowsRequesting"): RowsRequestingEvent; + + /** + * Event fired before the rows are requested from the remote endpoint. + * Return false in order to cancel requesting of rows. + * + * @optionValue Define event handler function. + */ + igGridAppendRowsOnDemand(optionLiteral: 'option', optionName: "rowsRequesting", optionValue: RowsRequestingEvent): void; + + /** + * Event fired after the requested rows are returned from the remote endpoint, but before grid data rebinds + */ + igGridAppendRowsOnDemand(optionLiteral: 'option', optionName: "rowsRequested"): RowsRequestedEvent; + + /** + * Event fired after the requested rows are returned from the remote endpoint, but before grid data rebinds + * + * @optionValue Define event handler function. + */ + igGridAppendRowsOnDemand(optionLiteral: 'option', optionName: "rowsRequested", optionValue: RowsRequestedEvent): void; + igGridAppendRowsOnDemand(options: IgGridAppendRowsOnDemand): JQuery; + igGridAppendRowsOnDemand(optionLiteral: 'option', optionName: string): any; + igGridAppendRowsOnDemand(optionLiteral: 'option', options: IgGridAppendRowsOnDemand): JQuery; + igGridAppendRowsOnDemand(optionLiteral: 'option', optionName: string, optionValue: any): JQuery; + igGridAppendRowsOnDemand(methodName: string, ...methodParams: any[]): any; +} +interface CellsMergingEvent { + (event: Event, ui: CellsMergingEventUIParam): void; +} + +interface CellsMergingEventUIParam { +} + +interface CellsMergedEvent { + (event: Event, ui: CellsMergedEventUIParam): void; +} + +interface CellsMergedEventUIParam { +} + +interface IgGridCellMerging { + /** + * controls the initial state + * + * + * Valid values: + * "regular" the grid won't be initialized with cells merged + * "merged" the grid will be initialized with cells merged + */ + initialState?: string; + + /** + * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. + */ + inherit?: boolean; + + /** + * Event fired before a new merged cells group is created. + */ + cellsMerging?: CellsMergingEvent; + cellsMerged?: CellsMergedEvent; + + /** + * Option for igGridCellMerging + */ + [optionName: string]: any; +} +interface IgGridCellMergingMethods { + destroy(): void; +} +interface JQuery { + data(propertyName: "igGridCellMerging"): IgGridCellMergingMethods; +} + +interface JQuery { + igGridCellMerging(methodName: "destroy"): void; + + /** + * Controls the initial state + * + */ + igGridCellMerging(optionLiteral: 'option', optionName: "initialState"): string; + + /** + * Controls the initial state + * + * + * @optionValue New value to be set. + */ + igGridCellMerging(optionLiteral: 'option', optionName: "initialState", optionValue: string): void; + + /** + * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. + */ + igGridCellMerging(optionLiteral: 'option', optionName: "inherit"): boolean; + + /** + * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. + * + * @optionValue New value to be set. + */ + igGridCellMerging(optionLiteral: 'option', optionName: "inherit", optionValue: boolean): void; + + /** + * Event fired before a new merged cells group is created. + */ + igGridCellMerging(optionLiteral: 'option', optionName: "cellsMerging"): CellsMergingEvent; + + /** + * Event fired before a new merged cells group is created. + * + * @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; + igGridCellMerging(optionLiteral: 'option', options: IgGridCellMerging): JQuery; + igGridCellMerging(optionLiteral: 'option', optionName: string, optionValue: any): JQuery; + igGridCellMerging(methodName: string, ...methodParams: any[]): any; +} +interface IgGridColumnFixingColumnSetting { + /** + * Identifies the grid column by key. Either key or index must be set in every column setting. + * + */ + columnKey?: string; + + /** + * Identifies the grid column by index. Either key or index must be set in every column setting. + * + */ + columnIndex?: number; + + /** + * Specifies whether the column can be fixed or not. If allow fixing is false, then the fixing pin will not be rendered for the column. + * + */ + allowFixing?: boolean; + + /** + * Specifies whether the column is initially fixed or not. Check [this topic](http://www.igniteui.com/help/iggrid-columnfixing-configuring#initial-state) out for more information. + * + */ + isFixed?: boolean; + + /** + * Option for IgGridColumnFixingColumnSetting + */ + [optionName: string]: any; +} + +interface ColumnFixingEvent { + (event: Event, ui: ColumnFixingEventUIParam): void; +} + +interface ColumnFixingEventUIParam { +} + +interface ColumnFixedEvent { + (event: Event, ui: ColumnFixedEventUIParam): void; +} + +interface ColumnFixedEventUIParam { +} + +interface ColumnUnfixingEvent { + (event: Event, ui: ColumnUnfixingEventUIParam): void; +} + +interface ColumnUnfixingEventUIParam { +} + +interface ColumnUnfixedEvent { + (event: Event, ui: ColumnUnfixedEventUIParam): void; +} + +interface ColumnUnfixedEventUIParam { +} + +interface ColumnFixingRefusedEvent { + (event: Event, ui: ColumnFixingRefusedEventUIParam): void; +} + +interface ColumnFixingRefusedEventUIParam { +} + +interface ColumnUnfixingRefusedEvent { + (event: Event, ui: ColumnUnfixingRefusedEventUIParam): void; +} + +interface ColumnUnfixingRefusedEventUIParam { +} + +interface IgGridColumnFixing { + /** + * Specifies the tooltip text on the column fixing header icon when column is not fixed. + * + */ + headerFixButtonText?: string; + + /** + * Specifies the tooltip text on the column fixing header icon when column is fixed. + * + */ + headerUnfixButtonText?: string; + + /** + * Specifies whether to show the column fixing buttons in header cells/feature chooser. + * + */ + showFixButtons?: boolean; + + /** + * Enable row height sync for the fixed and unfixed portion of the grid. If you're observing row misalignment, please refer to [this article](http://www.igniteui.com/help/iggrid-known-issues#misalignment-ie9). + * + */ + syncRowHeights?: boolean; + + /** + * Scroll delta in pixels when scrolling with the mouse wheel or the keyboard in the fixed columns area of the grid. + * + */ + scrollDelta?: number; + + /** + * 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. + * + * + * Valid values: + * "left" Fixed columns are rendered on the left side of the main grid. + * "right" Fixed columns are rendered on the right side of the main grid. + */ + fixingDirection?: string; + + /** + * List of column settings that specifies custom column fixing options on a per column basis. + * + */ + columnSettings?: IgGridColumnFixingColumnSetting[]; + + /** + * Text of the feature chooser button for fixing a currently unfixed column. + * + */ + featureChooserTextFixedColumn?: string; + + /** + * Text of the feature chooser button for unfixing a currently fixed column. + * + */ + featureChooserTextUnfixedColumn?: string; + + /** + * 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. + * + * + * Valid values: + * "string" The width can be set in pixels (px) and percentage (%). + * "number" The width can be set in pixels as a number. + */ + minimalVisibleAreaWidth?: string|number; + + /** + * Specify initial fixing of all non data columns. Non-data columns are columns in the grid rendered for specific features, like the row selectors feature. The column containing the row numbering is such a column. This option is applicable when [fixingDirection](ui.iggridcolumnfixing#options:fixingDirection) is set to left. For a full column fixing configuration summary please refer to [this topic](http://www.igniteui.com/help/iggrid-columnfixing-configuring#configuration-summary). + * + */ + fixNondataColumns?: boolean; + + /** + * When true all the TR DOM attributes of the unfixed row will be copied to the fixed row. Note that when enabled this option negatively affects performance when fixing a column. + */ + populateDataRowsAttributes?: boolean; + + /** + * Event which is fired when column fixing operation is initiated. + */ + columnFixing?: ColumnFixingEvent; + + /** + * Event which is fired when column fixing operation is finished + */ + columnFixed?: ColumnFixedEvent; + + /** + * Event which is fired when column unfixing operation is initiated + */ + columnUnfixing?: ColumnUnfixingEvent; + + /** + * Event which is fired when column unfixing operation is done + */ + columnUnfixed?: ColumnUnfixedEvent; + + /** + * Event which is fired when column fixing operation has failed - e.g. sum of the width of the fixed columns container and width of the column to be fixed exceeds the grid width + */ + columnFixingRefused?: ColumnFixingRefusedEvent; + + /** + * Event which is fired when column unfixing operation has failed - e.g.: there is only one fixed visible column(and tries to unfix it) and at least one fixed hidden column + */ + columnUnfixingRefused?: ColumnUnfixingRefusedEvent; + + /** + * Option for igGridColumnFixing + */ + [optionName: string]: any; +} +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. + */ + unfixColumn(colIdentifier: Object, target?: string, after?: boolean): Object; + + /** + * Checks whether the heights of fixed and unfixed tables are equal - if not sync them. Similar check is made for heights of table rows. + */ + checkAndSyncHeights(): void; + + /** + * 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. + */ + 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. + */ + 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. + */ + 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. + */ + 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. + */ + fixColumn(colIdentifier: Object, target?: string, after?: boolean): Object; + + /** + * Fixes non-data columns (such as the row numbering column of row selectors) if any and if [fixingDirection](ui.iggridcolumnfixing#options:fixingDirection) is left. Does nothing if the non-data columns are already fixed. + */ + fixNonDataColumns(): void; + + /** + * This function is deprecated - use function fixNonDataColumns. + */ + fixDataSkippedColumns(): void; + + /** + * Unfixes non-data columns (such as the row numbering column of row selectors) if any and if [fixingDirection](ui.iggridcolumnfixing#options:fixingDirection) is left. Does nothing if the non-data columns are already fixed. + */ + unfixNonDataColumns(): void; + + /** + * This function is deprecated - use function unfixNonDataColumns. + */ + unfixDataSkippedColumns(): void; + + /** + * Unfixes all fixed columns. + */ + unfixAllColumns(): void; + + /** + * 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. + */ + 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). + */ + getWidthOfFixedColumns(fCols?: any[], excludeNonDataColumns?: boolean, includeHidden?: boolean): number; + + /** + * Destroys the column fixing widget + */ + destroy(): void; +} +interface JQuery { + data(propertyName: "igGridColumnFixing"): IgGridColumnFixingMethods; +} + +interface JQuery { + igGridColumnFixing(methodName: "unfixColumn", colIdentifier: Object, target?: string, after?: boolean): Object; + igGridColumnFixing(methodName: "checkAndSyncHeights"): void; + igGridColumnFixing(methodName: "syncHeights", check?: boolean, clearRowsHeights?: boolean): void; + igGridColumnFixing(methodName: "isGroupHeader", colKey: string): boolean; + igGridColumnFixing(methodName: "checkFixingAllowed", columns: any[]): boolean; + igGridColumnFixing(methodName: "checkUnfixingAllowed", columns: any[]): boolean; + igGridColumnFixing(methodName: "fixColumn", colIdentifier: Object, target?: string, after?: boolean): Object; + igGridColumnFixing(methodName: "fixNonDataColumns"): void; + igGridColumnFixing(methodName: "fixDataSkippedColumns"): void; + igGridColumnFixing(methodName: "unfixNonDataColumns"): void; + igGridColumnFixing(methodName: "unfixDataSkippedColumns"): void; + igGridColumnFixing(methodName: "unfixAllColumns"): void; + igGridColumnFixing(methodName: "syncRowsHeights", $trs: any[], $anotherRows: any[]): void; + igGridColumnFixing(methodName: "getWidthOfFixedColumns", fCols?: any[], excludeNonDataColumns?: boolean, includeHidden?: boolean): number; + igGridColumnFixing(methodName: "destroy"): void; + + /** + * Gets the tooltip text on the column fixing header icon when column is not fixed. + * + */ + igGridColumnFixing(optionLiteral: 'option', optionName: "headerFixButtonText"): string; + + /** + * Sets the tooltip text on the column fixing header icon when column is not fixed. + * + * + * @optionValue New value to be set. + */ + igGridColumnFixing(optionLiteral: 'option', optionName: "headerFixButtonText", optionValue: string): void; + + /** + * Gets the tooltip text on the column fixing header icon when column is fixed. + * + */ + igGridColumnFixing(optionLiteral: 'option', optionName: "headerUnfixButtonText"): string; + + /** + * Sets the tooltip text on the column fixing header icon when column is fixed. + * + * + * @optionValue New value to be set. + */ + igGridColumnFixing(optionLiteral: 'option', optionName: "headerUnfixButtonText", optionValue: string): void; + + /** + * Gets whether to show the column fixing buttons in header cells/feature chooser. + * + */ + igGridColumnFixing(optionLiteral: 'option', optionName: "showFixButtons"): boolean; + + /** + * Sets whether to show the column fixing buttons in header cells/feature chooser. + * + * + * @optionValue New value to be set. + */ + igGridColumnFixing(optionLiteral: 'option', optionName: "showFixButtons", optionValue: boolean): void; + + /** + * Enable row height sync for the fixed and unfixed portion of the grid. If you're observing row misalignment, please refer to [this article](http://www.igniteui.com/help/iggrid-known-issues#misalignment-ie9). + * + */ + igGridColumnFixing(optionLiteral: 'option', optionName: "syncRowHeights"): boolean; + + /** + * Enable row height sync for the fixed and unfixed portion of the grid. If you're observing row misalignment, please refer to [this article](http://www.igniteui.com/help/iggrid-known-issues#misalignment-ie9). + * + * + * @optionValue New value to be set. + */ + igGridColumnFixing(optionLiteral: 'option', optionName: "syncRowHeights", optionValue: boolean): void; + + /** + * Scroll delta in pixels when scrolling with the mouse wheel or the keyboard in the fixed columns area of the grid. + * + */ + igGridColumnFixing(optionLiteral: 'option', optionName: "scrollDelta"): number; + + /** + * Scroll delta in pixels when scrolling with the mouse wheel or the keyboard in the fixed columns area of the grid. + * + * + * @optionValue New value to be set. + */ + igGridColumnFixing(optionLiteral: 'option', optionName: "scrollDelta", optionValue: number): void; + + /** + * 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; + + /** + * 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. + * + * + * @optionValue New value to be set. + */ + igGridColumnFixing(optionLiteral: 'option', optionName: "fixingDirection", optionValue: string): void; + + /** + * List of column settings that specifies custom column fixing options on a per column basis. + * + */ + igGridColumnFixing(optionLiteral: 'option', optionName: "columnSettings"): IgGridColumnFixingColumnSetting[]; + + /** + * List of column settings that specifies custom column fixing options on a per column basis. + * + * + * @optionValue New value to be set. + */ + igGridColumnFixing(optionLiteral: 'option', optionName: "columnSettings", optionValue: IgGridColumnFixingColumnSetting[]): void; + + /** + * Text of the feature chooser button for fixing a currently unfixed column. + * + */ + igGridColumnFixing(optionLiteral: 'option', optionName: "featureChooserTextFixedColumn"): string; + + /** + * Text of the feature chooser button for fixing a currently unfixed column. + * + * + * @optionValue New value to be set. + */ + igGridColumnFixing(optionLiteral: 'option', optionName: "featureChooserTextFixedColumn", optionValue: string): void; + + /** + * Text of the feature chooser button for unfixing a currently fixed column. + * + */ + igGridColumnFixing(optionLiteral: 'option', optionName: "featureChooserTextUnfixedColumn"): string; + + /** + * Text of the feature chooser button for unfixing a currently fixed column. + * + * + * @optionValue New value to be set. + */ + igGridColumnFixing(optionLiteral: 'option', optionName: "featureChooserTextUnfixedColumn", optionValue: string): void; + + /** + * 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; + + /** + * 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. + * + * + * @optionValue New value to be set. + */ + igGridColumnFixing(optionLiteral: 'option', optionName: "minimalVisibleAreaWidth", optionValue: string|number): void; + + /** + * Specify initial fixing of all non data columns. Non-data columns are columns in the grid rendered for specific features, like the row selectors feature. The column containing the row numbering is such a column. This option is applicable when [fixingDirection](ui.iggridcolumnfixing#options:fixingDirection) is set to left. For a full column fixing configuration summary please refer to [this topic](http://www.igniteui.com/help/iggrid-columnfixing-configuring#configuration-summary). + * + */ + igGridColumnFixing(optionLiteral: 'option', optionName: "fixNondataColumns"): boolean; + + /** + * Specify initial fixing of all non data columns. Non-data columns are columns in the grid rendered for specific features, like the row selectors feature. The column containing the row numbering is such a column. This option is applicable when [fixingDirection](ui.iggridcolumnfixing#options:fixingDirection) is set to left. For a full column fixing configuration summary please refer to [this topic](http://www.igniteui.com/help/iggrid-columnfixing-configuring#configuration-summary). + * + * + * @optionValue New value to be set. + */ + igGridColumnFixing(optionLiteral: 'option', optionName: "fixNondataColumns", optionValue: boolean): void; + + /** + * When true all the TR DOM attributes of the unfixed row will be copied to the fixed row. Note that when enabled this option negatively affects performance when fixing a column. + */ + igGridColumnFixing(optionLiteral: 'option', optionName: "populateDataRowsAttributes"): boolean; + + /** + * When true all the TR DOM attributes of the unfixed row will be copied to the fixed row. Note that when enabled this option negatively affects performance when fixing a column. + * + * @optionValue New value to be set. + */ + igGridColumnFixing(optionLiteral: 'option', optionName: "populateDataRowsAttributes", optionValue: boolean): void; + + /** + * Event which is fired when column fixing operation is initiated. + */ + igGridColumnFixing(optionLiteral: 'option', optionName: "columnFixing"): ColumnFixingEvent; + + /** + * Event which is fired when column fixing operation is initiated. + * + * @optionValue Define event handler function. + */ + igGridColumnFixing(optionLiteral: 'option', optionName: "columnFixing", optionValue: ColumnFixingEvent): void; + + /** + * Event which is fired when column fixing operation is finished + */ + igGridColumnFixing(optionLiteral: 'option', optionName: "columnFixed"): ColumnFixedEvent; + + /** + * Event which is fired when column fixing operation is finished + * + * @optionValue Define event handler function. + */ + igGridColumnFixing(optionLiteral: 'option', optionName: "columnFixed", optionValue: ColumnFixedEvent): void; + + /** + * Event which is fired when column unfixing operation is initiated + */ + igGridColumnFixing(optionLiteral: 'option', optionName: "columnUnfixing"): ColumnUnfixingEvent; + + /** + * Event which is fired when column unfixing operation is initiated + * + * @optionValue Define event handler function. + */ + igGridColumnFixing(optionLiteral: 'option', optionName: "columnUnfixing", optionValue: ColumnUnfixingEvent): void; + + /** + * Event which is fired when column unfixing operation is done + */ + igGridColumnFixing(optionLiteral: 'option', optionName: "columnUnfixed"): ColumnUnfixedEvent; + + /** + * Event which is fired when column unfixing operation is done + * + * @optionValue Define event handler function. + */ + igGridColumnFixing(optionLiteral: 'option', optionName: "columnUnfixed", optionValue: ColumnUnfixedEvent): void; + + /** + * Event which is fired when column fixing operation has failed - e.g. sum of the width of the fixed columns container and width of the column to be fixed exceeds the grid width + */ + igGridColumnFixing(optionLiteral: 'option', optionName: "columnFixingRefused"): ColumnFixingRefusedEvent; + + /** + * Event which is fired when column fixing operation has failed - e.g. sum of the width of the fixed columns container and width of the column to be fixed exceeds the grid width + * + * @optionValue Define event handler function. + */ + igGridColumnFixing(optionLiteral: 'option', optionName: "columnFixingRefused", optionValue: ColumnFixingRefusedEvent): void; + + /** + * Event which is fired when column unfixing operation has failed - e.g.: there is only one fixed visible column(and tries to unfix it) and at least one fixed hidden column + */ + igGridColumnFixing(optionLiteral: 'option', optionName: "columnUnfixingRefused"): ColumnUnfixingRefusedEvent; + + /** + * Event which is fired when column unfixing operation has failed - e.g.: there is only one fixed visible column(and tries to unfix it) and at least one fixed hidden column + * + * @optionValue Define event handler function. + */ + igGridColumnFixing(optionLiteral: 'option', optionName: "columnUnfixingRefused", optionValue: ColumnUnfixingRefusedEvent): void; + igGridColumnFixing(options: IgGridColumnFixing): JQuery; + igGridColumnFixing(optionLiteral: 'option', optionName: string): any; + igGridColumnFixing(optionLiteral: 'option', options: IgGridColumnFixing): JQuery; + igGridColumnFixing(optionLiteral: 'option', optionName: string, optionValue: any): JQuery; + igGridColumnFixing(methodName: string, ...methodParams: any[]): any; +} +interface IgGridColumnMovingColumnSetting { + /** + * Column key. This is a required property in every column setting if columnIndex is not set. + * + */ + columnKey?: string; + + /** + * Column index. Can be used in place of column key. The preferred way of populating a column setting is to always use the column keys as identifiers. + * + */ + columnIndex?: number; + + /** + * Allows the column to be moved. + * + */ + allowMoving?: boolean; + + /** + * Option for IgGridColumnMovingColumnSetting + */ + [optionName: string]: any; +} + +interface ColumnDragStartEvent { + (event: Event, ui: ColumnDragStartEventUIParam): void; +} + +interface ColumnDragStartEventUIParam { +} + +interface ColumnDragEndEvent { + (event: Event, ui: ColumnDragEndEventUIParam): void; +} + +interface ColumnDragEndEventUIParam { +} + +interface ColumnDragCanceledEvent { + (event: Event, ui: ColumnDragCanceledEventUIParam): void; +} + +interface ColumnDragCanceledEventUIParam { +} + +interface ColumnMovingEvent { + (event: Event, ui: ColumnMovingEventUIParam): void; +} + +interface ColumnMovingEventUIParam { +} + +interface ColumnMovedEvent { + (event: Event, ui: ColumnMovedEventUIParam): void; +} + +interface ColumnMovedEventUIParam { +} + +interface MovingDialogOpeningEvent { + (event: Event, ui: MovingDialogOpeningEventUIParam): void; +} + +interface MovingDialogOpeningEventUIParam { +} + +interface MovingDialogOpenedEvent { + (event: Event, ui: MovingDialogOpenedEventUIParam): void; +} + +interface MovingDialogOpenedEventUIParam { +} + +interface MovingDialogDraggedEvent { + (event: Event, ui: MovingDialogDraggedEventUIParam): void; +} + +interface MovingDialogDraggedEventUIParam { +} + +interface MovingDialogClosingEvent { + (event: Event, ui: MovingDialogClosingEventUIParam): void; +} + +interface MovingDialogClosingEventUIParam { +} + +interface MovingDialogClosedEvent { + (event: Event, ui: MovingDialogClosedEventUIParam): void; +} + +interface MovingDialogClosedEventUIParam { +} + +interface MovingDialogContentsRenderingEvent { + (event: Event, ui: MovingDialogContentsRenderingEventUIParam): void; +} + +interface MovingDialogContentsRenderingEventUIParam { +} + +interface MovingDialogContentsRenderedEvent { + (event: Event, ui: MovingDialogContentsRenderedEventUIParam): void; +} + +interface MovingDialogContentsRenderedEventUIParam { +} + +interface MovingDialogMoveUpButtonPressedEvent { + (event: Event, ui: MovingDialogMoveUpButtonPressedEventUIParam): void; +} + +interface MovingDialogMoveUpButtonPressedEventUIParam { +} + +interface MovingDialogMoveDownButtonPressedEvent { + (event: Event, ui: MovingDialogMoveDownButtonPressedEventUIParam): void; +} + +interface MovingDialogMoveDownButtonPressedEventUIParam { +} + +interface MovingDialogDragColumnMovingEvent { + (event: Event, ui: MovingDialogDragColumnMovingEventUIParam): void; +} + +interface MovingDialogDragColumnMovingEventUIParam { +} + +interface MovingDialogDragColumnMovedEvent { + (event: Event, ui: MovingDialogDragColumnMovedEventUIParam): void; +} + +interface MovingDialogDragColumnMovedEventUIParam { +} + +interface IgGridColumnMoving { + /** + * A list of column settings that specifies moving options on a per column basis. + * + */ + columnSettings?: IgGridColumnMovingColumnSetting[]; + + /** + * Specify the drag-and-drop mode for the feature + * + * + * Valid values: + * "immediate" Column headers will rearange as you drag with a space opening under the cursor for the header to be dropped on + * "deferred" A clone of the header dragged will be created and indicators will be shown between columns to help navigate the drop. + */ + mode?: string; + + /** + * Specify the way columns will be rearranged + * + * + * Valid values: + * "dom" Columns will be rearranged through dom manipulation + * "render" Columns will not be rearranged but the grid will be rendered again with the new column order. Please note this option is incompatible with immediate move mode. + */ + moveType?: string; + + /** + * Specifies if header cells should include an additional button that opens a moving helper dropdown. + * + */ + addMovingDropdown?: boolean; + + /** + * Specifies width of column moving dialog + * + */ + movingDialogWidth?: number; + + /** + * Specifies height of column moving dialog + * + */ + movingDialogHeight?: number; + + /** + * Specifies time in milliseconds for animation duration to show/hide modal dialog + * + */ + movingDialogAnimationDuration?: number; + + /** + * Specifies the length (in pixels) between the dragged column and the column edges below which the move operation is accepted + * + */ + movingAcceptanceTolerance?: number; + + /** + * Specifies the length (in pixels) between the dragged column and the grid edges below which horizontal scrolling occurs + * + */ + movingScrollTolerance?: number; + + /** + * Specifies a multiplier for the delay between subsequent scroll operations. The larger this number is, the slower scrolling will appear to be. + * + */ + scrollSpeedMultiplier?: number; + + /** + * Specifies the length (in pixels) of each individual scroll operation + * + */ + scrollDelta?: number; + + /** + * Specifies whether the contents of the column being dragged will get hidden. The option is only + * relevant in immediate moving mode. + * + */ + hideHeaderContentsDuringDrag?: boolean; + + /** + * Specifies the opacity of the drag markup, while a column header is being dragged. + * The value must be between 0 and 1. When GroupBy is enabled, the corresponding option in the GroupBy configuration + * will be used with priority over this one. + * + */ + dragHelperOpacity?: number; + + /** + * Specifies caption for each move down button in the column moving dialog + * + */ + movingDialogCaptionButtonDesc?: string; + + /** + * Specifies caption for each move up button in the column moving dialog + * + */ + movingDialogCaptionButtonAsc?: string; + + /** + * Specifies caption text for the column moving dialog + * + */ + movingDialogCaptionText?: string; + + /** + * Specifies caption text for the feature chooser entry + * + */ + movingDialogDisplayText?: string; + + /** + * Specifies text for drop tooltip in column moving dialog + * + */ + movingDialogDropTooltipText?: string; + + /** + * Specifies markup for drop tooltip in column moving dialog + * + */ + movingDialogDropTooltipMarkup?: string; + + /** + * Specifies caption for the move left dropdown button + * + */ + dropDownMoveLeftText?: string; + + /** + * Specifies caption for the move right dropdown button + * + */ + dropDownMoveRightText?: string; + + /** + * Specifies caption for the move first dropdown button + * + */ + dropDownMoveFirstText?: string; + + /** + * Specifies caption for the move last dropdown button + * + */ + dropDownMoveLastText?: string; + + /** + * Specifies tooltip text for the move indicator + * + */ + movingToolTipMove?: string; + + /** + * Specifies caption text for the feature chooser submenu button + * + */ + featureChooserSubmenuText?: string; + + /** + * Controls containment behavior of column moving dialog. + * + * owner The dialog will be draggable only in the grid area + * window The dialog will be draggable in the whole window area + */ + columnMovingDialogContainment?: string; + + /** + * Name of the dialog widget to be used. It should inherit from $.ui.igGridModalDialog. + * + */ + dialogWidget?: string; + + /** + * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. + */ + inherit?: boolean; + + /** + * Event which is fired when a drag operation begins on a column header + */ + columnDragStart?: ColumnDragStartEvent; + + /** + * Event which is fired when a drag operation ends on a column header + */ + columnDragEnd?: ColumnDragEndEvent; + + /** + * Event which is fired when a drag operation is canceled + */ + columnDragCanceled?: ColumnDragCanceledEvent; + + /** + * Event which is fired when a column moving operation is initiated + */ + columnMoving?: ColumnMovingEvent; + + /** + * Event which is fired when a column moving operation completes + */ + columnMoved?: ColumnMovedEvent; + + /** + * Event fired before the moving dialog is opened. + */ + movingDialogOpening?: MovingDialogOpeningEvent; + + /** + * Event fired after the column chooser is already opened. + */ + movingDialogOpened?: MovingDialogOpenedEvent; + + /** + * Event fired every time the moving dialog changes its position. + */ + movingDialogDragged?: MovingDialogDraggedEvent; + + /** + * Event fired before the moving dialog is closed. + */ + movingDialogClosing?: MovingDialogClosingEvent; + + /** + * Event fired after the moving dialog has been closed. + */ + movingDialogClosed?: MovingDialogClosedEvent; + + /** + * Event fired before the contents of the model dialog are rendered. + */ + movingDialogContentsRendering?: MovingDialogContentsRenderingEvent; + + /** + * Event fired after the contents of the model dialog are rendered. + */ + movingDialogContentsRendered?: MovingDialogContentsRenderedEvent; + + /** + * Event fired when move up button is pressed in the moving dialog + */ + movingDialogMoveUpButtonPressed?: MovingDialogMoveUpButtonPressedEvent; + + /** + * Event fired when move down button is pressed in the moving dialog + */ + movingDialogMoveDownButtonPressed?: MovingDialogMoveDownButtonPressedEvent; + + /** + * Event fired when column moving is initiated through dragging it in the moving dialog + */ + movingDialogDragColumnMoving?: MovingDialogDragColumnMovingEvent; + + /** + * Event fired when column moving is completed through dragging it in the moving dialog + */ + movingDialogDragColumnMoved?: MovingDialogDragColumnMovedEvent; + + /** + * Option for igGridColumnMoving + */ + [optionName: string]: any; +} +interface IgGridColumnMovingMethods { + /** + * Restoring overwritten functions + */ + destroy(): void; + + /** + * 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. + */ + moveColumn(column: Object, target: Object, after?: boolean, inDom?: boolean, callback?: Function): void; +} +interface JQuery { + data(propertyName: "igGridColumnMoving"): IgGridColumnMovingMethods; +} + +interface JQuery { + igGridColumnMoving(methodName: "destroy"): void; + igGridColumnMoving(methodName: "moveColumn", column: Object, target: Object, after?: boolean, inDom?: boolean, callback?: Function): void; + + /** + * A list of column settings that specifies moving options on a per column basis. + * + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "columnSettings"): IgGridColumnMovingColumnSetting[]; + + /** + * A list of column settings that specifies moving options on a per column basis. + * + * + * @optionValue New value to be set. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "columnSettings", optionValue: IgGridColumnMovingColumnSetting[]): void; + + /** + * Specify the drag-and-drop mode for the feature + * + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "mode"): string; + + /** + * Specify the drag-and-drop mode for the feature + * + * + * @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; + + /** + * Specify the way columns will be rearranged + * + * + * @optionValue New value to be set. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "moveType", optionValue: string): void; + + /** + * Gets if header cells should include an additional button that opens a moving helper dropdown. + * + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "addMovingDropdown"): boolean; + + /** + * Sets if header cells should include an additional button that opens a moving helper dropdown. + * + * + * @optionValue New value to be set. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "addMovingDropdown", optionValue: boolean): void; + + /** + * Gets width of column moving dialog + * + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogWidth"): number; + + /** + * Sets width of column moving dialog + * + * + * @optionValue New value to be set. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogWidth", optionValue: number): void; + + /** + * Gets height of column moving dialog + * + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogHeight"): number; + + /** + * Sets height of column moving dialog + * + * + * @optionValue New value to be set. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogHeight", optionValue: number): void; + + /** + * Gets time in milliseconds for animation duration to show/hide modal dialog + * + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogAnimationDuration"): number; + + /** + * Sets time in milliseconds for animation duration to show/hide modal dialog + * + * + * @optionValue New value to be set. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogAnimationDuration", optionValue: number): void; + + /** + * Gets the length (in pixels) between the dragged column and the column edges below which the move operation is accepted + * + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingAcceptanceTolerance"): number; + + /** + * Sets the length (in pixels) between the dragged column and the column edges below which the move operation is accepted + * + * + * @optionValue New value to be set. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingAcceptanceTolerance", optionValue: number): void; + + /** + * Gets the length (in pixels) between the dragged column and the grid edges below which horizontal scrolling occurs + * + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingScrollTolerance"): number; + + /** + * Sets the length (in pixels) between the dragged column and the grid edges below which horizontal scrolling occurs + * + * + * @optionValue New value to be set. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingScrollTolerance", optionValue: number): void; + + /** + * Gets a multiplier for the delay between subsequent scroll operations. The larger this number is, the slower scrolling will appear to be. + * + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "scrollSpeedMultiplier"): number; + + /** + * Sets a multiplier for the delay between subsequent scroll operations. The larger this number is, the slower scrolling will appear to be. + * + * + * @optionValue New value to be set. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "scrollSpeedMultiplier", optionValue: number): void; + + /** + * Gets the length (in pixels) of each individual scroll operation + * + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "scrollDelta"): number; + + /** + * Sets the length (in pixels) of each individual scroll operation + * + * + * @optionValue New value to be set. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "scrollDelta", optionValue: number): void; + + /** + * Gets whether the contents of the column being dragged will get hidden. The option is only + * relevant in immediate moving mode. + * + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "hideHeaderContentsDuringDrag"): boolean; + + /** + * Sets whether the contents of the column being dragged will get hidden. The option is only + * relevant in immediate moving mode. + * + * + * @optionValue New value to be set. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "hideHeaderContentsDuringDrag", optionValue: boolean): void; + + /** + * Gets the opacity of the drag markup, while a column header is being dragged. + * The value must be between 0 and 1. When GroupBy is enabled, the corresponding option in the GroupBy configuration + * will be used with priority over this one. + * + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "dragHelperOpacity"): number; + + /** + * Sets the opacity of the drag markup, while a column header is being dragged. + * The value must be between 0 and 1. When GroupBy is enabled, the corresponding option in the GroupBy configuration + * will be used with priority over this one. + * + * + * @optionValue New value to be set. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "dragHelperOpacity", optionValue: number): void; + + /** + * Gets caption for each move down button in the column moving dialog + * + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogCaptionButtonDesc"): string; + + /** + * Sets caption for each move down button in the column moving dialog + * + * + * @optionValue New value to be set. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogCaptionButtonDesc", optionValue: string): void; + + /** + * Gets caption for each move up button in the column moving dialog + * + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogCaptionButtonAsc"): string; + + /** + * Sets caption for each move up button in the column moving dialog + * + * + * @optionValue New value to be set. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogCaptionButtonAsc", optionValue: string): void; + + /** + * Gets caption text for the column moving dialog + * + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogCaptionText"): string; + + /** + * Sets caption text for the column moving dialog + * + * + * @optionValue New value to be set. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogCaptionText", optionValue: string): void; + + /** + * Gets caption text for the feature chooser entry + * + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogDisplayText"): string; + + /** + * Sets caption text for the feature chooser entry + * + * + * @optionValue New value to be set. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogDisplayText", optionValue: string): void; + + /** + * Gets text for drop tooltip in column moving dialog + * + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogDropTooltipText"): string; + + /** + * Sets text for drop tooltip in column moving dialog + * + * + * @optionValue New value to be set. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogDropTooltipText", optionValue: string): void; + + /** + * Gets markup for drop tooltip in column moving dialog + * + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogDropTooltipMarkup"): string; + + /** + * Sets markup for drop tooltip in column moving dialog + * + * + * @optionValue New value to be set. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogDropTooltipMarkup", optionValue: string): void; + + /** + * Gets caption for the move left dropdown button + * + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "dropDownMoveLeftText"): string; + + /** + * Sets caption for the move left dropdown button + * + * + * @optionValue New value to be set. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "dropDownMoveLeftText", optionValue: string): void; + + /** + * Gets caption for the move right dropdown button + * + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "dropDownMoveRightText"): string; + + /** + * Sets caption for the move right dropdown button + * + * + * @optionValue New value to be set. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "dropDownMoveRightText", optionValue: string): void; + + /** + * Gets caption for the move first dropdown button + * + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "dropDownMoveFirstText"): string; + + /** + * Sets caption for the move first dropdown button + * + * + * @optionValue New value to be set. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "dropDownMoveFirstText", optionValue: string): void; + + /** + * Gets caption for the move last dropdown button + * + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "dropDownMoveLastText"): string; + + /** + * Sets caption for the move last dropdown button + * + * + * @optionValue New value to be set. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "dropDownMoveLastText", optionValue: string): void; + + /** + * Gets tooltip text for the move indicator + * + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingToolTipMove"): string; + + /** + * Sets tooltip text for the move indicator + * + * + * @optionValue New value to be set. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingToolTipMove", optionValue: string): void; + + /** + * Gets caption text for the feature chooser submenu button + * + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "featureChooserSubmenuText"): string; + + /** + * Sets caption text for the feature chooser submenu button + * + * + * @optionValue New value to be set. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "featureChooserSubmenuText", optionValue: string): void; + + /** + * Controls containment behavior of column moving dialog. + * + * owner The dialog will be draggable only in the grid area + * window The dialog will be draggable in the whole window area + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "columnMovingDialogContainment"): string; + + /** + * Controls containment behavior of column moving dialog. + * + * owner The dialog will be draggable only in the grid area + * window The dialog will be draggable in the whole window area + * + * @optionValue New value to be set. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "columnMovingDialogContainment", optionValue: string): void; + + /** + * Name of the dialog widget to be used. It should inherit from $.ui.igGridModalDialog. + * + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "dialogWidget"): string; + + /** + * Name of the dialog widget to be used. It should inherit from $.ui.igGridModalDialog. + * + * + * @optionValue New value to be set. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "dialogWidget", optionValue: string): void; + + /** + * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "inherit"): boolean; + + /** + * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. + * + * @optionValue New value to be set. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "inherit", optionValue: boolean): void; + + /** + * Event which is fired when a drag operation begins on a column header + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "columnDragStart"): ColumnDragStartEvent; + + /** + * Event which is fired when a drag operation begins on a column header + * + * @optionValue Define event handler function. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "columnDragStart", optionValue: ColumnDragStartEvent): void; + + /** + * Event which is fired when a drag operation ends on a column header + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "columnDragEnd"): ColumnDragEndEvent; + + /** + * Event which is fired when a drag operation ends on a column header + * + * @optionValue Define event handler function. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "columnDragEnd", optionValue: ColumnDragEndEvent): void; + + /** + * Event which is fired when a drag operation is canceled + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "columnDragCanceled"): ColumnDragCanceledEvent; + + /** + * Event which is fired when a drag operation is canceled + * + * @optionValue Define event handler function. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "columnDragCanceled", optionValue: ColumnDragCanceledEvent): void; + + /** + * Event which is fired when a column moving operation is initiated + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "columnMoving"): ColumnMovingEvent; + + /** + * Event which is fired when a column moving operation is initiated + * + * @optionValue Define event handler function. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "columnMoving", optionValue: ColumnMovingEvent): void; + + /** + * Event which is fired when a column moving operation completes + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "columnMoved"): ColumnMovedEvent; + + /** + * Event which is fired when a column moving operation completes + * + * @optionValue Define event handler function. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "columnMoved", optionValue: ColumnMovedEvent): void; + + /** + * Event fired before the moving dialog is opened. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogOpening"): MovingDialogOpeningEvent; + + /** + * Event fired before the moving dialog is opened. + * + * @optionValue Define event handler function. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogOpening", optionValue: MovingDialogOpeningEvent): void; + + /** + * Event fired after the column chooser is already opened. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogOpened"): MovingDialogOpenedEvent; + + /** + * Event fired after the column chooser is already opened. + * + * @optionValue Define event handler function. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogOpened", optionValue: MovingDialogOpenedEvent): void; + + /** + * Event fired every time the moving dialog changes its position. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogDragged"): MovingDialogDraggedEvent; + + /** + * Event fired every time the moving dialog changes its position. + * + * @optionValue Define event handler function. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogDragged", optionValue: MovingDialogDraggedEvent): void; + + /** + * Event fired before the moving dialog is closed. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogClosing"): MovingDialogClosingEvent; + + /** + * Event fired before the moving dialog is closed. + * + * @optionValue Define event handler function. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogClosing", optionValue: MovingDialogClosingEvent): void; + + /** + * Event fired after the moving dialog has been closed. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogClosed"): MovingDialogClosedEvent; + + /** + * Event fired after the moving dialog has been closed. + * + * @optionValue Define event handler function. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogClosed", optionValue: MovingDialogClosedEvent): void; + + /** + * Event fired before the contents of the model dialog are rendered. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogContentsRendering"): MovingDialogContentsRenderingEvent; + + /** + * Event fired before the contents of the model dialog are rendered. + * + * @optionValue Define event handler function. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogContentsRendering", optionValue: MovingDialogContentsRenderingEvent): void; + + /** + * Event fired after the contents of the model dialog are rendered. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogContentsRendered"): MovingDialogContentsRenderedEvent; + + /** + * Event fired after the contents of the model dialog are rendered. + * + * @optionValue Define event handler function. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogContentsRendered", optionValue: MovingDialogContentsRenderedEvent): void; + + /** + * Event fired when move up button is pressed in the moving dialog + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogMoveUpButtonPressed"): MovingDialogMoveUpButtonPressedEvent; + + /** + * Event fired when move up button is pressed in the moving dialog + * + * @optionValue Define event handler function. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogMoveUpButtonPressed", optionValue: MovingDialogMoveUpButtonPressedEvent): void; + + /** + * Event fired when move down button is pressed in the moving dialog + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogMoveDownButtonPressed"): MovingDialogMoveDownButtonPressedEvent; + + /** + * Event fired when move down button is pressed in the moving dialog + * + * @optionValue Define event handler function. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogMoveDownButtonPressed", optionValue: MovingDialogMoveDownButtonPressedEvent): void; + + /** + * Event fired when column moving is initiated through dragging it in the moving dialog + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogDragColumnMoving"): MovingDialogDragColumnMovingEvent; + + /** + * Event fired when column moving is initiated through dragging it in the moving dialog + * + * @optionValue Define event handler function. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogDragColumnMoving", optionValue: MovingDialogDragColumnMovingEvent): void; + + /** + * Event fired when column moving is completed through dragging it in the moving dialog + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogDragColumnMoved"): MovingDialogDragColumnMovedEvent; + + /** + * Event fired when column moving is completed through dragging it in the moving dialog + * + * @optionValue Define event handler function. + */ + igGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogDragColumnMoved", optionValue: MovingDialogDragColumnMovedEvent): void; + igGridColumnMoving(options: IgGridColumnMoving): JQuery; + igGridColumnMoving(optionLiteral: 'option', optionName: string): any; + igGridColumnMoving(optionLiteral: 'option', options: IgGridColumnMoving): JQuery; + igGridColumnMoving(optionLiteral: 'option', optionName: string, optionValue: any): JQuery; + igGridColumnMoving(methodName: string, ...methodParams: any[]): any; +} interface IgPopoverHeaderTemplate { /** * Controls whether the popover renders a functional close button @@ -37809,25 +40606,6 @@ interface ShowingEvent { } interface ShowingEventUIParam { - /** - * Used to get the element the popover will show for. - */ - element?: any; - - /** - * Used to get or set the content to be shown as a string. - */ - content?: any; - - /** - * Used to get the popover element showing. - */ - popover?: any; - - /** - * Used to get reference to the igPopover widget - */ - owner?: any; } interface ShownEvent { @@ -37835,25 +40613,6 @@ interface ShownEvent { } interface ShownEventUIParam { - /** - * Used to get the element the popover showed for. - */ - element?: any; - - /** - * Used to get the content that was shown as a string. - */ - content?: any; - - /** - * Used to get the popover element shown. - */ - popover?: any; - - /** - * Used to get reference to the igPopover widget - */ - owner?: any; } interface HidingEvent { @@ -37861,25 +40620,6 @@ interface HidingEvent { } interface HidingEventUIParam { - /** - * Used to get the element the popover will hide for. - */ - element?: any; - - /** - * Used to get the current content displayed in the popover as a string. - */ - content?: any; - - /** - * Used to get the popover element hiding. - */ - popover?: any; - - /** - * Used to get reference to the igPopover widget - */ - owner?: any; } interface HiddenEvent { @@ -37887,25 +40627,6 @@ interface HiddenEvent { } interface HiddenEventUIParam { - /** - * Used to get the element the popover is hidden for. - */ - element?: any; - - /** - * Used to get the content displayed in the popover as a string. - */ - content?: any; - - /** - * Used to get the popover element hidden. - */ - popover?: any; - - /** - * Used to get reference to the igPopover widget - */ - owner?: any; } interface IgGridFeatureChooserPopover { @@ -37918,7 +40639,7 @@ interface IgGridFeatureChooserPopover { * controls the direction in which the control shows relative to the target element * * Valid values: - * "auto" lets the control show on the side where enough space is available with the following priority top > bottom > right > left + * "auto" lets the control show on the side where enough space is available with the priority specified by the [directionPriority](ui.igpopover#options:directionPriority) property * "left" shows popover on the left side of the target element * "right" shows popover on the right side of the target element * "top" shows popover on the top of the target element @@ -37926,6 +40647,12 @@ interface IgGridFeatureChooserPopover { */ direction?: string; + /** + * Controls the priority in which the control searches for space to show relative to the target element. + * This property has effect only if the [direction](ui.igpopover#options:direction) property value is "auto" or unset. + */ + directionPriority?: any[]; + /** * 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 * @@ -38008,41 +40735,21 @@ interface IgGridFeatureChooserPopover { /** * Event fired before popover is shown. - * Function takes arguments evt and ui. - * Use ui.element to get the element the popover will show for. - * Use ui.content to get or set the content to be shown as a string. - * Use ui.popover to get the popover element showing. - * Use ui.owner to get reference to the igPopover widget */ showing?: ShowingEvent; /** * Event fired after popover is shown. - * Function takes arguments evt and ui. - * Use ui.element to get the element the popover showed for. - * Use ui.content to get the content that was shown as a string. - * Use ui.popover to get the popover element shown. - * Use ui.owner to get reference to the igPopover widget */ shown?: ShownEvent; /** * Event fired before popover is hidden. - * Function takes arguments evt and ui. - * Use ui.element to get the element the popover will hide for. - * Use ui.content to get the current content displayed in the popover as a string. - * Use ui.popover to get the popover element hiding. - * Use ui.owner to get reference to the igPopover widget */ hiding?: HidingEvent; /** * Event fired after popover is hidden. - * Function takes arguments evt and ui. - * Use ui.element to get the element the popover is hidden for. - * Use ui.content to get the content displayed in the popover as a string. - * Use ui.popover to get the popover element hidden. - * Use ui.owner to get reference to the igPopover widget */ hidden?: HiddenEvent; @@ -38271,6 +40978,20 @@ interface JQuery { */ igGridFeatureChooserPopover(optionLiteral: 'option', optionName: "direction", optionValue: string): void; + /** + * Controls the priority in which the control searches for space to show relative to the target element. + * This property has effect only if the [direction](ui.igpopover#options:direction) property value is "auto" or unset. + */ + igGridFeatureChooserPopover(optionLiteral: 'option', optionName: "directionPriority"): any[]; + + /** + * Controls the priority in which the control searches for space to show relative to the target element. + * This property has effect only if the [direction](ui.igpopover#options:direction) property value is "auto" or unset. + * + * @optionValue New value to be set. + */ + igGridFeatureChooserPopover(optionLiteral: 'option', optionName: "directionPriority", optionValue: any[]): void; + /** * 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 */ @@ -38419,21 +41140,11 @@ interface JQuery { /** * Event fired before popover is shown. - * Function takes arguments evt and ui. - * Use ui.element to get the element the popover will show for. - * Use ui.content to get or set the content to be shown as a string. - * Use ui.popover to get the popover element showing. - * Use ui.owner to get reference to the igPopover widget */ igGridFeatureChooserPopover(optionLiteral: 'option', optionName: "showing"): ShowingEvent; /** * Event fired before popover is shown. - * Function takes arguments evt and ui. - * Use ui.element to get the element the popover will show for. - * Use ui.content to get or set the content to be shown as a string. - * Use ui.popover to get the popover element showing. - * Use ui.owner to get reference to the igPopover widget * * @optionValue Define event handler function. */ @@ -38441,21 +41152,11 @@ interface JQuery { /** * Event fired after popover is shown. - * Function takes arguments evt and ui. - * Use ui.element to get the element the popover showed for. - * Use ui.content to get the content that was shown as a string. - * Use ui.popover to get the popover element shown. - * Use ui.owner to get reference to the igPopover widget */ igGridFeatureChooserPopover(optionLiteral: 'option', optionName: "shown"): ShownEvent; /** * Event fired after popover is shown. - * Function takes arguments evt and ui. - * Use ui.element to get the element the popover showed for. - * Use ui.content to get the content that was shown as a string. - * Use ui.popover to get the popover element shown. - * Use ui.owner to get reference to the igPopover widget * * @optionValue Define event handler function. */ @@ -38463,21 +41164,11 @@ interface JQuery { /** * Event fired before popover is hidden. - * Function takes arguments evt and ui. - * Use ui.element to get the element the popover will hide for. - * Use ui.content to get the current content displayed in the popover as a string. - * Use ui.popover to get the popover element hiding. - * Use ui.owner to get reference to the igPopover widget */ igGridFeatureChooserPopover(optionLiteral: 'option', optionName: "hiding"): HidingEvent; /** * Event fired before popover is hidden. - * Function takes arguments evt and ui. - * Use ui.element to get the element the popover will hide for. - * Use ui.content to get the current content displayed in the popover as a string. - * Use ui.popover to get the popover element hiding. - * Use ui.owner to get reference to the igPopover widget * * @optionValue Define event handler function. */ @@ -38485,21 +41176,11 @@ interface JQuery { /** * Event fired after popover is hidden. - * Function takes arguments evt and ui. - * Use ui.element to get the element the popover is hidden for. - * Use ui.content to get the content displayed in the popover as a string. - * Use ui.popover to get the popover element hidden. - * Use ui.owner to get reference to the igPopover widget */ igGridFeatureChooserPopover(optionLiteral: 'option', optionName: "hidden"): HiddenEvent; /** * Event fired after popover is hidden. - * Function takes arguments evt and ui. - * Use ui.element to get the element the popover is hidden for. - * Use ui.content to get the content displayed in the popover as a string. - * Use ui.popover to get the popover element hidden. - * Use ui.owner to get reference to the igPopover widget * * @optionValue Define event handler function. */ @@ -38595,6 +41276,4041 @@ interface JQuery { igGridFeatureChooser(optionLiteral: 'option', optionName: string, optionValue: any): JQuery; igGridFeatureChooser(methodName: string, ...methodParams: any[]): any; } +interface IgGridFilteringColumnSettingDefaultExpressions { + /** + * Option for IgGridFilteringColumnSettingDefaultExpressions + */ + [optionName: string]: any; +} + +interface IgGridFilteringColumnSetting { + /** + * Identifies the grid column by key. Either key or index must be set in every column setting. + * + */ + columnKey?: string; + + /** + * Identifies the grid column by index. Either key or index must be set in every column setting. + * + */ + columnIndex?: number; + + /** + * Enables/disables filtering for the column. + * + */ + allowFiltering?: boolean; + + /** + * Initial filtering condition for the column. + * + * + * Valid values: + * "empty" + * "notEmpty" + * "null" + * "notNull" + * "equals" + * "doesNotEqual" + * "startsWith" + * "contains" + * "doesNotContain" + * "endsWith" + * "greaterThan" + * "lessThan" + * "greaterThanOrEqualTo" + * "lessThanOrEqualTo" + * "true" + * "false" + * "on" + * "notOn" + * "before" + * "after" + * "today" + * "yesterday" + * "thisMonth" + * "lastMonth" + * "nextMonth" + * "thisYear" + * "nextYear" + * "lastYear" + */ + condition?: string|boolean; + + /** + * An array of strings that determine which [conditions](ui.iggridfiltering#options:columnSettings.condition) to display for this column. + * + */ + conditionList?: any[]; + + /** + * Initial filtering expressions - if set they will be applied on initialization together with the preset [condition](ui.iggridfiltering#options:columnSettings.condition). + * + */ + defaultExpressions?: IgGridFilteringColumnSettingDefaultExpressions; + + /** + * An object used to specify custom filtering conditions as objects for this column. + * + * labelText The label as it will appear in the column's condition dropdown. + * expressionText The text to display in the editor when requireExpr is false. + * requireExpr If this condition requires the user to input a filtering expression. + * filterImgIcon Class applied to the dropdown item when in simple mode. + * filterFunc The custom comparing filter function. Signature: function (value, expression, dataType, ignoreCase, preciseDateFormat). + */ + customConditions?: any; + + /** + * Option for IgGridFilteringColumnSetting + */ + [optionName: string]: any; +} + +interface IgGridFilteringNullTexts { + startsWith?: string; + endsWith?: string; + contains?: string; + doesNotContain?: string; + equals?: string; + doesNotEqual?: string; + greaterThan?: string; + lessThan?: string; + greaterThanOrEqualTo?: string; + lessThanOrEqualTo?: string; + on?: string; + notOn?: string; + after?: string; + before?: string; + thisMonth?: string; + lastMonth?: string; + nextMonth?: string; + thisYear?: string; + lastYear?: string; + nextYear?: string; + empty?: string; + notEmpty?: string; + null?: string; + notNull?: string; + + /** + * Option for IgGridFilteringNullTexts + */ + [optionName: string]: any; +} + +interface IgGridFilteringLabels { + noFilter?: string; + clear?: string; + startsWith?: string; + endsWith?: string; + contains?: string; + doesNotContain?: string; + equals?: string; + doesNotEqual?: string; + greaterThan?: string; + lessThan?: string; + greaterThanOrEqualTo?: string; + lessThanOrEqualTo?: string; + trueLabel?: string; + falseLabel?: string; + after?: string; + before?: string; + today?: string; + yesterday?: string; + thisMonth?: string; + lastMonth?: string; + nextMonth?: string; + thisYear?: string; + lastYear?: string; + nextYear?: string; + on?: string; + notOn?: string; + advancedButtonLabel?: string; + filterDialogCaptionLabel?: string; + filterDialogConditionLabel1?: string; + filterDialogConditionLabel2?: string; + filterDialogOkLabel?: string; + filterDialogCancelLabel?: string; + filterDialogAnyLabel?: string; + filterDialogAllLabel?: string; + filterDialogAddLabel?: string; + filterDialogErrorLabel?: string; + filterSummaryTitleLabel?: string; + filterDialogClearAllLabel?: string; + empty?: string; + notEmpty?: string; + nullLabel?: string; + notNull?: string; + true?: string; + false?: string; + + /** + * Option for IgGridFilteringLabels + */ + [optionName: string]: any; +} + +interface DataFilteringEvent { + (event: Event, ui: DataFilteringEventUIParam): void; +} + +interface DataFilteringEventUIParam { +} + +interface DataFilteredEvent { + (event: Event, ui: DataFilteredEventUIParam): void; +} + +interface DataFilteredEventUIParam { +} + +interface FilterDialogOpeningEvent { + (event: Event, ui: FilterDialogOpeningEventUIParam): void; +} + +interface FilterDialogOpeningEventUIParam { +} + +interface FilterDialogOpenedEvent { + (event: Event, ui: FilterDialogOpenedEventUIParam): void; +} + +interface FilterDialogOpenedEventUIParam { +} + +interface FilterDialogMovingEvent { + (event: Event, ui: FilterDialogMovingEventUIParam): void; +} + +interface FilterDialogMovingEventUIParam { +} + +interface FilterDialogFilterAddingEvent { + (event: Event, ui: FilterDialogFilterAddingEventUIParam): void; +} + +interface FilterDialogFilterAddingEventUIParam { +} + +interface FilterDialogFilterAddedEvent { + (event: Event, ui: FilterDialogFilterAddedEventUIParam): void; +} + +interface FilterDialogFilterAddedEventUIParam { +} + +interface FilterDialogClosingEvent { + (event: Event, ui: FilterDialogClosingEventUIParam): void; +} + +interface FilterDialogClosingEventUIParam { +} + +interface FilterDialogClosedEvent { + (event: Event, ui: FilterDialogClosedEventUIParam): void; +} + +interface FilterDialogClosedEventUIParam { +} + +interface FilterDialogContentsRenderingEvent { + (event: Event, ui: FilterDialogContentsRenderingEventUIParam): void; +} + +interface FilterDialogContentsRenderingEventUIParam { +} + +interface FilterDialogContentsRenderedEvent { + (event: Event, ui: FilterDialogContentsRenderedEventUIParam): void; +} + +interface FilterDialogContentsRenderedEventUIParam { +} + +interface FilterDialogFilteringEvent { + (event: Event, ui: FilterDialogFilteringEventUIParam): void; +} + +interface FilterDialogFilteringEventUIParam { +} + +interface IgGridFiltering { + /** + * Enables or disables the filtering case sensitivity. Works only for local filtering. If true, it case sensitive filtering is performed. If false, filtering is case insensitive. + * + */ + caseSensitive?: boolean; + + /** + * Enable/disable footer visibility with summary info about the filter. + * When false, the filter summary row (in the footer) will only be visible when paging is enabled (or some other feature that renders a footer). + * When true, the filter summary row will only be visible when a filter is applied i.e. it's not visible by default. + * + */ + filterSummaryAlwaysVisible?: boolean; + + /** + * Render in [Feature Chooser](http://www.igniteui.com/help/iggrid-feature-chooser) + * + */ + renderFC?: boolean; + + /** + * Summary template that will appear in the bottom left corner of the footer. Has the format '${matches} matching records'. + * + */ + filterSummaryTemplate?: string; + + /** + * Type of animations for the column filter dropdowns. + * + * + * Valid values: + * "linear" The column filtering drop downs are shown with a linear animation. + * "none" No animation is used when showing the filtering drop downs. + */ + filterDropDownAnimations?: string; + + /** + * Animation duration in milliseconds for the [filterDropDownAnimations](ui.iggridfiltering#options:filterDropDownAnimations). + * + */ + filterDropDownAnimationDuration?: number; + + /** + * Width of the column filter dropdowns. + * + * + * Valid values: + * "string" The width in pixels (0px) + * "number" The width in pixels as a number (0) + */ + filterDropDownWidth?: string|number; + + /** + * Height of the column filter dropdowns. + * + * string The height of the column filter dropdowns in pixels (0px). + * number The height of the column filter dropdowns in pixels as a number (0). + */ + filterDropDownHeight?: any; + + /** + * URL key name that specifies how the filtering expressions will be encoded for remote requests, e.g. &filter('col') = startsWith. Default is OData. + * + */ + filterExprUrlKey?: string; + + /** + * Enable/disable filter icons visibility. + * + * + * Valid values: + * "true" All predefined filters in the filter dropdowns will have icons rendered in front of the text. + * "false" No icons will be rendered. + */ + filterDropDownItemIcons?: boolean; + + /** + * A list of column settings that specifies custom filtering options on a per column basis. + * + */ + columnSettings?: IgGridFilteringColumnSetting[]; + + /** + * Type of filtering. Delegates all filtering functionality to the [$.ig.DataSource](ig.datasource). + * + * + * Valid values: + * "remote" Filtering is performed by a remote end-point. + * "local" Filtering is performed locally by the [$.ig.DataSource](ig.datasource). + */ + type?: string; + + /** + * Time in milliseconds for which widget will wait between keystrokes before sending filtering requests. + * + */ + filterDelay?: number; + + /** + * Default is 'simple' for non-virtualized grids, and 'advanced' when [virtualization](ui.iggrid#options:virtualization) is enabled. + * + * + * Valid values: + * "simple" Renders just a filter row. + * "advanced" Allows to configure multiple filters from a dialog - Excel style. + */ + mode?: string; + + /** + * Defines whether to render editors in advanced [mode](ui.iggridfiltering#options:mode). If false, no editors will be rendered in the advanced [mode](ui.iggridfiltering#options:mode). + * + */ + advancedModeEditorsVisible?: boolean; + + /** + * Location of the advanced filtering button when [advancedModeEditorsVisible](ui.iggridfiltering#options:advancedModeEditorsVisible) is false (i.e. when the button is rendered in the header). + * + * + * Valid values: + * "left" + * "right" + */ + advancedModeHeaderButtonLocation?: string; + + /** + * Default filter dialog width (used for Advanced filtering [mode](ui.iggridfiltering#options:mode)). + * + * + * Valid values: + * "string" The dialog window width in pixels (370px). + * "number" The dialog window width in pixels as a number (370). + */ + filterDialogWidth?: string|number; + + /** + * default filter dialog height (used for Advanced filtering [mode](ui.iggridfiltering#options:mode)). + * + * + * Valid values: + * "string" The dialog window height in pixels (350px). + * "number" The dialog window height in pixels as a number (350). + */ + filterDialogHeight?: string|number; + + /** + * Width of the filtering condition dropdowns in the advanced filter dialog. + * + * + * Valid values: + * "string" The filtering condition dropdowns width in pixels (80px). + * "number" The filtering condition dropdowns width in pixels as a number (80). + */ + filterDialogFilterDropDownDefaultWidth?: string|number; + + /** + * Width of the filtering expression input boxes in the advanced filter dialog. + * + * + * Valid values: + * "string" The filtering expression input boxes width in pixels (80px). + * "number" The filtering expression input boxes width in pixels as a number (80). + */ + filterDialogExprInputDefaultWidth?: string|number; + + /** + * Width of the column chooser dropdowns in the advanced filter dialog. + * + * + * Valid values: + * "string" The column chooser dropdowns width in pixels (80px). + * "number" The column chooser dropdowns width in pixels as a number (80). + */ + filterDialogColumnDropDownDefaultWidth?: string|number; + + /** + * Enable/disable filter button visibility. If false, no filter dropdown buttons will be rendered and a predefined list of filters will not be rendered for the columns. + * + */ + renderFilterButton?: boolean; + + /** + * The filtering button for filter dropdowns can be rendered either on the left of the filter editor, or on the right. + * + * + * Valid values: + * "left" The button is rendered on the left. + * "right" The button is rendered on the right. + */ + filterButtonLocation?: string; + + /** + * List of configurable and localized null texts that will be used for the filter editors. + * + */ + nullTexts?: IgGridFilteringNullTexts; + + /** + * A list of configurable and localized labels that are used for the predefined filtering conditions in the filter dropdowns. + * + */ + labels?: IgGridFilteringLabels; + + /** + * Custom tooltip template for the filter button, when a filter is applied. + * + */ + tooltipTemplate?: string; + + /** + * Custom template for add condition area in the filter dialog. The default template is "
${label1}
${label2}
". + * + */ + filterDialogAddConditionTemplate?: string; + + /** + * Custom template for options in dropdown in add condition area in the filter dialog. The default template is "". + * + */ + filterDialogAddConditionDropDownTemplate?: string; + + /** + * Custom template for filter dialog. + * Each DOM element which is used for selecting filter conditions/columns/filter expressions has "data-*" attribute. + * E.g.: DOM element used for selecting column has attribute "data-af-col", for selecting filter condition - "data-af-cond", for filter expression- "data-af-expr". + * NOTE: The template is supported only with . + * The default template is " ". + * + */ + filterDialogFilterTemplate?: string; + + /** + * Custom template for options in condition list in filter dialog. The default template is "". + * + */ + filterDialogFilterConditionTemplate?: string; + + /** + * Add button width - in the advanced filter dialog. + * + * + * Valid values: + * "string" The dialog Add button width in pixels (100px). + * "number" The dialog Add button width in pixels as a number (100). + */ + filterDialogAddButtonWidth?: string|number; + + /** + * Width of the Ok and Cancel buttons in the advanced filtering dialogs. + * + * + * Valid values: + * "string" The advanced filter dialog Ok and Cancel buttons width in pixels (120px). + * "number" The advanced filter dialog Ok and Cancel buttons width in pixels as a number (120). + */ + filterDialogOkCancelButtonWidth?: string|number; + + /** + * Maximum number of filter rows in the advanced filtering dialog. If this number is exceeded, an error message will be rendered. + * + */ + filterDialogMaxFilterCount?: number; + + /** + * Controls containment behavior. + * + * owner The filter dialog will be draggable only within the grid area. + * window The filter dialog will be draggable within the whole window area. + */ + filterDialogContainment?: string; + + /** + * Enable/disable empty condition visibility in the filter. If true, shows empty and not empty filtering conditions in the dropdowns. + * + */ + showEmptyConditions?: boolean; + + /** + * Enable/disable visibility of null and not null filtering conditions in the dropdowns. If true, shows null and not null filtering conditions in the dropdowns. + * + */ + showNullConditions?: boolean; + + /** + * Feature chooser text when filter is shown and filter [mode](ui.iggridfiltering#options:mode) is simple. + * + */ + featureChooserText?: string; + + /** + * Feature chooser text when filter is hidden and filter [mode](ui.iggridfiltering#options:mode) is simple. + * + */ + featureChooserTextHide?: string; + + /** + * Feature chooser text when filter [mode](ui.iggridfiltering#options:mode) is advanced. + * + */ + featureChooserTextAdvancedFilter?: string; + + /** + * Name of the dialog widget to be used. It should inherit from $.ui.igGridModalDialog. + * + */ + dialogWidget?: string; + + /** + * Enables/disables filtering persistence between states. + * + */ + persist?: boolean; + + /** + * Enables/disables feature inheritance for the child [layouts](ui.ighierarchicalgrid#options:columnLayouts). NOTE: It only applies for [igHierarchicalGrid](ui.ighierarchicalgrid). + * + */ + inherit?: boolean; + + /** + * Event fired before a filtering operation is executed (remote request or local). + * Return false in order to cancel filtering operation. + */ + dataFiltering?: DataFilteringEvent; + + /** + * Event fired after the filtering has been executed and results are rendered. + */ + dataFiltered?: DataFilteredEvent; + + /** + * Event fired before the filter dropdown is opened for a specific column. + * Return false in order to cancel dropdown opening. + */ + dropDownOpening?: DropDownOpeningEvent; + + /** + * Event fired after the filter dropdown is opened for a specific column. + */ + dropDownOpened?: DropDownOpenedEvent; + + /** + * Event fired before the filter dropdown starts closing. + * Return false in order to cancel dropdown closing. + */ + dropDownClosing?: DropDownClosingEvent; + + /** + * Event fired after a filter column dropdown is completely closed. + */ + dropDownClosed?: DropDownClosedEvent; + + /** + * Event fired before the advanced filtering dialog is opened. + * Return false in order to cancel filter dialog opening. + */ + filterDialogOpening?: FilterDialogOpeningEvent; + + /** + * Event fired after the advanced filter dialog is already opened. + */ + filterDialogOpened?: FilterDialogOpenedEvent; + + /** + * Event fired every time the advanced filter dialog changes its position. + */ + filterDialogMoving?: FilterDialogMovingEvent; + + /** + * Event fired before a filter row is added to the advanced filter dialog. + * Return false in order to cancel filter adding to the advanced filtering dialog. + */ + filterDialogFilterAdding?: FilterDialogFilterAddingEvent; + + /** + * Event fired after a filter row is added to the advanced filter dialog. + */ + filterDialogFilterAdded?: FilterDialogFilterAddedEvent; + + /** + * Event fired before the advanced filter dialog is closed. + * Return false in order to cancel filtering dialog closing. + */ + filterDialogClosing?: FilterDialogClosingEvent; + + /** + * Event fired after the advanced filter dialog has been closed. + */ + filterDialogClosed?: FilterDialogClosedEvent; + + /** + * Event fired before the contents of the advanced filter dialog are rendered. + * Return false in order to cancel filtering dialog rendering. + */ + filterDialogContentsRendering?: FilterDialogContentsRenderingEvent; + + /** + * Event fired after the contents of the advanced filter dialog are rendered. + */ + filterDialogContentsRendered?: FilterDialogContentsRenderedEvent; + + /** + * Event fired when the OK button in the advanced filter dialog is pressed. + */ + filterDialogFiltering?: FilterDialogFilteringEvent; + + /** + * Option for igGridFiltering + */ + [optionName: string]: any; +} +interface IgGridFilteringMethods { + /** + * Destroys the filtering widget - remove fitler row, unbinds events, returns the grid to its previous state. + */ + destroy(): void; + + /** + * Returns the count of data records that match filtering conditions + */ + getFilteringMatchesCount(): number; + + /** + * Toggle filter row when mode is simple or [advancedModeEditorsVisible](ui.iggridfiltering#options:advancedModeEditorsVisible) is true. Otherwise show/hide advanced dialog. + * + * @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 addedFromAdvanced + */ + filter(expressions: any[], updateUI?: boolean, addedFromAdvanced?: boolean): void; + + /** + * 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. + */ + requiresFilteringExpression(filterCondition: string): boolean; +} +interface JQuery { + data(propertyName: "igGridFiltering"): IgGridFilteringMethods; +} + +interface JQuery { + igGridFiltering(methodName: "destroy"): void; + igGridFiltering(methodName: "getFilteringMatchesCount"): number; + igGridFiltering(methodName: "toggleFilterRowByFeatureChooser", event: string): void; + igGridFiltering(methodName: "filter", expressions: any[], updateUI?: boolean, addedFromAdvanced?: boolean): void; + igGridFiltering(methodName: "requiresFilteringExpression", filterCondition: string): boolean; + + /** + * Enables or disables the filtering case sensitivity. Works only for local filtering. If true, it case sensitive filtering is performed. If false, filtering is case insensitive. + * + */ + igGridFiltering(optionLiteral: 'option', optionName: "caseSensitive"): boolean; + + /** + * Enables or disables the filtering case sensitivity. Works only for local filtering. If true, it case sensitive filtering is performed. If false, filtering is case insensitive. + * + * + * @optionValue New value to be set. + */ + igGridFiltering(optionLiteral: 'option', optionName: "caseSensitive", optionValue: boolean): void; + + /** + * Enable/disable footer visibility with summary info about the filter. + * When false, the filter summary row (in the footer) will only be visible when paging is enabled (or some other feature that renders a footer). + * When true, the filter summary row will only be visible when a filter is applied i.e. it's not visible by default. + * + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterSummaryAlwaysVisible"): boolean; + + /** + * Enable/disable footer visibility with summary info about the filter. + * When false, the filter summary row (in the footer) will only be visible when paging is enabled (or some other feature that renders a footer). + * When true, the filter summary row will only be visible when a filter is applied i.e. it's not visible by default. + * + * + * @optionValue New value to be set. + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterSummaryAlwaysVisible", optionValue: boolean): void; + + /** + * Render in [Feature Chooser](http://www.igniteui.com/help/iggrid-feature-chooser) + * + */ + igGridFiltering(optionLiteral: 'option', optionName: "renderFC"): boolean; + + /** + * Render in [Feature Chooser](http://www.igniteui.com/help/iggrid-feature-chooser) + * + * + * @optionValue New value to be set. + */ + igGridFiltering(optionLiteral: 'option', optionName: "renderFC", optionValue: boolean): void; + + /** + * Summary template that will appear in the bottom left corner of the footer. Has the format '${matches} matching records'. + * + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterSummaryTemplate"): string; + + /** + * Summary template that will appear in the bottom left corner of the footer. Has the format '${matches} matching records'. + * + * + * @optionValue New value to be set. + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterSummaryTemplate", optionValue: string): void; + + /** + * Type of animations for the column filter dropdowns. + * + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDropDownAnimations"): string; + + /** + * Type of animations for the column filter dropdowns. + * + * + * @optionValue New value to be set. + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDropDownAnimations", optionValue: string): void; + + /** + * Animation duration in milliseconds for the [filterDropDownAnimations](ui.iggridfiltering#options:filterDropDownAnimations). + * + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDropDownAnimationDuration"): number; + + /** + * Animation duration in milliseconds for the [filterDropDownAnimations](ui.iggridfiltering#options:filterDropDownAnimations). + * + * + * @optionValue New value to be set. + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDropDownAnimationDuration", optionValue: number): void; + + /** + * Width of the column filter dropdowns. + * + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDropDownWidth"): string|number; + + /** + * Width of the column filter dropdowns. + * + * + * @optionValue New value to be set. + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDropDownWidth", optionValue: string|number): void; + + /** + * Height of the column filter dropdowns. + * + * string The height of the column filter dropdowns in pixels (0px). + * number The height of the column filter dropdowns in pixels as a number (0). + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDropDownHeight"): any; + + /** + * Height of the column filter dropdowns. + * + * string The height of the column filter dropdowns in pixels (0px). + * number The height of the column filter dropdowns in pixels as a number (0). + * + * @optionValue New value to be set. + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDropDownHeight", optionValue: any): void; + + /** + * URL key name that specifies how the filtering expressions will be encoded for remote requests, e.g. &filter('col') = startsWith. Default is OData. + * + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterExprUrlKey"): string; + + /** + * URL key name that specifies how the filtering expressions will be encoded for remote requests, e.g. &filter('col') = startsWith. Default is OData. + * + * + * @optionValue New value to be set. + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterExprUrlKey", optionValue: string): void; + + /** + * Enable/disable filter icons visibility. + * + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDropDownItemIcons"): boolean; + + /** + * Enable/disable filter icons visibility. + * + * + * @optionValue New value to be set. + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDropDownItemIcons", optionValue: boolean): void; + + /** + * A list of column settings that specifies custom filtering options on a per column basis. + * + */ + igGridFiltering(optionLiteral: 'option', optionName: "columnSettings"): IgGridFilteringColumnSetting[]; + + /** + * A list of column settings that specifies custom filtering options on a per column basis. + * + * + * @optionValue New value to be set. + */ + igGridFiltering(optionLiteral: 'option', optionName: "columnSettings", optionValue: IgGridFilteringColumnSetting[]): void; + + /** + * Type of filtering. Delegates all filtering functionality to the [$.ig.DataSource](ig.datasource). + * + */ + igGridFiltering(optionLiteral: 'option', optionName: "type"): string; + + /** + * Type of filtering. Delegates all filtering functionality to the [$.ig.DataSource](ig.datasource). + * + * + * @optionValue New value to be set. + */ + igGridFiltering(optionLiteral: 'option', optionName: "type", optionValue: string): void; + + /** + * Time in milliseconds for which widget will wait between keystrokes before sending filtering requests. + * + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDelay"): number; + + /** + * Time in milliseconds for which widget will wait between keystrokes before sending filtering requests. + * + * + * @optionValue New value to be set. + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDelay", optionValue: number): void; + + /** + * Default is 'simple' for non-virtualized grids, and 'advanced' when [virtualization](ui.iggrid#options:virtualization) is enabled. + * + */ + igGridFiltering(optionLiteral: 'option', optionName: "mode"): string; + + /** + * Default is 'simple' for non-virtualized grids, and 'advanced' when [virtualization](ui.iggrid#options:virtualization) is enabled. + * + * + * @optionValue New value to be set. + */ + igGridFiltering(optionLiteral: 'option', optionName: "mode", optionValue: string): void; + + /** + * Defines whether to render editors in advanced [mode](ui.iggridfiltering#options:mode). If false, no editors will be rendered in the advanced [mode](ui.iggridfiltering#options:mode). + * + */ + igGridFiltering(optionLiteral: 'option', optionName: "advancedModeEditorsVisible"): boolean; + + /** + * Defines whether to render editors in advanced [mode](ui.iggridfiltering#options:mode). If false, no editors will be rendered in the advanced [mode](ui.iggridfiltering#options:mode). + * + * + * @optionValue New value to be set. + */ + igGridFiltering(optionLiteral: 'option', optionName: "advancedModeEditorsVisible", optionValue: boolean): void; + + /** + * 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; + + /** + * Location of the advanced filtering button when [advancedModeEditorsVisible](ui.iggridfiltering#options:advancedModeEditorsVisible) is false (i.e. when the button is rendered in the header). + * + * + * @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; + + /** + * Default filter dialog width (used for Advanced filtering [mode](ui.iggridfiltering#options:mode)). + * + * + * @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; + + /** + * Default filter dialog height (used for Advanced filtering [mode](ui.iggridfiltering#options:mode)). + * + * + * @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; + + /** + * Width of the filtering condition dropdowns in the advanced filter dialog. + * + * + * @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; + + /** + * Width of the filtering expression input boxes in the advanced filter dialog. + * + * + * @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; + + /** + * Width of the column chooser dropdowns in the advanced filter dialog. + * + * + * @optionValue New value to be set. + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogColumnDropDownDefaultWidth", optionValue: string|number): void; + + /** + * Enable/disable filter button visibility. If false, no filter dropdown buttons will be rendered and a predefined list of filters will not be rendered for the columns. + * + */ + igGridFiltering(optionLiteral: 'option', optionName: "renderFilterButton"): boolean; + + /** + * Enable/disable filter button visibility. If false, no filter dropdown buttons will be rendered and a predefined list of filters will not be rendered for the columns. + * + * + * @optionValue New value to be set. + */ + igGridFiltering(optionLiteral: 'option', optionName: "renderFilterButton", optionValue: boolean): void; + + /** + * 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; + + /** + * The filtering button for filter dropdowns can be rendered either on the left of the filter editor, or on the right. + * + * + * @optionValue New value to be set. + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterButtonLocation", optionValue: string): void; + + /** + * List of configurable and localized null texts that will be used for the filter editors. + * + */ + igGridFiltering(optionLiteral: 'option', optionName: "nullTexts"): IgGridFilteringNullTexts; + + /** + * List of configurable and localized null texts that will be used for the filter editors. + * + * + * @optionValue New value to be set. + */ + igGridFiltering(optionLiteral: 'option', optionName: "nullTexts", optionValue: IgGridFilteringNullTexts): void; + + /** + * A list of configurable and localized labels that are used for the predefined filtering conditions in the filter dropdowns. + * + */ + igGridFiltering(optionLiteral: 'option', optionName: "labels"): IgGridFilteringLabels; + + /** + * A list of configurable and localized labels that are used for the predefined filtering conditions in the filter dropdowns. + * + * + * @optionValue New value to be set. + */ + igGridFiltering(optionLiteral: 'option', optionName: "labels", optionValue: IgGridFilteringLabels): void; + + /** + * Custom tooltip template for the filter button, when a filter is applied. + * + */ + igGridFiltering(optionLiteral: 'option', optionName: "tooltipTemplate"): string; + + /** + * Custom tooltip template for the filter button, when a filter is applied. + * + * + * @optionValue New value to be set. + */ + igGridFiltering(optionLiteral: 'option', optionName: "tooltipTemplate", optionValue: string): void; + + /** + * Custom template for add condition area in the filter dialog. The default template is "
${label1}
${label2}
". + * + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogAddConditionTemplate"): string; + + /** + * Custom template for add condition area in the filter dialog. The default template is "
${label1}
${label2}
". + * + * + * @optionValue New value to be set. + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogAddConditionTemplate", optionValue: string): void; + + /** + * Custom template for options in dropdown in add condition area in the filter dialog. The default template is "". + * + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogAddConditionDropDownTemplate"): string; + + /** + * Custom template for options in dropdown in add condition area in the filter dialog. The default template is "". + * + * + * @optionValue New value to be set. + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogAddConditionDropDownTemplate", optionValue: string): void; + + /** + * Custom template for filter dialog. + * Each DOM element which is used for selecting filter conditions/columns/filter expressions has "data-*" attribute. + * E.g.: DOM element used for selecting column has attribute "data-af-col", for selecting filter condition - "data-af-cond", for filter expression- "data-af-expr". + * NOTE: The template is supported only with . + * The default template is " ". + * + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogFilterTemplate"): string; + + /** + * Custom template for filter dialog. + * Each DOM element which is used for selecting filter conditions/columns/filter expressions has "data-*" attribute. + * E.g.: DOM element used for selecting column has attribute "data-af-col", for selecting filter condition - "data-af-cond", for filter expression- "data-af-expr". + * NOTE: The template is supported only with . + * The default template is " ". + * + * + * @optionValue New value to be set. + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogFilterTemplate", optionValue: string): void; + + /** + * Custom template for options in condition list in filter dialog. The default template is "". + * + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogFilterConditionTemplate"): string; + + /** + * Custom template for options in condition list in filter dialog. The default template is "". + * + * + * @optionValue New value to be set. + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogFilterConditionTemplate", optionValue: string): void; + + /** + * Add button width - in the advanced filter dialog. + * + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogAddButtonWidth"): string|number; + + /** + * Add button width - in the advanced filter dialog. + * + * + * @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; + + /** + * Width of the Ok and Cancel buttons in the advanced filtering dialogs. + * + * + * @optionValue New value to be set. + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogOkCancelButtonWidth", optionValue: string|number): void; + + /** + * Maximum number of filter rows in the advanced filtering dialog. If this number is exceeded, an error message will be rendered. + * + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogMaxFilterCount"): number; + + /** + * Maximum number of filter rows in the advanced filtering dialog. If this number is exceeded, an error message will be rendered. + * + * + * @optionValue New value to be set. + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogMaxFilterCount", optionValue: number): void; + + /** + * Controls containment behavior. + * + * owner The filter dialog will be draggable only within the grid area. + * window The filter dialog will be draggable within the whole window area. + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogContainment"): string; + + /** + * Controls containment behavior. + * + * owner The filter dialog will be draggable only within the grid area. + * window The filter dialog will be draggable within the whole window area. + * + * @optionValue New value to be set. + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogContainment", optionValue: string): void; + + /** + * Enable/disable empty condition visibility in the filter. If true, shows empty and not empty filtering conditions in the dropdowns. + * + */ + igGridFiltering(optionLiteral: 'option', optionName: "showEmptyConditions"): boolean; + + /** + * Enable/disable empty condition visibility in the filter. If true, shows empty and not empty filtering conditions in the dropdowns. + * + * + * @optionValue New value to be set. + */ + igGridFiltering(optionLiteral: 'option', optionName: "showEmptyConditions", optionValue: boolean): void; + + /** + * Enable/disable visibility of null and not null filtering conditions in the dropdowns. If true, shows null and not null filtering conditions in the dropdowns. + * + */ + igGridFiltering(optionLiteral: 'option', optionName: "showNullConditions"): boolean; + + /** + * Enable/disable visibility of null and not null filtering conditions in the dropdowns. If true, shows null and not null filtering conditions in the dropdowns. + * + * + * @optionValue New value to be set. + */ + igGridFiltering(optionLiteral: 'option', optionName: "showNullConditions", optionValue: boolean): void; + + /** + * Feature chooser text when filter is shown and filter [mode](ui.iggridfiltering#options:mode) is simple. + * + */ + igGridFiltering(optionLiteral: 'option', optionName: "featureChooserText"): string; + + /** + * Feature chooser text when filter is shown and filter [mode](ui.iggridfiltering#options:mode) is simple. + * + * + * @optionValue New value to be set. + */ + igGridFiltering(optionLiteral: 'option', optionName: "featureChooserText", optionValue: string): void; + + /** + * Feature chooser text when filter is hidden and filter [mode](ui.iggridfiltering#options:mode) is simple. + * + */ + igGridFiltering(optionLiteral: 'option', optionName: "featureChooserTextHide"): string; + + /** + * Feature chooser text when filter is hidden and filter [mode](ui.iggridfiltering#options:mode) is simple. + * + * + * @optionValue New value to be set. + */ + igGridFiltering(optionLiteral: 'option', optionName: "featureChooserTextHide", optionValue: string): void; + + /** + * Feature chooser text when filter [mode](ui.iggridfiltering#options:mode) is advanced. + * + */ + igGridFiltering(optionLiteral: 'option', optionName: "featureChooserTextAdvancedFilter"): string; + + /** + * Feature chooser text when filter [mode](ui.iggridfiltering#options:mode) is advanced. + * + * + * @optionValue New value to be set. + */ + igGridFiltering(optionLiteral: 'option', optionName: "featureChooserTextAdvancedFilter", optionValue: string): void; + + /** + * Name of the dialog widget to be used. It should inherit from $.ui.igGridModalDialog. + * + */ + igGridFiltering(optionLiteral: 'option', optionName: "dialogWidget"): string; + + /** + * Name of the dialog widget to be used. It should inherit from $.ui.igGridModalDialog. + * + * + * @optionValue New value to be set. + */ + igGridFiltering(optionLiteral: 'option', optionName: "dialogWidget", optionValue: string): void; + + /** + * Enables/disables filtering persistence between states. + * + */ + igGridFiltering(optionLiteral: 'option', optionName: "persist"): boolean; + + /** + * Enables/disables filtering persistence between states. + * + * + * @optionValue New value to be set. + */ + igGridFiltering(optionLiteral: 'option', optionName: "persist", optionValue: boolean): void; + + /** + * Enables/disables feature inheritance for the child [layouts](ui.ighierarchicalgrid#options:columnLayouts). NOTE: It only applies for [igHierarchicalGrid](ui.ighierarchicalgrid). + * + */ + igGridFiltering(optionLiteral: 'option', optionName: "inherit"): boolean; + + /** + * Enables/disables feature inheritance for the child [layouts](ui.ighierarchicalgrid#options:columnLayouts). NOTE: It only applies for [igHierarchicalGrid](ui.ighierarchicalgrid). + * + * + * @optionValue New value to be set. + */ + igGridFiltering(optionLiteral: 'option', optionName: "inherit", optionValue: boolean): void; + + /** + * Event fired before a filtering operation is executed (remote request or local). + * Return false in order to cancel filtering operation. + */ + igGridFiltering(optionLiteral: 'option', optionName: "dataFiltering"): DataFilteringEvent; + + /** + * Event fired before a filtering operation is executed (remote request or local). + * Return false in order to cancel filtering operation. + * + * @optionValue Define event handler function. + */ + igGridFiltering(optionLiteral: 'option', optionName: "dataFiltering", optionValue: DataFilteringEvent): void; + + /** + * Event fired after the filtering has been executed and results are rendered. + */ + igGridFiltering(optionLiteral: 'option', optionName: "dataFiltered"): DataFilteredEvent; + + /** + * Event fired after the filtering has been executed and results are rendered. + * + * @optionValue Define event handler function. + */ + igGridFiltering(optionLiteral: 'option', optionName: "dataFiltered", optionValue: DataFilteredEvent): void; + + /** + * Event fired before the filter dropdown is opened for a specific column. + * Return false in order to cancel dropdown opening. + */ + igGridFiltering(optionLiteral: 'option', optionName: "dropDownOpening"): DropDownOpeningEvent; + + /** + * Event fired before the filter dropdown is opened for a specific column. + * Return false in order to cancel dropdown opening. + * + * @optionValue Define event handler function. + */ + igGridFiltering(optionLiteral: 'option', optionName: "dropDownOpening", optionValue: DropDownOpeningEvent): void; + + /** + * Event fired after the filter dropdown is opened for a specific column. + */ + igGridFiltering(optionLiteral: 'option', optionName: "dropDownOpened"): DropDownOpenedEvent; + + /** + * Event fired after the filter dropdown is opened for a specific column. + * + * @optionValue Define event handler function. + */ + igGridFiltering(optionLiteral: 'option', optionName: "dropDownOpened", optionValue: DropDownOpenedEvent): void; + + /** + * Event fired before the filter dropdown starts closing. + * Return false in order to cancel dropdown closing. + */ + igGridFiltering(optionLiteral: 'option', optionName: "dropDownClosing"): DropDownClosingEvent; + + /** + * Event fired before the filter dropdown starts closing. + * Return false in order to cancel dropdown closing. + * + * @optionValue Define event handler function. + */ + igGridFiltering(optionLiteral: 'option', optionName: "dropDownClosing", optionValue: DropDownClosingEvent): void; + + /** + * Event fired after a filter column dropdown is completely closed. + */ + igGridFiltering(optionLiteral: 'option', optionName: "dropDownClosed"): DropDownClosedEvent; + + /** + * Event fired after a filter column dropdown is completely closed. + * + * @optionValue Define event handler function. + */ + igGridFiltering(optionLiteral: 'option', optionName: "dropDownClosed", optionValue: DropDownClosedEvent): void; + + /** + * Event fired before the advanced filtering dialog is opened. + * Return false in order to cancel filter dialog opening. + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogOpening"): FilterDialogOpeningEvent; + + /** + * Event fired before the advanced filtering dialog is opened. + * Return false in order to cancel filter dialog opening. + * + * @optionValue Define event handler function. + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogOpening", optionValue: FilterDialogOpeningEvent): void; + + /** + * Event fired after the advanced filter dialog is already opened. + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogOpened"): FilterDialogOpenedEvent; + + /** + * Event fired after the advanced filter dialog is already opened. + * + * @optionValue Define event handler function. + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogOpened", optionValue: FilterDialogOpenedEvent): void; + + /** + * Event fired every time the advanced filter dialog changes its position. + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogMoving"): FilterDialogMovingEvent; + + /** + * Event fired every time the advanced filter dialog changes its position. + * + * @optionValue Define event handler function. + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogMoving", optionValue: FilterDialogMovingEvent): void; + + /** + * Event fired before a filter row is added to the advanced filter dialog. + * Return false in order to cancel filter adding to the advanced filtering dialog. + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogFilterAdding"): FilterDialogFilterAddingEvent; + + /** + * Event fired before a filter row is added to the advanced filter dialog. + * Return false in order to cancel filter adding to the advanced filtering dialog. + * + * @optionValue Define event handler function. + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogFilterAdding", optionValue: FilterDialogFilterAddingEvent): void; + + /** + * Event fired after a filter row is added to the advanced filter dialog. + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogFilterAdded"): FilterDialogFilterAddedEvent; + + /** + * Event fired after a filter row is added to the advanced filter dialog. + * + * @optionValue Define event handler function. + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogFilterAdded", optionValue: FilterDialogFilterAddedEvent): void; + + /** + * Event fired before the advanced filter dialog is closed. + * Return false in order to cancel filtering dialog closing. + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogClosing"): FilterDialogClosingEvent; + + /** + * Event fired before the advanced filter dialog is closed. + * Return false in order to cancel filtering dialog closing. + * + * @optionValue Define event handler function. + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogClosing", optionValue: FilterDialogClosingEvent): void; + + /** + * Event fired after the advanced filter dialog has been closed. + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogClosed"): FilterDialogClosedEvent; + + /** + * Event fired after the advanced filter dialog has been closed. + * + * @optionValue Define event handler function. + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogClosed", optionValue: FilterDialogClosedEvent): void; + + /** + * Event fired before the contents of the advanced filter dialog are rendered. + * Return false in order to cancel filtering dialog rendering. + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogContentsRendering"): FilterDialogContentsRenderingEvent; + + /** + * Event fired before the contents of the advanced filter dialog are rendered. + * Return false in order to cancel filtering dialog rendering. + * + * @optionValue Define event handler function. + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogContentsRendering", optionValue: FilterDialogContentsRenderingEvent): void; + + /** + * Event fired after the contents of the advanced filter dialog are rendered. + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogContentsRendered"): FilterDialogContentsRenderedEvent; + + /** + * Event fired after the contents of the advanced filter dialog are rendered. + * + * @optionValue Define event handler function. + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogContentsRendered", optionValue: FilterDialogContentsRenderedEvent): void; + + /** + * Event fired when the OK button in the advanced filter dialog is pressed. + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogFiltering"): FilterDialogFilteringEvent; + + /** + * Event fired when the OK button in the advanced filter dialog is pressed. + * + * @optionValue Define event handler function. + */ + igGridFiltering(optionLiteral: 'option', optionName: "filterDialogFiltering", optionValue: FilterDialogFilteringEvent): void; + igGridFiltering(options: IgGridFiltering): JQuery; + igGridFiltering(optionLiteral: 'option', optionName: string): any; + igGridFiltering(optionLiteral: 'option', options: IgGridFiltering): JQuery; + igGridFiltering(optionLiteral: 'option', optionName: string, optionValue: any): JQuery; + igGridFiltering(methodName: string, ...methodParams: any[]): any; +} +interface IgGridColumnGroupOptions { + /** + * Sets whether the group is expanded or collapsed. Applied only if the allowGroupCollapsing is set to true. + * + */ + expanded?: boolean; + + /** + * Sets whether expansion indicators are visible in the group header. + * + */ + allowGroupCollapsing?: boolean; + + /** + * Sets when should the group be hidden. Applied only if the allowGroupCollapsing is set to true. + * + * + * Valid values: + * "never" never hide the group + * "always" always hide the group + * "parentcollapsed" hide the group when its parent group is collapsed + * "parentexpanded" hide the group when its parent group is expanded + */ + hidden?: string; + + /** + * Option for IgGridColumnGroupOptions + */ + [optionName: string]: any; +} + +interface IgGridColumn { + /** + * Header text for the specified column. + * + */ + headerText?: string; + + /** + * The property in the data source to which the column is bound. Also used to identify the column by, and find specific columns with API methods such as [columnByKey](ui.iggrid#methods:columnByKey). + * + */ + key?: string; + + /** + * Reference to a function (string or function) which will be used for formatting the cell values. The function should accept a value and return the new formatted value. [Here column formatting is explained in details](http://www.igniteui.com/help/iggrid-columns-and-layout#column-formatting) + * + * + * Valid values: + * "string" The name of the function which will be used for formatting the cell values. + * "function" Function which will be used for formatting the cell values. The function should accept a value and return the new formatted value. + */ + formatter?: string|Function; + + /** + * Gets/Sets the type of formatting for cells of the column. Default value is null. Checkout [Formatting Dates, Numbers and Strings](http://www.igniteui.com/help/formatting-dates-numbers-and-strings) for details on the valid formatting specifiers. + * + * If dataType is "date", then supported formats are following: "date", "dateLong", "dateTime", "time", "timeLong", "MM/dd/yyyy", "MMM-d, yy, h:mm:ss tt", "dddd d MMM", etc. + * If dataType is "number", then supported numeric formats are following: "number", "currency", "percent", "int", "double", "0.00", "#.0####", "0", "#.#######", etc. + * The value of "double" will be similar to "number", but with unlimited maximum number of decimal places. + * The format patterns and rules for numbers and dates are defined in $.ig.regional.defaults object. + * If dataType is "string" or not set, then format is rendered as it is with replacement of possible "{0}" flag by value in cell. Example, if format is set to "Name: {0}" and value in cell is "Bob", then value will appear as "Name: Bob" + * If value is set to "checkbox", then checkboxes are used regardless of renderCheckboxes option of the grid. That has effect only when dataType option of column is set to "bool". + */ + format?: string; + + /** + * Data type of the column cell values: string, number, bool, date, object. + * + */ + dataType?: string|number|boolean|Date|Object; + + /** + * 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 + */ + width?: string|number; + + /** + * Initial visibility of the column. A column can be hidden without the Hiding feature being enabled but there will be no UI for unhiding it. Columns can be defined as hidden in the options of the Hiding feature as well and those definitions take precedence. + * + */ + hidden?: boolean; + + /** + * Sets a template for an individual column. the contents of the template should be the HTML markup that goes inside the table cell, or the entire table cell markup. [Here's an example of creating a basic column template](http://www.igniteui.com/help/creating-a-basic-column-template-in-the-iggrid) + * + */ + template?: string; + + /** + * Sets whether column data is derived from the datasource. If set to true, then the cells in this column are not bound to the data source. The data in this column is populated using [formula](ui.iggrid#options:columns.formula), or using [unboundValues](ui.iggrid#options:columns.unboundValues), or through the [setUnboundValues](ui.iggrid#methods:setUnboundValues) API method. [Here's an overview of the unbound columns feature](http://www.igniteui.com/help/iggrid-unboundcolumns-overview) + * + */ + unbound?: boolean; + + /** + * Options used to configure collapsible column [groups](ui.iggrid#options:columns.group). + * + */ + groupOptions?: IgGridColumnGroupOptions; + + /** + * Array of child column definitions. If the column has the property group than the grid has multi column headers. + * + */ + group?: any[]; + + /** + * Determines the way in which dates will be displayed in the grid for this column. + * + * + * Valid values: + * "local" The dates for this column will be rendered in the client's local timezone. + * "utc" The dates for this column will be rendered in their UTC representation. + */ + dateDisplayType?: string; + + /** + * This option has been deprecated as of the June 2016 service release. + * Adjust span of multi column header cell. Use option rowSpan. + */ + rowspan?: number; + + /** + * A reference to or the name of a JavaScript function, which will calculate the value of the current cell based on other cell values in the same row. Used with [unbound columns](ui.iggrid#options:columns.unbound). + * + * + * Valid values: + * "string" The name of the JavaScript function. + * "function" Reference to the JavaScript function. + */ + formula?: string|Function; + + /** + * Array of values which will be populated in the column cells at initialization, if the column is [unbound](ui.iggrid#options:columns.unbound). + * + */ + unboundValues?: any[]; + + /** + * Space-separated list of CSS classes to be applied on the header cell of this column. + * + */ + headerCssClass?: string; + + /** + * Space-separated list of CSS classes to be applied on the data cells of this column. The class is not applied if the column has a column [template](ui.iggrid#options:columns.template) defined, which contains full definition in the template. + * + */ + columnCssClass?: string; + + /** + * This option is applicable only for columns with [dataType](ui.iggrid#options:columns.dataType) of object. Reference to a function, or the name of the function, that will be used for complex data extraction from the data records, whose return value will be used for all data operations associated with this column and will be displayed as cell value. [Here you can find more examples of how to setup a column mapper](http://www.igniteui.com/help/iggrid-columns-and-layout#defining-mapper) + * + * + * Valid values: + * "string" The name of the mapper function. + * "function" Reference to the mapper function. + */ + mapper?: string|Function; + + /** + * Specifies the row index of the cell in a Multi-Row Layout configuration. All columns must have this property set for the multi-row-layout mode to be enabled. [Here you can find more about the Multi-Row Layout feature](http://www.igniteui.com/help/iggrid-multirowlayout) + * + */ + rowIndex?: number; + + /** + * Specifies the column index of the cell in a Multi-Row Layout configuration. All columns must have this property set for the multi-row-layout mode to be enabled. [Here you can find more about the Multi-Row Layout feature](http://www.igniteui.com/help/iggrid-multirowlayout) + * + */ + columnIndex?: number; + + /** + * Specifies the navigation index of the cell for the TAB sequence when the cells are in edit mode in a Multi-Row Layout grid. Has no effect otherwise. [Here you can find more about the Multi-Row Layout feature](http://www.igniteui.com/help/iggrid-multirowlayout) + * + */ + navigationIndex?: number; + + /** + * Specifies the colSpan of the cell in a Multi-Row Layout configuration. colSpan 0 is not supported and will be changed to 1 by the grid. [Here you can find more about the Multi-Row Layout feature](http://www.igniteui.com/help/iggrid-multirowlayout) + * + */ + colSpan?: number; + + /** + * Specifies the rowSpan of the cell in a Multi-Row Layout configuration. rowSpan 0 is not supported and will be changed to 1 by the grid. [Here you can find more about the Multi-Row Layout feature](http://www.igniteui.com/help/iggrid-multirowlayout). If multi-row-layout is not used but multi-column-header is set then this option is used to adjust span of header cell. + * + */ + rowSpan?: number; + + /** + * Option for IgGridColumn + */ + [optionName: string]: any; +} + +interface IgGridFeature { + /** + * Name of the feature to be enabled. + */ + name?: string; + + /** + * Option for IgGridFeature + */ + [optionName: string]: any; +} + +interface IgGridRestSettingsCreate { + /** + * Specifies a remote URL to which create requests will be sent. This will be used for both batch and non-batch, however if template is also set, this URL will only be used for batch requests. + * + */ + url?: string; + + /** + * Specifies a remote URL template. Use ${id} in place of the resource id. + * + */ + template?: string; + + /** + * Specifies whether create requests will be sent in batches + * + */ + batch?: boolean; + + /** + * Option for IgGridRestSettingsCreate + */ + [optionName: string]: any; +} + +interface IgGridRestSettingsUpdate { + /** + * Specifies a remote URL to which update requests will be sent. This will be used for both batch and non-batch, however if template is also set, this URL will only be used for batch requests. + */ + url?: string; + + /** + * Specifies a remote URL template. Use ${id} in place of the resource id. + */ + template?: string; + + /** + * Specifies whether update requests will be sent in batches + */ + batch?: boolean; + + /** + * Option for IgGridRestSettingsUpdate + */ + [optionName: string]: any; +} + +interface IgGridRestSettingsRemove { + /** + * Specifies a remote URL to which remove requests will be sent. This will be used for both batch and non-batch, however if template is also set, this URL will only be used for batch requests. + */ + url?: string; + + /** + * Specifies a remote URL template. Use ${id} in place of the resource id. + */ + template?: string; + + /** + * Specifies whether update requests will be sent in batches + */ + batch?: boolean; + + /** + * Option for IgGridRestSettingsRemove + */ + [optionName: string]: any; +} + +interface IgGridRestSettings { + /** + * Settings for create requests + * + */ + create?: IgGridRestSettingsCreate; + + /** + * Settings for update requests + */ + update?: IgGridRestSettingsUpdate; + + /** + * Settings for remove requests + */ + remove?: IgGridRestSettingsRemove; + + /** + * Specifies whether the ids of the removed resources are send through the request URI + */ + encodeRemoveInRequestUri?: boolean; + + /** + * Specifies a custom function to serialize content sent to the server. It should accept a single object or an array of objects and return a string. If not specified, JSON.stringify() will be used. + * + */ + contentSerializer?: Function; + + /** + * Specifies the content type of the request. See http://api.jquery.com/jQuery.ajax/ => contentType + * + */ + contentType?: string; + + /** + * Option for IgGridRestSettings + */ + [optionName: string]: any; +} + +interface IgGridScrollSettings { + /** + * Sets gets current vertical position. + * + */ + scrollTop?: number; + + /** + * Sets gets current horizontal position. + * + */ + scrollLeft?: number; + + /** + * Sets gets the step of the default scrolling behavior when using the mouse wheel. + * + */ + wheelStep?: number; + + /** + * Sets gets if smoother scrolling with small intertia should be used when using the mouse wheel. + * + */ + smoothing?: boolean; + + /** + * Sets or gets the modifier for how many pixels will be scrolled when using the mouse wheel once. This is used only for the [smooth scrolling behavior](ui.iggrid#options:scrollSettings.smoothing). + * + */ + smoothingStep?: number; + + /** + * Sets or gets the modifier for how long the scroll ‘animation’ lasts when using the mouse wheel once. This is used only for the [smooth scrolling behavior](ui.iggrid#options:scrollSettings.smoothing). + * + */ + smoothingDuration?: number; + + /** + * Sets gets the modifier for how much the inertia scrolls on touch devices. Note: Value set to 0 would disable touch movements. Value set to -1 would invert them. + * + */ + inertiaStep?: number; + + /** + * Sets gets the modifier for how long the inertia last on touch devices. + * + */ + inertiaDuration?: number; + + /** + * Option for IgGridScrollSettings + */ + [optionName: string]: any; +} + +interface CellClickEvent { + (event: Event, ui: CellClickEventUIParam): void; +} + +interface CellClickEventUIParam { +} + +interface CellRightClickEvent { + (event: Event, ui: CellRightClickEventUIParam): void; +} + +interface CellRightClickEventUIParam { +} + +interface DataRenderingEvent { + (event: Event, ui: DataRenderingEventUIParam): void; +} + +interface DataRenderingEventUIParam { +} + +interface DataRenderedEvent { + (event: Event, ui: DataRenderedEventUIParam): void; +} + +interface DataRenderedEventUIParam { +} + +interface HeaderRenderingEvent { + (event: Event, ui: HeaderRenderingEventUIParam): void; +} + +interface HeaderRenderingEventUIParam { +} + +interface HeaderRenderedEvent { + (event: Event, ui: HeaderRenderedEventUIParam): void; +} + +interface HeaderRenderedEventUIParam { +} + +interface CaptionRenderingEvent { + (event: Event, ui: CaptionRenderingEventUIParam): void; +} + +interface CaptionRenderingEventUIParam { +} + +interface CaptionRenderedEvent { + (event: Event, ui: CaptionRenderedEventUIParam): void; +} + +interface CaptionRenderedEventUIParam { +} + +interface FooterRenderingEvent { + (event: Event, ui: FooterRenderingEventUIParam): void; +} + +interface FooterRenderingEventUIParam { +} + +interface FooterRenderedEvent { + (event: Event, ui: FooterRenderedEventUIParam): void; +} + +interface FooterRenderedEventUIParam { +} + +interface HeaderCellRenderedEvent { + (event: Event, ui: HeaderCellRenderedEventUIParam): void; +} + +interface HeaderCellRenderedEventUIParam { +} + +interface RowsRenderingEvent { + (event: Event, ui: RowsRenderingEventUIParam): void; +} + +interface RowsRenderingEventUIParam { +} + +interface RowsRenderedEvent { + (event: Event, ui: RowsRenderedEventUIParam): void; +} + +interface RowsRenderedEventUIParam { +} + +interface SchemaGeneratedEvent { + (event: Event, ui: SchemaGeneratedEventUIParam): void; +} + +interface SchemaGeneratedEventUIParam { +} + +interface ColumnsCollectionModifiedEvent { + (event: Event, ui: ColumnsCollectionModifiedEventUIParam): void; +} + +interface ColumnsCollectionModifiedEventUIParam { +} + +interface RequestErrorEvent { + (event: Event, ui: RequestErrorEventUIParam): void; +} + +interface RequestErrorEventUIParam { +} + +interface CreatedEvent { + (event: Event, ui: CreatedEventUIParam): void; +} + +interface CreatedEventUIParam { +} + +interface DestroyedEvent { + (event: Event, ui: DestroyedEventUIParam): void; +} + +interface DestroyedEventUIParam { +} + +interface IgGrid { + /** + * 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). + * + * + * Valid values: + * "string" The widget width can be set in pixels (px) or percentage (%). Example values: "800px", "800" (defaults to pixels), "100%". + * "number" The widget width can be set in pixels as a number. Example values: 800, 700. + * "null" will stretch to fit the sum of the columns widths. + */ + width?: string|number; + + /** + * 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). + * + * + * Valid values: + * "string" The widget height can be set in pixels (px) and percentage (%). + * "number" The widget height can be set as a number + * "null" will stretch vertically to fit data. + */ + height?: string|number; + + /** + * If autoAdjustHeight is set to false, the [height](ui.iggrid#options:height) will be set only on the scrolling container, and all other UI elements such as paging footer / filter row / headers will add on top of that, so the total height of the grid will be more than this value - the height of the scroll container (content area) will not be dynamically calculated. Setting this option to false will usually result in a lot better initial rendering performance for large data sets ( > 1000 rows rendered at once, no [virtualization](ui.iggrid#options:virtualization) enabled), since no reflows will be made by browsers when accessing DOM properties such as offsetHeight. + * + */ + autoAdjustHeight?: boolean; + + /** + * 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. + * + * + * Valid values: + * "string" The avarage row height can be set in pixels ("25px"). + * "number" The avarage row height can be set in pixels as a number (25). + */ + avgRowHeight?: string|number; + + /** + * 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. + * + * + * Valid values: + * "string" The avarage column width can be set in pixels ("25px"). + * "number" The avarage column width can be set in pixels as a number (25). + */ + avgColumnWidth?: string|number; + + /** + * Default column width that will be set for all columns, that don't have [column width](ui.iggrid#options:columns.width) defined. + * + * + * Valid values: + * "string" The default column width can be set in pixels ("100px"). + * "number" The default column width can be set in pixels as a number (100). + */ + defaultColumnWidth?: string|number; + + /** + * If no [columns](ui.iggrid#options:columns) collection is defined, and autoGenerateColumns is set to true, [columns](ui.iggrid#options:columns) will be inferred from the data source before the [dataRendering](ui.iggrid#events:dataRendering) event is fired. The inferred [columns](ui.iggrid#options:columns) collection will be available to the developer for modification at [dataRendering](ui.iggrid#events:dataRendering). If autoGenerateColumns is not explicitly set and [columns](ui.iggrid#options:columns) has at least one column defined then autoGenerateColumns is automatically set to false. + * If autoGenerateColumns is true and there are columns defined auto-generated columns will render after the explicitly defined ones. + * Since auto-generated columns don't have width defined consider setting [defaultColumnWidth](ui.iggrid#options:defaultColumnWidth) as well. + * + */ + autoGenerateColumns?: boolean; + + /** + * Enables/disables column and row virtualization at the same time. Virtualization can greatly enhance rendering performance. If enabled, the number of actual rendered rows (DOM elements) will be constant and related to the visible viewport of the grid. As the end user scrolls, those DOM elements will be dynamically reused to render the new data. [Here you can find more info about the performance guidelines when using the igGrid](http://www.igniteui.com/help/iggrid-performance-guide) + * + */ + virtualization?: boolean; + + /** + * Determines row virtualization mode. + * + * + * Valid values: + * "fixed" Renders only the visible rows and/or columns in the grid. On scrolling the same rows and/or columns are updated with new data from the data source. Only fixed virtualization can work with column virtualization at the same time. Fixed virtualization is not supported by some grid features: Resizing, Group By, Responsive. + * "continuous" renders a pre-defined number of rows in the grid. On scrolling the continuous virtualization loads another portion of rows and disposes the current one. + */ + virtualizationMode?: string; + + /** + * Enables virtualization for rows only. [Here you can find more info about igGrid row virtualization](http://www.igniteui.com/help/iggrid-virtualization-overview) + * + */ + rowVirtualization?: boolean; + + /** + * Enables virtualization for columns only. Column virtualization can work only in combination with fixed row virtalization. Setting columnVirtualization to true will automatically set [virtualization](ui.iggrid#options:virtualization) to true and [virtualizationMode](ui.iggrid#options:virtualizationMode) to "fixed". + * + */ + columnVirtualization?: boolean; + + /** + * Number of pixels to scroll the grid by, when virtualization is enabled, and mouse wheel scrolling is performed over the virtual grid area. If "null" the step will be equal to the [avgRowHeight](ui.iggrid#options:avgRowHeight). + * + */ + virtualizationMouseWheelStep?: number; + + /** + * If this option is set to true, the height of the grid row will be calculated automatically based on the [avgRowHeight](ui.iggrid#options:avgRowHeight) and the visible virtual records. If no [avgRowHeight](ui.iggrid#options:avgRowHeight) is specified, it will be calculated automatically at runtime. + * + */ + adjustVirtualHeights?: boolean; + + /** + * 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. + * + * + * Valid values: + * "infragistics" The grid will use the Infragistics Templating engine to render its [column templates](ui.iggrid#options:columns.template) and specific parts of the UI. + * "jsRender" The grid will use jsRender to render its [column templates](ui.iggrid#options:columns.template) and specific parts of the UI. + */ + templatingEngine?: string; + + /** + * An array of column objects. Checkout the [Columns and Layout](http://www.igniteui.com/help/iggrid-columns-and-layout#defining-columns) topic for details on configuring the columns array. + * + */ + columns?: IgGridColumn[]; + + /** + * Can be any valid data source accepted by [$.ig.DataSource](ig.datasource), or an instance of an $.ig.DataSource itself + * + * + * Valid values: + * "array" dataSource as an array + * "object" ddataSource as an object + * "string" dataSource as a string + */ + dataSource?: Array|Object|string; + + /** + * Specifies a remote URL as a data source, from which data will be retrieved using the [$.ig.DataSource](ig.datasource). + * + */ + dataSourceUrl?: string; + + /** + * Explicitly set data source type (such as "json"). Please refer to the documentation of [$.ig.DataSource type](ig.datasource#options:settings.type). + * + */ + dataSourceType?: string; + + /** + * See [$.ig.DataSource responseDataKey](ig.datasource#options:settings.responseDataKey). This is the property in the responses where data records are held, if the response is wrapped. + * + */ + responseDataKey?: string; + + /** + * See [$.ig.DataSource responseTotalRecCountKey](ig.datasource#options:settings.responseTotalRecCountKey). Property in the response specifying the total number of records on the server. + * + */ + responseTotalRecCountKey?: string; + + /** + * Specifies the HTTP verb to be used to issue the requests to a remote data source. + * + */ + requestType?: string; + + /** + * Content type of the response. See http://api.jquery.com/jQuery.ajax/ => contentType + * + */ + responseContentType?: string; + + /** + * Controls the visibility of the grid header. + * + */ + showHeader?: boolean; + + /** + * Controls the visibility of the grid footer. + * + */ + showFooter?: boolean; + + /** + * Headers will be fixed if this option is set to true, and only the grid data will be scrollable. If [virtualization](ui.iggrid#options:virtualization) is enabled, fixedHeaders will always act as if it's true, no matter which value is set. + * + */ + fixedHeaders?: boolean; + + /** + * Footers will be fixed if this option is set to true, and only the grid data will be scrollable. If [virtualization](ui.iggrid#options:virtualization) is enabled, fixedFooters will always act as if it's true, no matter which value is set. + * + */ + fixedFooters?: boolean; + + /** + * Caption text that will be shown above the grid header. + * + */ + caption?: string; + + /** + * List of grid feature definitions: sorting, paging, etc. Each feature goes with its separate options that are documented for the feature accordingly. [Here you can find detailed documentation for all igGrid features](http://www.igniteui.com/help/iggrid-features-landing-page) + * + */ + features?: IgGridFeature[]; + + /** + * Initial tabIndex attribute that will be set on all focusable elements. + * + */ + tabIndex?: number; + + /** + * If this option is set to false, the data to which the grid is bound will be used "as is" with no additional transformations based on [columns](ui.iggrid#options:columns) defined. Otherwise only the subset of data properties used in the [columns](ui.iggrid#options:columns) defined will be extracted in a new object and used. + * + */ + localSchemaTransform?: boolean; + + /** + * Key of the column containing unique identifiers for the data records. + * + */ + primaryKey?: string; + + /** + * If true, the transaction log will always be sent in the request for remote data, by the data source. Also this means that if there are values in the log, a POST will be performed instead of GET. + * + */ + serializeTransactionLog?: boolean; + + /** + * Automatically commits the transactions as rows/cells are being edited to the client data source. A [saveChanges](ui.iggrid#methods:saveChanges) call still needs to be performed in order to commit the transactions to a server-side data source. + * + */ + autoCommit?: boolean; + + /** + * If set to true, the following behavior will take place: + * If a new row is added, and then deleted, there will be no transaction added to the log. + * If a new row is added, edited, then deleted, there will be no transaction added to the log. + * If several edits are made to a row or an individual cell, this should result in a single transaction. + * Note: This option takes effect only when [autoCommit](ui.iggrid#options:autoCommit) is set to false. + * + */ + aggregateTransactions?: boolean; + + /** + * 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) + * + * + * Valid values: + * "date" formats only Date columns + * "number" formats only number columns + * "dateandnumber" formats both Date and number columns + * "true" formats Date and number columns + * "false" auto formatting is disabled + */ + autoFormat?: string|boolean; + + /** + * Gets sets ability to render checkboxes and use checkbox editor when dataType of a column is "bool". Checkboxes are not rendered for boolean values in columns with a [column template](ui.iggrid#options:columns.template). + * + */ + renderCheckboxes?: boolean; + + /** + * URL to which updating requests will be made. + * + */ + 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). + * + */ + alternateRowStyles?: boolean; + + /** + * If set to true and all columns' widths are specified and their combined width is less than the grid width then the last column width will be automatically adjusted to fill the remaining empty space of the grid. + * + */ + autofitLastColumn?: boolean; + + /** + * Enables/disables rendering of hover styles when the mouse is over a record. This can be useful in templating scenarios, for example, where we don't want to apply hover styling to templated content. + * + */ + enableHoverStyles?: boolean; + + /** + * Enables/Disables serializing client date as UTC ISO 8061 string instead of using the local time and zone values. + * + */ + enableUTCDates?: boolean; + + /** + * Merge unbound columns values inside data source when data source is remote. If true then the unbound columns are merged to the data source at runtime on the server. Note that data source is expanded with the new data and this could cause performance issues when the data is huge. If mergeUnboundColumns is false then the unbound data is sent and merged on the client. This option is used by the [igGrid MVC Helper](http://www.igniteui.com/help/iggrid-developing-asp-net-mvc-applications-with-iggrid). + * Checkout [Populating Unbound Columns Remotely (igGrid)](http://www.igniteui.com/help/iggrid-unboundcolumns-populating-with-data-remotely) topic for more information. + * + */ + mergeUnboundColumns?: boolean; + + /** + * When dataSource is a remote URL, defines whether to set the type of the remote data source to JSONP. + * + */ + jsonpRequest?: boolean; + + /** + * Enables/disables grid adjusting its dimensions when its [width](ui.iggrid#options:width) and/or [height](ui.iggrid#options:height) is set in percent (%) and grid parent DOM container is resized. + * + */ + enableResizeContainerCheck?: boolean; + + /** + * Configures how the feature chooser icon should display on header cells - e.g. to display as gear icon or not. + * + * + * Valid values: + * "none" Always hide the feature chooser icon; The feature chooser is shown on tapping/clicking the column header. + * "desktopOnly" Always show the icon on desktop but hide when touch device detected. + * "always" Always show it in any environment. Chooser is shown when tapping the gear icon or column header. + */ + featureChooserIconDisplay?: string; + + /** + * Settings related to content scrolling. + * + */ + scrollSettings?: IgGridScrollSettings; + + /** + * Event fired when a cell is clicked. + */ + cellClick?: CellClickEvent; + + /** + * Event fired when a cell is right clicked. + */ + cellRightClick?: CellRightClickEvent; + + /** + * Event fired before data binding takes place. + * + * Return false in order to cancel data binding. + */ + dataBinding?: DataBindingEvent; + + /** + * Event fired after data binding is complete. + */ + dataBound?: DataBoundEvent; + + /** + * Event fired before the grid starts rendering (all contents). + * This event is fired only when the grid is being initialized. + * It will not be fired if the grid is rebound to its data + * (for example, when calling the dataBind() API method + * or when changing the page size (when paging is enabled)). + * Return false in order to cancel grid rendering. + */ + rendering?: RenderingEvent; + + /** + * Event fired after the whole grid widget has been rendered (including headers, footers, etc.). + * This event is fired only when the grid is being initialized. + * It will not be fired if the grid is rebound to its data + * (for example, when calling the dataBind() API method + * or when changing the page size (when paging is enabled)). + */ + rendered?: RenderedEvent; + + /** + * Event fired before the TBODY holding the data records starts its rendering. + * Return false in order to cancel data records rendering. + */ + dataRendering?: DataRenderingEvent; + + /** + * Event fired after all of the data records in the grid table body have been rendered. + */ + dataRendered?: DataRenderedEvent; + + /** + * Event fired before the header starts its rendering. + * Return false in order to cancel header rendering. + */ + headerRendering?: HeaderRenderingEvent; + + /** + * Event fired after the header has been rendered. + */ + headerRendered?: HeaderRenderedEvent; + + /** + * Event fired before the caption starts its rendering. + * Return false in order to cancel caption rendering. + */ + captionRendering?: CaptionRenderingEvent; + + /** + * Event fired after the caption has been rendered. + */ + captionRendered?: CaptionRenderedEvent; + + /** + * Event fired before the footer starts its rendering. + * + * Return false in order to cancel footer rendering. + */ + footerRendering?: FooterRenderingEvent; + + /** + * Event fired after the footer has been rendered. + */ + footerRendered?: FooterRenderedEvent; + + /** + * Event fired after every TH in the grid header has been rendered. + */ + headerCellRendered?: HeaderCellRenderedEvent; + + /** + * Event fired before actual data rows (TRs) are rendered. + * Return false in order to cancel rows rendering. + */ + rowsRendering?: RowsRenderingEvent; + + /** + * Event fired after data rows are rendered. + */ + rowsRendered?: RowsRenderedEvent; + + /** + * Event fired after $.ig.DataSource schema has been generated, in case it needs to be modified. + */ + schemaGenerated?: SchemaGeneratedEvent; + + /** + * Event fired after the columns colection has been modified(e.g. a column is hidden) + */ + columnsCollectionModified?: ColumnsCollectionModifiedEvent; + + /** + * Event fired if there is an error in the request, when the grid is doing a remote operation, + * such as data binding, paging, sorting, etc. + */ + requestError?: RequestErrorEvent; + + /** + * Fired when the grid is created and the initial structure is rendered (this doesn't necessarily imply the data will be there if the data source is remote) + */ + created?: CreatedEvent; + + /** + * Fired when the grid is destroyed + */ + destroyed?: DestroyedEvent; + + /** + * Option for igGrid + */ + [optionName: string]: any; +} +interface IgGridMethods { + /** + * Returns the element holding the data records + */ + widget(): void; + + /** + * Returns whether grid has non-data fixed columns(e.g. row selectors column) + */ + hasFixedDataSkippedColumns(): boolean; + + /** + * Returns true if grid has at least one fixed columns(even if a non-data column - like row-selectors column) + */ + hasFixedColumns(): boolean; + + /** + * Returns the current fixing direction. NOTE - use only if ColumnFixing feature is enabled + * @return left|right + */ + fixingDirection(): string; + + /** + * 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. + */ + isFixedColumn(colKey: Object): boolean; + + /** + * Called to detect whether grid container is resized. When autoAdjustHeight is true and height of the grid is changed then the height of grid is re-set. + */ + resizeContainer(): void; + + /** + * Returns whether the header identified by colKey is multicolumn header(has children) + * + * @param colKey value of the column key + */ + isGroupHeader(colKey: string): Object; + + /** + * Returns an object that contains information on the passed Dom element + * + * rowId - the id of the record associated with the element - if primaryKey is not set this will be null. + * rowIndex - the index (in the DOM) of the row associated with the element. + * 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. + */ + getElementInfo(elem: Element): Object; + + /** + * Returns the ID of the TABLE element where data records are rendered + */ + id(): string; + + /** + * Returns the DIV that is the topmost container of the grid widget + */ + container(): Element; + + /** + * Returns the table that contains the header cells + */ + headersTable(): Element; + + /** + * Returns the table that contains the footer cells + */ + footersTable(): Element; + + /** + * Returns the DIV that is used as a scroll container for the grid contents + */ + scrollContainer(): Element; + + /** + * Returns the DIV that is the topmost container of the fixed grid - contains fixed columns(in ColumnFixing scenario) + */ + fixedContainer(): Element; + + /** + * Returns the DIV that is the topmost container of the fixed body grid - contains fixed columns(in ColumnFixing scenario) + */ + fixedBodyContainer(): Element; + + /** + * Returns container(jQuery representation) containing fixed footer - contains fixed columns(in ColumnFixing scenario) + */ + fixedFooterContainer(): Object; + + /** + * Returns container(jQuery representation) containing fixed header - contains fixed columns(in ColumnFixing scenario) + */ + fixedHeaderContainer(): Object; + + /** + * Returns the table that contains the FIXED header cells - contains fixed columns(in ColumnFixing scenario) + */ + fixedHeadersTable(): Element; + + /** + * Returns the table that contains the footer cells - contains fixed columns(in ColumnFixing scenario) + */ + fixedFootersTable(): Element; + + /** + * 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 + */ + 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. + */ + cellById(rowId: Object, columnKey: string): Element; + + /** + * Returns the fixed table - contains fixed columns(in ColumnFixing scenario). If there aren't fixed columns returns the grid table + */ + fixedTable(): Object; + + /** + * Gets all immediate children of the current grid + */ + immediateChildrenWidgets(): any[]; + + /** + * Gets all children of the current grid, recursively + */ + childrenWidgets(): any[]; + + /** + * Gets all children's elements of the current grid, recursively + */ + children(): any[]; + + /** + * Gets all immediate children's elements of the current grid + */ + immediateChildren(): any[]; + + /** + * Returns the row (TR element) at the specified index. jQuery selectors aren't used for performance reasons + * + * @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. + */ + 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. + */ + fixedRowAt(i: number): Element; + + /** + * Returns a list of all fixed TR elements holding data in the grid(in ColumnFixing scenario - only when there is at least one fixed column) + */ + fixedRows(): any[]; + + /** + * Returns a list of all TR elements holding data in the grid(when there is at least one fixed column returns rows only in the UNFIXED table) + */ + rows(): any[]; + + /** + * Returns all data fixed rows recursively, not only the immediate ones(in ColumnFixing scenario - only when there is at least one fixed column) + */ + allFixedRows(): any[]; + + /** + * Returns all data rows recursively, not only the immediate ones(when there is at least one fixed column returns rows only in the UNFIXED table) + */ + allRows(): any[]; + + /** + * Returns a column object by the specified 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. + */ + columnByText(text: string): Object; + + /** + * Returns an array of selected cells in arbitrary order where every objects has the format { element: , row: , index: , rowIndex: , columnKey: } . + * If multiple selection is disabled the function will return null. + */ + selectedCells(): any[]; + + /** + * Returns an array of selected rows in arbitrary order where every object has the format { element: , index: } . + * If multiple selection is disabled the function will return null. + */ + selectedRows(): any[]; + + /** + * Returns the currently selected cell that has the format { element: , row: , index: , rowIndex: , columnKey: }, if any. + * If multiple selection is enabled the function will return null. + */ + selectedCell(): Object; + + /** + * Returns the currently selected row that has the format { element: , index: }, if any. + * If multiple selection is enabled the function will return null. + */ + selectedRow(): Object; + + /** + * Returns the currently active (focused) cell that has the format { element: , row: , index: , rowIndex: , columnKey: }, if any. + */ + activeCell(): Object; + + /** + * Returns the currently active (focused) row that has the format { element: , index: }, if any. + */ + activeRow(): Object; + + /** + * 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. + */ + getCellValue(rowId: Object, colKey: string): Object; + + /** + * 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. + */ + 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 + */ + 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. + */ + 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. + */ + rollback(rowId?: Object, updateUI?: boolean): any[]; + + /** + * 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 + */ + findRecordByKey(key: Object): Object; + + /** + * 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. + */ + getDetachedRecord(t: Object): Object; + + /** + * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source. + * That is a wrapper for this.dataSource.pendingTransactions(). + */ + pendingTransactions(): any[]; + + /** + * Returns a list of all transaction objects that are either pending, or have been committed in the data source. + * That is a wrapper for this.dataSource.allTransactions(). + */ + allTransactions(): any[]; + + /** + * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently. + * That is a wrapper for this.dataSource.transactionsAsString(). + */ + transactionsAsString(): string; + + /** + * 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) + */ + 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. + */ + 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. + */ + dataSourceObject(dataSource: Object): void; + + /** + * Returns the total number of records in the underlying backend. If paging or filtering is enabled, this may differ from the number of records in the client-side data source. + * In order for this to work, the response JSON/XML must include a property that specifies the total number of records, which name is specified by options.responseTotalRecCountKey. + * This functionality is completely delegated to the data source control. + */ + totalRecordsCount(): number; + + /** + * Causes the grid to data bind to the data source (local or remote) , and re-render all of the data as well + * + * @param internal + */ + dataBind(internal: Object): void; + + /** + * 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. + */ + moveColumn(column: Object, target: Object, after?: boolean, inDom?: boolean, callback?: Function): void; + + /** + * 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) + */ + showColumn(column: Object, callback: Function): void; + + /** + * 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) + */ + 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 + */ + 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 + */ + 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 + */ + 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 + */ + getUnboundColumnByKey(key: string): Object; + + /** + * Returns whether there is vertical scrollbar. Because of perfrormance issues in older Internet Explorer especially 8,9 - there is no need to check if height is not set - there is no scrollbar OR if row virtualization is enabled - it is supposed there is vertical scrollbar + */ + hasVerticalScrollbar(): Object; + + /** + * Auto resize columns that have property width set to "*" so content to be auto-fitted(not shrinked/cutted). Auto-resizing is applied ONLY for visible columns + */ + autoSizeColumns(): void; + + /** + * 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 + */ + calculateAutoFitColumnWidth(columnIndex: number): number; + + /** + * 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 + */ + getVisibleIndexByKey(columnKey: string, includeDataSkip: boolean): number; + + /** + * When called the method re-renders the whole grid(also rebinds to the data source) and renders the cols object + * + * @param cols an array of column objects + */ + renderMultiColumnHeader(cols: any[]): void; + + /** + * 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 + */ + 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 + */ + getColumnByTD($td: Object): Object; + + /** + * Destroy is part of the jQuery UI widget API and does the following: + * 1. Remove custom CSS classes that were added. + * 2. Unwrap any wrapping elements such as scrolling divs and other containers. + * 3. Unbind all events that were bound. + * + * @param notToCallDestroy + */ + destroy(notToCallDestroy: Object): void; +} +interface JQuery { + data(propertyName: "igGrid"): IgGridMethods; +} + +interface JQuery { + igGrid(methodName: "widget"): void; + igGrid(methodName: "hasFixedDataSkippedColumns"): boolean; + igGrid(methodName: "hasFixedColumns"): boolean; + igGrid(methodName: "fixingDirection"): string; + igGrid(methodName: "isFixedColumn", colKey: Object): boolean; + igGrid(methodName: "resizeContainer"): void; + igGrid(methodName: "isGroupHeader", colKey: string): Object; + igGrid(methodName: "getElementInfo", elem: Element): Object; + igGrid(methodName: "id"): string; + igGrid(methodName: "container"): Element; + igGrid(methodName: "headersTable"): Element; + igGrid(methodName: "footersTable"): Element; + igGrid(methodName: "scrollContainer"): Element; + igGrid(methodName: "fixedContainer"): Element; + igGrid(methodName: "fixedBodyContainer"): Element; + igGrid(methodName: "fixedFooterContainer"): Object; + igGrid(methodName: "fixedHeaderContainer"): Object; + igGrid(methodName: "fixedHeadersTable"): Element; + igGrid(methodName: "fixedFootersTable"): Element; + igGrid(methodName: "cellAt", x: number, y: number, isFixed: boolean): Element; + igGrid(methodName: "cellById", rowId: Object, columnKey: string): Element; + igGrid(methodName: "fixedTable"): Object; + igGrid(methodName: "immediateChildrenWidgets"): any[]; + igGrid(methodName: "childrenWidgets"): any[]; + igGrid(methodName: "children"): any[]; + igGrid(methodName: "immediateChildren"): any[]; + igGrid(methodName: "rowAt", i: number): Element; + igGrid(methodName: "rowById", rowId: Object, isFixed?: boolean): Element; + igGrid(methodName: "fixedRowAt", i: number): Element; + igGrid(methodName: "fixedRows"): any[]; + igGrid(methodName: "rows"): any[]; + igGrid(methodName: "allFixedRows"): any[]; + igGrid(methodName: "allRows"): any[]; + igGrid(methodName: "columnByKey", key: string): Object; + igGrid(methodName: "columnByText", text: string): Object; + igGrid(methodName: "selectedCells"): any[]; + igGrid(methodName: "selectedRows"): any[]; + igGrid(methodName: "selectedCell"): Object; + igGrid(methodName: "selectedRow"): Object; + igGrid(methodName: "activeCell"): Object; + igGrid(methodName: "activeRow"): Object; + igGrid(methodName: "getCellValue", rowId: Object, colKey: string): Object; + igGrid(methodName: "getCellText", rowId: Object, colKey: string): string; + igGrid(methodName: "setColumnTemplate", col: Object, tmpl: string, render?: boolean): void; + igGrid(methodName: "commit", rowId?: Object): void; + igGrid(methodName: "rollback", rowId?: Object, updateUI?: boolean): any[]; + igGrid(methodName: "findRecordByKey", key: Object): Object; + igGrid(methodName: "getDetachedRecord", t: Object): Object; + igGrid(methodName: "pendingTransactions"): any[]; + igGrid(methodName: "allTransactions"): any[]; + igGrid(methodName: "transactionsAsString"): string; + igGrid(methodName: "saveChanges", success: Function, error: Function): void; + igGrid(methodName: "renderNewRow", rec?: string): void; + igGrid(methodName: "dataSourceObject", dataSource: Object): void; + igGrid(methodName: "totalRecordsCount"): number; + igGrid(methodName: "dataBind", internal: Object): void; + igGrid(methodName: "moveColumn", column: Object, target: Object, after?: boolean, inDom?: boolean, callback?: Function): void; + igGrid(methodName: "showColumn", column: Object, callback: Function): void; + igGrid(methodName: "hideColumn", column: Object, callback: Function): void; + igGrid(methodName: "getUnboundValues", key: string): Object; + igGrid(methodName: "setUnboundValues", key: string, values: any[], removeOldValues: Object): void; + igGrid(methodName: "setUnboundValueByPK", col: string, rowId: string, val: Object, notToRender: Object): void; + igGrid(methodName: "getUnboundColumnByKey", key: string): Object; + igGrid(methodName: "hasVerticalScrollbar"): Object; + igGrid(methodName: "autoSizeColumns"): void; + igGrid(methodName: "calculateAutoFitColumnWidth", columnIndex: number): number; + igGrid(methodName: "getVisibleIndexByKey", columnKey: string, includeDataSkip: boolean): number; + igGrid(methodName: "renderMultiColumnHeader", cols: any[]): void; + igGrid(methodName: "virtualScrollTo", scrollerPosition: Object): void; + igGrid(methodName: "getColumnByTD", $td: Object): Object; + igGrid(methodName: "destroy", notToCallDestroy: Object): 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). + * + */ + igGrid(optionLiteral: 'option', optionName: "width"): string|number; + + /** + * 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). + * + * + * @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; + + /** + * 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). + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "height", optionValue: string|number): void; + + /** + * If autoAdjustHeight is set to false, the [height](ui.iggrid#options:height) will be set only on the scrolling container, and all other UI elements such as paging footer / filter row / headers will add on top of that, so the total height of the grid will be more than this value - the height of the scroll container (content area) will not be dynamically calculated. Setting this option to false will usually result in a lot better initial rendering performance for large data ( > 1000 rows rendered at once, no [virtualization](ui.iggrid#options:virtualization) enabled), since no reflows will be made by browsers when accessing DOM properties such as offsetHeight. + * + */ + igGrid(optionLiteral: 'option', optionName: "autoAdjustHeight"): boolean; + + /** + * If autoAdjustHeight is set to false, the [height](ui.iggrid#options:height) will be set only on the scrolling container, and all other UI elements such as paging footer / filter row / headers will add on top of that, so the total height of the grid will be more than this value - the height of the scroll container (content area) will not be dynamically calculated. Setting this option to false will usually result in a lot better initial rendering performance for large data sets ( > 1000 rows rendered at once, no [virtualization](ui.iggrid#options:virtualization) enabled), since no reflows will be made by browsers when accessing DOM properties such as offsetHeight. + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "autoAdjustHeight", optionValue: boolean): void; + + /** + * 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; + + /** + * 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. + * + * + * @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; + + /** + * 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. + * + * + * @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; + + /** + * Default column width that will be set for all columns, that don't have [column width](ui.iggrid#options:columns.width) defined. + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "defaultColumnWidth", optionValue: string|number): void; + + /** + * If no [columns](ui.iggrid#options:columns) collection is defined, and autoGenerateColumns is set to true, [columns](ui.iggrid#options:columns) will be inferred from the data source before the [dataRendering](ui.iggrid#events:dataRendering) event is fired. The inferred [columns](ui.iggrid#options:columns) collection will be available to the developer for modification at [dataRendering](ui.iggrid#events:dataRendering). If autoGenerateColumns is not explicitly set and [columns](ui.iggrid#options:columns) has at least one column defined then autoGenerateColumns is automatically set to false. + * If autoGenerateColumns is true and there are columns defined auto-generated columns will render after the explicitly defined ones. + * Since auto-generated columns don't have width defined consider setting [defaultColumnWidth](ui.iggrid#options:defaultColumnWidth) as well. + * + */ + igGrid(optionLiteral: 'option', optionName: "autoGenerateColumns"): boolean; + + /** + * If no [columns](ui.iggrid#options:columns) collection is defined, and autoGenerateColumns is set to true, [columns](ui.iggrid#options:columns) will be inferred from the data source before the [dataRendering](ui.iggrid#events:dataRendering) event is fired. The inferred [columns](ui.iggrid#options:columns) collection will be available to the developer for modification at [dataRendering](ui.iggrid#events:dataRendering). If autoGenerateColumns is not explicitly set and [columns](ui.iggrid#options:columns) has at least one column defined then autoGenerateColumns is automatically set to false. + * If autoGenerateColumns is true and there are columns defined auto-generated columns will render after the explicitly defined ones. + * Since auto-generated columns don't have width defined consider setting [defaultColumnWidth](ui.iggrid#options:defaultColumnWidth) as well. + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "autoGenerateColumns", optionValue: boolean): void; + + /** + * Enables/disables column and row virtualization at the same time. Virtualization can greatly enhance rendering performance. If enabled, the number of actual rendered rows (DOM elements) will be constant and related to the visible viewport of the grid. As the end user scrolls, those DOM elements will be dynamically reused to render the new data. [Here you can find more info about the performance guidelines when using the igGrid](http://www.igniteui.com/help/iggrid-performance-guide) + * + */ + igGrid(optionLiteral: 'option', optionName: "virtualization"): boolean; + + /** + * Enables/disables column and row virtualization at the same time. Virtualization can greatly enhance rendering performance. If enabled, the number of actual rendered rows (DOM elements) will be constant and related to the visible viewport of the grid. As the end user scrolls, those DOM elements will be dynamically reused to render the new data. [Here you can find more info about the performance guidelines when using the igGrid](http://www.igniteui.com/help/iggrid-performance-guide) + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "virtualization", optionValue: boolean): void; + + /** + * Determines row virtualization mode. + * + */ + igGrid(optionLiteral: 'option', optionName: "virtualizationMode"): string; + + /** + * Determines row virtualization mode. + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "virtualizationMode", optionValue: string): void; + + /** + * Enables virtualization for rows only. [Here you can find more info about igGrid row virtualization](http://www.igniteui.com/help/iggrid-virtualization-overview) + * + */ + igGrid(optionLiteral: 'option', optionName: "rowVirtualization"): boolean; + + /** + * Enables virtualization for rows only. [Here you can find more info about igGrid row virtualization](http://www.igniteui.com/help/iggrid-virtualization-overview) + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "rowVirtualization", optionValue: boolean): void; + + /** + * Enables virtualization for columns only. Column virtualization can work only in combination with fixed row virtalization. Setting columnVirtualization to true will automatically set [virtualization](ui.iggrid#options:virtualization) to true and [virtualizationMode](ui.iggrid#options:virtualizationMode) to "fixed". + * + */ + igGrid(optionLiteral: 'option', optionName: "columnVirtualization"): boolean; + + /** + * Enables virtualization for columns only. Column virtualization can work only in combination with fixed row virtalization. Setting columnVirtualization to true will automatically set [virtualization](ui.iggrid#options:virtualization) to true and [virtualizationMode](ui.iggrid#options:virtualizationMode) to "fixed". + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "columnVirtualization", optionValue: boolean): void; + + /** + * Number of pixels to scroll the grid by, when virtualization is enabled, and mouse wheel scrolling is performed over the virtual grid area. If "null" the step will be equal to the [avgRowHeight](ui.iggrid#options:avgRowHeight). + * + */ + igGrid(optionLiteral: 'option', optionName: "virtualizationMouseWheelStep"): number; + + /** + * Number of pixels to scroll the grid by, when virtualization is enabled, and mouse wheel scrolling is performed over the virtual grid area. If "null" the step will be equal to the [avgRowHeight](ui.iggrid#options:avgRowHeight). + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "virtualizationMouseWheelStep", optionValue: number): void; + + /** + * If this option is set to true, the height of the grid row will be calculated automatically based on the [avgRowHeight](ui.iggrid#options:avgRowHeight) and the visible virtual records. If no [avgRowHeight](ui.iggrid#options:avgRowHeight) is specified, it will be calculated automatically at runtime. + * + */ + igGrid(optionLiteral: 'option', optionName: "adjustVirtualHeights"): boolean; + + /** + * If this option is set to true, the height of the grid row will be calculated automatically based on the [avgRowHeight](ui.iggrid#options:avgRowHeight) and the visible virtual records. If no [avgRowHeight](ui.iggrid#options:avgRowHeight) is specified, it will be calculated automatically at runtime. + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "adjustVirtualHeights", optionValue: boolean): void; + + /** + * 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; + + /** + * 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. + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "templatingEngine", optionValue: string): void; + + /** + * An array of column objects. Checkout the [Columns and Layout](http://www.igniteui.com/help/iggrid-columns-and-layout#defining-columns) topic for details on configuring the columns array. + * + */ + igGrid(optionLiteral: 'option', optionName: "columns"): IgGridColumn[]; + + /** + * An array of column objects. Checkout the [Columns and Layout](http://www.igniteui.com/help/iggrid-columns-and-layout#defining-columns) topic for details on configuring the columns array. + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "columns", optionValue: IgGridColumn[]): void; + + /** + * 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; + + /** + * Can be any valid data source accepted by [$.ig.DataSource](ig.datasource), or an instance of an $.ig.DataSource itself + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "dataSource", optionValue: Array|Object|string): void; + + /** + * Gets a remote URL as a data source, from which data will be retrieved using the [$.ig.DataSource](ig.datasource). + * + */ + igGrid(optionLiteral: 'option', optionName: "dataSourceUrl"): string; + + /** + * Sets a remote URL as a data source, from which data will be retrieved using the [$.ig.DataSource](ig.datasource). + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "dataSourceUrl", 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). + * + */ + igGrid(optionLiteral: 'option', optionName: "dataSourceType"): string; + + /** + * Explicitly set data source type (such as "json"). Please refer to the documentation of [$.ig.DataSource type](ig.datasource#options:settings.type). + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "dataSourceType", optionValue: string): void; + + /** + * See [$.ig.DataSource responseDataKey](ig.datasource#options:settings.responseDataKey). This is the property in the responses where data records are held, if the response is wrapped. + * + */ + igGrid(optionLiteral: 'option', optionName: "responseDataKey"): string; + + /** + * See [$.ig.DataSource responseDataKey](ig.datasource#options:settings.responseDataKey). This is the property in the responses where data records are held, if the response is wrapped. + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "responseDataKey", optionValue: string): void; + + /** + * See [$.ig.DataSource responseTotalRecCountKey](ig.datasource#options:settings.responseTotalRecCountKey). Property in the response specifying the total number of records on the server. + * + */ + igGrid(optionLiteral: 'option', optionName: "responseTotalRecCountKey"): string; + + /** + * See [$.ig.DataSource responseTotalRecCountKey](ig.datasource#options:settings.responseTotalRecCountKey). Property in the response specifying the total number of records on the server. + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "responseTotalRecCountKey", optionValue: string): void; + + /** + * Gets the HTTP verb to be used to issue the requests to a remote data source. + * + */ + igGrid(optionLiteral: 'option', optionName: "requestType"): string; + + /** + * Sets the HTTP verb to be used to issue the requests to a remote data source. + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "requestType", optionValue: string): void; + + /** + * Content type of the response. See http://api.jquery.com/jQuery.ajax/ => contentType + * + */ + igGrid(optionLiteral: 'option', optionName: "responseContentType"): string; + + /** + * Content type of the response. See http://api.jquery.com/jQuery.ajax/ => contentType + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "responseContentType", optionValue: string): void; + + /** + * Controls the visibility of the grid header. + * + */ + igGrid(optionLiteral: 'option', optionName: "showHeader"): boolean; + + /** + * Controls the visibility of the grid header. + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "showHeader", optionValue: boolean): void; + + /** + * Controls the visibility of the grid footer. + * + */ + igGrid(optionLiteral: 'option', optionName: "showFooter"): boolean; + + /** + * Controls the visibility of the grid footer. + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "showFooter", optionValue: boolean): void; + + /** + * Headers will be fixed if this option is set to true, and only the grid data will be scrollable. If [virtualization](ui.iggrid#options:virtualization) is enabled, fixedHeaders will always act as if it's true, no matter which value is set. + * + */ + igGrid(optionLiteral: 'option', optionName: "fixedHeaders"): boolean; + + /** + * Headers will be fixed if this option is set to true, and only the grid data will be scrollable. If [virtualization](ui.iggrid#options:virtualization) is enabled, fixedHeaders will always act as if it's true, no matter which value is set. + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "fixedHeaders", optionValue: boolean): void; + + /** + * Footers will be fixed if this option is set to true, and only the grid data will be scrollable. If [virtualization](ui.iggrid#options:virtualization) is enabled, fixedFooters will always act as if it's true, no matter which value is set. + * + */ + igGrid(optionLiteral: 'option', optionName: "fixedFooters"): boolean; + + /** + * Footers will be fixed if this option is set to true, and only the grid data will be scrollable. If [virtualization](ui.iggrid#options:virtualization) is enabled, fixedFooters will always act as if it's true, no matter which value is set. + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "fixedFooters", optionValue: boolean): void; + + /** + * Caption text that will be shown above the grid header. + * + */ + igGrid(optionLiteral: 'option', optionName: "caption"): string; + + /** + * Caption text that will be shown above the grid header. + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "caption", optionValue: string): void; + + /** + * List of grid feature definitions: sorting, paging, etc. Each feature goes with its separate options that are documented for the feature accordingly. [Here you can find detailed documentation for all igGrid features](http://www.igniteui.com/help/iggrid-features-landing-page) + * + */ + igGrid(optionLiteral: 'option', optionName: "features"): IgGridFeature[]; + + /** + * List of grid feature definitions: sorting, paging, etc. Each feature goes with its separate options that are documented for the feature accordingly. [Here you can find detailed documentation for all igGrid features](http://www.igniteui.com/help/iggrid-features-landing-page) + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "features", optionValue: IgGridFeature[]): void; + + /** + * Initial tabIndex attribute that will be set on all focusable elements. + * + */ + igGrid(optionLiteral: 'option', optionName: "tabIndex"): number; + + /** + * Initial tabIndex attribute that will be set on all focusable elements. + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "tabIndex", optionValue: number): void; + + /** + * If this option is set to false, the data to which the grid is bound will be used "as is" with no additional transformations based on [columns](ui.iggrid#options:columns) defined. Otherwise only the subset of data properties used in the [columns](ui.iggrid#options:columns) defined will be extracted in a new object and used. + * + */ + igGrid(optionLiteral: 'option', optionName: "localSchemaTransform"): boolean; + + /** + * If this option is set to false, the data to which the grid is bound will be used "as is" with no additional transformations based on [columns](ui.iggrid#options:columns) defined. Otherwise only the subset of data properties used in the [columns](ui.iggrid#options:columns) defined will be extracted in a new object and used. + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "localSchemaTransform", optionValue: boolean): void; + + /** + * Key of the column containing unique identifiers for the data records. + * + */ + igGrid(optionLiteral: 'option', optionName: "primaryKey"): string; + + /** + * Key of the column containing unique identifiers for the data records. + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "primaryKey", optionValue: string): void; + + /** + * If true, the transaction log will always be sent in the request for remote data, by the data source. Also this means that if there are values in the log, a POST will be performed instead of GET. + * + */ + igGrid(optionLiteral: 'option', optionName: "serializeTransactionLog"): boolean; + + /** + * If true, the transaction log will always be sent in the request for remote data, by the data source. Also this means that if there are values in the log, a POST will be performed instead of GET. + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "serializeTransactionLog", optionValue: boolean): void; + + /** + * Automatically commits the transactions as rows/cells are being edited to the client data source. A [saveChanges](ui.iggrid#methods:saveChanges) call still needs to be performed in order to commit the transactions to a server-side data source. + * + */ + igGrid(optionLiteral: 'option', optionName: "autoCommit"): boolean; + + /** + * Automatically commits the transactions as rows/cells are being edited to the client data source. A [saveChanges](ui.iggrid#methods:saveChanges) call still needs to be performed in order to commit the transactions to a server-side data source. + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "autoCommit", optionValue: boolean): void; + + /** + * If set to true, the following behavior will take place: + * If a new row is added, and then deleted, there will be no transaction added to the log. + * If a new row is added, edited, then deleted, there will be no transaction added to the log. + * If several edits are made to a row or an individual cell, this should result in a single transaction. + * Note: This option takes effect only when [autoCommit](ui.iggrid#options:autoCommit) is set to false. + * + */ + igGrid(optionLiteral: 'option', optionName: "aggregateTransactions"): boolean; + + /** + * If set to true, the following behavior will take place: + * If a new row is added, and then deleted, there will be no transaction added to the log. + * If a new row is added, edited, then deleted, there will be no transaction added to the log. + * If several edits are made to a row or an individual cell, this should result in a single transaction. + * Note: This option takes effect only when [autoCommit](ui.iggrid#options:autoCommit) is set to false. + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "aggregateTransactions", optionValue: boolean): void; + + /** + * 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; + + /** + * 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) + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "autoFormat", optionValue: string|boolean): void; + + /** + * Gets ability to render checkboxes and use checkbox editor when dataType of a column is "bool". Checkboxes are not rendered for boolean values in columns with a [column template](ui.iggrid#options:columns.template). + * + */ + igGrid(optionLiteral: 'option', optionName: "renderCheckboxes"): boolean; + + /** + * Sets ability to render checkboxes and use checkbox editor when dataType of a column is "bool". Checkboxes are not rendered for boolean values in columns with a [column template](ui.iggrid#options:columns.template). + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "renderCheckboxes", optionValue: boolean): void; + + /** + * URL to which updating requests will be made. + * + */ + igGrid(optionLiteral: 'option', optionName: "updateUrl"): string; + + /** + * URL to which updating requests will be made. + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "updateUrl", optionValue: string): void; + + /** + * Settings related to REST compliant update routines. + * + */ + igGrid(optionLiteral: 'option', optionName: "restSettings"): IgGridRestSettings; + + /** + * Settings related to REST compliant update routines. + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "restSettings", optionValue: IgGridRestSettings): void; + + /** + * Enables/disables rendering of alternating row styles (odd and even rows receive different styling). + * + */ + igGrid(optionLiteral: 'option', optionName: "alternateRowStyles"): boolean; + + /** + * Enables/disables rendering of alternating row styles (odd and even rows receive different styling). + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "alternateRowStyles", optionValue: boolean): void; + + /** + * If set to true and all columns' widths are specified and their combined width is less than the grid width then the last column width will be automatically adjusted to fill the remaining empty space of the grid. + * + */ + igGrid(optionLiteral: 'option', optionName: "autofitLastColumn"): boolean; + + /** + * If set to true and all columns' widths are specified and their combined width is less than the grid width then the last column width will be automatically adjusted to fill the remaining empty space of the grid. + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "autofitLastColumn", optionValue: boolean): void; + + /** + * Enables/disables rendering of hover styles when the mouse is over a record. This can be useful in templating scenarios, for example, where we don't want to apply hover styling to templated content. + * + */ + igGrid(optionLiteral: 'option', optionName: "enableHoverStyles"): boolean; + + /** + * Enables/disables rendering of hover styles when the mouse is over a record. This can be useful in templating scenarios, for example, where we don't want to apply hover styling to templated content. + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "enableHoverStyles", optionValue: boolean): void; + + /** + * Enables/Disables serializing client date as UTC ISO 8061 string instead of using the local time and zone values. + * + */ + igGrid(optionLiteral: 'option', optionName: "enableUTCDates"): boolean; + + /** + * Enables/Disables serializing client date as UTC ISO 8061 string instead of using the local time and zone values. + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "enableUTCDates", optionValue: boolean): void; + + /** + * Merge unbound columns values inside data source when data source is remote. If true then the unbound columns are merged to the data source at runtime on the server. Note that data source is expanded with the new data and this could cause performance issues when the data is huge. If mergeUnboundColumns is false then the unbound data is sent and merged on the client. This option is used by the [igGrid MVC Helper](http://www.igniteui.com/help/iggrid-developing-asp-net-mvc-applications-with-iggrid). + * Checkout [Populating Unbound Columns Remotely (igGrid)](http://www.igniteui.com/help/iggrid-unboundcolumns-populating-with-data-remotely) topic for more information. + * + */ + igGrid(optionLiteral: 'option', optionName: "mergeUnboundColumns"): boolean; + + /** + * Merge unbound columns values inside data source when data source is remote. If true then the unbound columns are merged to the data source at runtime on the server. Note that data source is expanded with the new data and this could cause performance issues when the data is huge. If mergeUnboundColumns is false then the unbound data is sent and merged on the client. This option is used by the [igGrid MVC Helper](http://www.igniteui.com/help/iggrid-developing-asp-net-mvc-applications-with-iggrid). + * Checkout [Populating Unbound Columns Remotely (igGrid)](http://www.igniteui.com/help/iggrid-unboundcolumns-populating-with-data-remotely) topic for more information. + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "mergeUnboundColumns", optionValue: boolean): void; + + /** + * When dataSource is a remote URL, defines whether to set the type of the remote data source to JSONP. + * + */ + igGrid(optionLiteral: 'option', optionName: "jsonpRequest"): boolean; + + /** + * When dataSource is a remote URL, defines whether to set the type of the remote data source to JSONP. + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "jsonpRequest", optionValue: boolean): void; + + /** + * Enables/disables grid adjusting its dimensions when its [width](ui.iggrid#options:width) and/or [height](ui.iggrid#options:height) is set in percent (%) and grid parent DOM container is resized. + * + */ + igGrid(optionLiteral: 'option', optionName: "enableResizeContainerCheck"): boolean; + + /** + * Enables/disables grid adjusting its dimensions when its [width](ui.iggrid#options:width) and/or [height](ui.iggrid#options:height) is set in percent (%) and grid parent DOM container is resized. + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "enableResizeContainerCheck", optionValue: boolean): void; + + /** + * 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; + + /** + * Configures how the feature chooser icon should display on header cells - e.g. to display as gear icon or not. + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "featureChooserIconDisplay", optionValue: string): void; + + /** + * Settings related to content scrolling. + * + */ + igGrid(optionLiteral: 'option', optionName: "scrollSettings"): IgGridScrollSettings; + + /** + * Settings related to content scrolling. + * + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "scrollSettings", optionValue: IgGridScrollSettings): void; + + /** + * Event fired when a cell is clicked. + */ + igGrid(optionLiteral: 'option', optionName: "cellClick"): CellClickEvent; + + /** + * Event fired when a cell is clicked. + * + * @optionValue Define event handler function. + */ + igGrid(optionLiteral: 'option', optionName: "cellClick", optionValue: CellClickEvent): void; + + /** + * Event fired when a cell is right clicked. + */ + igGrid(optionLiteral: 'option', optionName: "cellRightClick"): CellRightClickEvent; + + /** + * Event fired when a cell is right clicked. + * + * @optionValue Define event handler function. + */ + igGrid(optionLiteral: 'option', optionName: "cellRightClick", optionValue: CellRightClickEvent): void; + + /** + * Event fired before data binding takes place. + * + * Return false in order to cancel data binding. + */ + igGrid(optionLiteral: 'option', optionName: "dataBinding"): DataBindingEvent; + + /** + * Event fired before data binding takes place. + * + * Return false in order to cancel data binding. + * + * @optionValue Define event handler function. + */ + igGrid(optionLiteral: 'option', optionName: "dataBinding", optionValue: DataBindingEvent): void; + + /** + * Event fired after data binding is complete. + */ + igGrid(optionLiteral: 'option', optionName: "dataBound"): DataBoundEvent; + + /** + * Event fired after data binding is complete. + * + * @optionValue Define event handler function. + */ + igGrid(optionLiteral: 'option', optionName: "dataBound", optionValue: DataBoundEvent): void; + + /** + * Event fired before the grid starts rendering (all contents). + * This event is fired only when the grid is being initialized. + * It will not be fired if the grid is rebound to its data + * (for example, when calling the dataBind() API method + * or when changing the page size (when paging is enabled)). + * Return false in order to cancel grid rendering. + */ + igGrid(optionLiteral: 'option', optionName: "rendering"): RenderingEvent; + + /** + * Event fired before the grid starts rendering (all contents). + * This event is fired only when the grid is being initialized. + * It will not be fired if the grid is rebound to its data + * (for example, when calling the dataBind() API method + * or when changing the page size (when paging is enabled)). + * Return false in order to cancel grid rendering. + * + * @optionValue Define event handler function. + */ + igGrid(optionLiteral: 'option', optionName: "rendering", optionValue: RenderingEvent): void; + + /** + * Event fired after the whole grid widget has been rendered (including headers, footers, etc.). + * This event is fired only when the grid is being initialized. + * It will not be fired if the grid is rebound to its data + * (for example, when calling the dataBind() API method + * or when changing the page size (when paging is enabled)). + */ + igGrid(optionLiteral: 'option', optionName: "rendered"): RenderedEvent; + + /** + * Event fired after the whole grid widget has been rendered (including headers, footers, etc.). + * This event is fired only when the grid is being initialized. + * It will not be fired if the grid is rebound to its data + * (for example, when calling the dataBind() API method + * or when changing the page size (when paging is enabled)). + * + * @optionValue Define event handler function. + */ + igGrid(optionLiteral: 'option', optionName: "rendered", optionValue: RenderedEvent): void; + + /** + * Event fired before the TBODY holding the data records starts its rendering. + * Return false in order to cancel data records rendering. + */ + igGrid(optionLiteral: 'option', optionName: "dataRendering"): DataRenderingEvent; + + /** + * Event fired before the TBODY holding the data records starts its rendering. + * Return false in order to cancel data records rendering. + * + * @optionValue Define event handler function. + */ + igGrid(optionLiteral: 'option', optionName: "dataRendering", optionValue: DataRenderingEvent): void; + + /** + * Event fired after all of the data records in the grid table body have been rendered. + */ + igGrid(optionLiteral: 'option', optionName: "dataRendered"): DataRenderedEvent; + + /** + * Event fired after all of the data records in the grid table body have been rendered. + * + * @optionValue Define event handler function. + */ + igGrid(optionLiteral: 'option', optionName: "dataRendered", optionValue: DataRenderedEvent): void; + + /** + * Event fired before the header starts its rendering. + * Return false in order to cancel header rendering. + */ + igGrid(optionLiteral: 'option', optionName: "headerRendering"): HeaderRenderingEvent; + + /** + * Event fired before the header starts its rendering. + * Return false in order to cancel header rendering. + * + * @optionValue Define event handler function. + */ + igGrid(optionLiteral: 'option', optionName: "headerRendering", optionValue: HeaderRenderingEvent): void; + + /** + * Event fired after the header has been rendered. + */ + igGrid(optionLiteral: 'option', optionName: "headerRendered"): HeaderRenderedEvent; + + /** + * Event fired after the header has been rendered. + * + * @optionValue Define event handler function. + */ + igGrid(optionLiteral: 'option', optionName: "headerRendered", optionValue: HeaderRenderedEvent): void; + + /** + * Event fired before the caption starts its rendering. + * Return false in order to cancel caption rendering. + */ + igGrid(optionLiteral: 'option', optionName: "captionRendering"): CaptionRenderingEvent; + + /** + * Event fired before the caption starts its rendering. + * Return false in order to cancel caption rendering. + * + * @optionValue Define event handler function. + */ + igGrid(optionLiteral: 'option', optionName: "captionRendering", optionValue: CaptionRenderingEvent): void; + + /** + * Event fired after the caption has been rendered. + */ + igGrid(optionLiteral: 'option', optionName: "captionRendered"): CaptionRenderedEvent; + + /** + * Event fired after the caption has been rendered. + * + * @optionValue Define event handler function. + */ + igGrid(optionLiteral: 'option', optionName: "captionRendered", optionValue: CaptionRenderedEvent): void; + + /** + * Event fired before the footer starts its rendering. + * + * Return false in order to cancel footer rendering. + */ + igGrid(optionLiteral: 'option', optionName: "footerRendering"): FooterRenderingEvent; + + /** + * Event fired before the footer starts its rendering. + * + * Return false in order to cancel footer rendering. + * + * @optionValue Define event handler function. + */ + igGrid(optionLiteral: 'option', optionName: "footerRendering", optionValue: FooterRenderingEvent): void; + + /** + * Event fired after the footer has been rendered. + */ + igGrid(optionLiteral: 'option', optionName: "footerRendered"): FooterRenderedEvent; + + /** + * Event fired after the footer has been rendered. + * + * @optionValue Define event handler function. + */ + igGrid(optionLiteral: 'option', optionName: "footerRendered", optionValue: FooterRenderedEvent): void; + + /** + * Event fired after every TH in the grid header has been rendered. + */ + igGrid(optionLiteral: 'option', optionName: "headerCellRendered"): HeaderCellRenderedEvent; + + /** + * Event fired after every TH in the grid header has been rendered. + * + * @optionValue Define event handler function. + */ + igGrid(optionLiteral: 'option', optionName: "headerCellRendered", optionValue: HeaderCellRenderedEvent): void; + + /** + * Event fired before actual data rows (TRs) are rendered. + * Return false in order to cancel rows rendering. + */ + igGrid(optionLiteral: 'option', optionName: "rowsRendering"): RowsRenderingEvent; + + /** + * Event fired before actual data rows (TRs) are rendered. + * Return false in order to cancel rows rendering. + * + * @optionValue Define event handler function. + */ + igGrid(optionLiteral: 'option', optionName: "rowsRendering", optionValue: RowsRenderingEvent): void; + + /** + * Event fired after data rows are rendered. + */ + igGrid(optionLiteral: 'option', optionName: "rowsRendered"): RowsRenderedEvent; + + /** + * Event fired after data rows are rendered. + * + * @optionValue Define event handler function. + */ + igGrid(optionLiteral: 'option', optionName: "rowsRendered", optionValue: RowsRenderedEvent): void; + + /** + * Event fired after $.ig.DataSource schema has been generated, in case it needs to be modified. + */ + igGrid(optionLiteral: 'option', optionName: "schemaGenerated"): SchemaGeneratedEvent; + + /** + * Event fired after $.ig.DataSource schema has been generated, in case it needs to be modified. + * + * @optionValue Define event handler function. + */ + igGrid(optionLiteral: 'option', optionName: "schemaGenerated", optionValue: SchemaGeneratedEvent): void; + + /** + * Event fired after the columns colection has been modified(e.g. a column is hidden) + */ + igGrid(optionLiteral: 'option', optionName: "columnsCollectionModified"): ColumnsCollectionModifiedEvent; + + /** + * Event fired after the columns colection has been modified(e.g. a column is hidden) + * + * @optionValue Define event handler function. + */ + igGrid(optionLiteral: 'option', optionName: "columnsCollectionModified", optionValue: ColumnsCollectionModifiedEvent): void; + + /** + * Event fired if there is an error in the request, when the grid is doing a remote operation, + * such as data binding, paging, sorting, etc. + */ + igGrid(optionLiteral: 'option', optionName: "requestError"): RequestErrorEvent; + + /** + * Event fired if there is an error in the request, when the grid is doing a remote operation, + * such as data binding, paging, sorting, etc. + * + * @optionValue Define event handler function. + */ + igGrid(optionLiteral: 'option', optionName: "requestError", optionValue: RequestErrorEvent): void; + + /** + * Fired when the grid is created and the initial structure is rendered (this doesn't necessarily imply the data will be there if the data source is remote) + */ + igGrid(optionLiteral: 'option', optionName: "created"): CreatedEvent; + + /** + * Fired when the grid is created and the initial structure is rendered (this doesn't necessarily imply the data will be there if the data source is remote) + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "created", optionValue: CreatedEvent): void; + + /** + * Fired when the grid is destroyed + */ + igGrid(optionLiteral: 'option', optionName: "destroyed"): DestroyedEvent; + + /** + * Fired when the grid is destroyed + * + * @optionValue New value to be set. + */ + igGrid(optionLiteral: 'option', optionName: "destroyed", optionValue: DestroyedEvent): void; + igGrid(options: IgGrid): JQuery; + igGrid(optionLiteral: 'option', optionName: string): any; + igGrid(optionLiteral: 'option', options: IgGrid): JQuery; + igGrid(optionLiteral: 'option', optionName: string, optionValue: any): JQuery; + igGrid(methodName: string, ...methodParams: any[]): any; +} interface IgGridGroupByGroupedColumn { /** * Key of the column that's grouped @@ -38744,6 +45460,12 @@ interface IgGridGroupByColumnSettings { */ summaries?: IgGridGroupByColumnSettingsSummaries; + /** + * Enables/disables default summaries per group data island or specifies summaries that are applied to specific column no matter the group. + * + */ + groupSummaries?: any; + /** * Option for IgGridGroupByColumnSettings */ @@ -38755,40 +45477,6 @@ interface GroupedColumnsChangingEvent { } interface GroupedColumnsChangingEventUIParam { - /** - * Used to access the GroupBy widget object - */ - owner?: any; - - /** - * Used to get a reference to the current groupedColumns. - */ - groupedColumns?: any; - - /** - * Used to get an object of the new grouped columns that should be applied.(it is set ONLY if called from modal dialog) - */ - newGroupedColumns?: any; - - /** - * Used to get a reference to the current column"s key that"s being grouped(not set if called from modal dialog) - */ - key?: any; - - /** - * Used to get a reference to the current layout object, if any(not set if called from modal dialog) - */ - layout?: any; - - /** - * Used to get a reference to the current child grid element, in case it's an hierarchical grid(not set if called from modal dialog) - */ - grid?: any; - - /** - * Used to get which user interaction triggers the event - possible options are dragAndDrop|modalDialog|sortStateChanged|removeButton|regroup - */ - triggeredBy?: any; } interface GroupedColumnsChangedEvent { @@ -38796,35 +45484,6 @@ interface GroupedColumnsChangedEvent { } interface GroupedColumnsChangedEventUIParam { - /** - * Used to access the GroupBy widget object - */ - owner?: any; - - /** - * Used to get a reference to the current groupedColumns - */ - groupedColumns?: any; - - /** - * Used to get a reference to the current column"s key that"s being grouped - */ - key?: any; - - /** - * Used to get a reference to the current layout object, if any - */ - layout?: any; - - /** - * Used to get a reference to the current child grid element, in case it's an hierarchical grid(not set if called from modal dialog) - */ - grid?: any; - - /** - * Used to get which user interaction triggers the event - possible options are dragAndDrop|modalDialog|sortStateChanged|removeButton|regroup - */ - triggeredBy?: any; } interface ModalDialogMovingEvent { @@ -38832,25 +45491,6 @@ interface ModalDialogMovingEvent { } interface ModalDialogMovingEventUIParam { - /** - * Used to get the reference to the igGridGroupBy widget. - */ - owner?: any; - - /** - * Used to get a reference to the Column Chooser element. This is a jQuery object. - */ - modalDialogElement?: any; - - /** - * Used to get the original position of the GroupBy Dialog div as { top, left } object, relative to the page. - */ - originalPosition?: any; - - /** - * Used to get the current position of the GroupBy Dialog div as { top, left } object, relative to the page. - */ - position?: any; } interface ModalDialogClosingEvent { @@ -38858,15 +45498,6 @@ interface ModalDialogClosingEvent { } interface ModalDialogClosingEventUIParam { - /** - * Used to get the reference to the igGridGroupBy widget. - */ - owner?: any; - - /** - * Used to get a reference to the modal dialog element. This is a jQuery object. - */ - modalDialogElement?: any; } interface ModalDialogClosedEvent { @@ -38874,15 +45505,6 @@ interface ModalDialogClosedEvent { } interface ModalDialogClosedEventUIParam { - /** - * Used to get the reference to the igGridGroupBy widget. - */ - owner?: any; - - /** - * Used to get a reference to the modal dialog element. This is a jQuery object. - */ - modalDialogElement?: any; } interface ModalDialogOpeningEvent { @@ -38890,15 +45512,6 @@ interface ModalDialogOpeningEvent { } interface ModalDialogOpeningEventUIParam { - /** - * Used to get the reference to the igGridGroupBy widget. - */ - owner?: any; - - /** - * Used to get a reference to the modal dialog element. This is a jQuery object. - */ - modalDialogElement?: any; } interface ModalDialogOpenedEvent { @@ -38906,15 +45519,6 @@ interface ModalDialogOpenedEvent { } interface ModalDialogOpenedEventUIParam { - /** - * Used to get the reference to the igGridGroupBy widget. - */ - owner?: any; - - /** - * Used to get a reference to the modal dialog element. This is a jQuery object. - */ - modalDialogElement?: any; } interface ModalDialogContentsRenderingEvent { @@ -38922,15 +45526,6 @@ interface ModalDialogContentsRenderingEvent { } interface ModalDialogContentsRenderingEventUIParam { - /** - * Used to get the reference to the igGridGroupby widget. - */ - owner?: any; - - /** - * Used to get a reference to the modal dialog element. This is a jQuery object. - */ - modalDialogElement?: any; } interface ModalDialogContentsRenderedEvent { @@ -38938,15 +45533,6 @@ interface ModalDialogContentsRenderedEvent { } interface ModalDialogContentsRenderedEventUIParam { - /** - * Used to get the reference to the igGridGroupBy widget. - */ - owner?: any; - - /** - * Used to get a reference to the modal dialog element. This is a jQuery object. - */ - modalDialogElement?: any; } interface ModalDialogButtonApplyClickEvent { @@ -38954,30 +45540,6 @@ interface ModalDialogButtonApplyClickEvent { } interface ModalDialogButtonApplyClickEventUIParam { - /** - * Used to get the reference to the igGridGroupby widget. - */ - owner?: any; - - /** - * Used to get a reference to the modal dialog element. This is a jQuery object. - */ - modalDialogElement?: any; - - /** - * Used to get the array of grouped columns - */ - groupedColumns?: any; - - /** - * Used to get array of column layouts - */ - groupedColumnLayouts?: any; - - /** - * Used to get array of sorted columns - */ - sortingExpr?: any; } interface ModalDialogButtonResetClickEvent { @@ -38985,15 +45547,6 @@ interface ModalDialogButtonResetClickEvent { } interface ModalDialogButtonResetClickEventUIParam { - /** - * Used to get the reference to the igGridGroupby widget. - */ - owner?: any; - - /** - * Used to get a reference to the modal dialog element. This is a jQuery object. - */ - modalDialogElement?: any; } interface ModalDialogGroupingColumnEvent { @@ -39001,20 +45554,6 @@ interface ModalDialogGroupingColumnEvent { } interface ModalDialogGroupingColumnEventUIParam { - /** - * Used to get the reference to the igGridGroupby widget. - */ - owner?: any; - - /** - * Used to get the key of the column to be grouped. - */ - key?: any; - - /** - * Used to get the layout of the columns - */ - layout?: any; } interface ModalDialogGroupColumnEvent { @@ -39022,25 +45561,6 @@ interface ModalDialogGroupColumnEvent { } interface ModalDialogGroupColumnEventUIParam { - /** - * Used to get the reference to the igGridGroupby widget. - */ - owner?: any; - - /** - * Used to get the key of the column to be grouped. - */ - key?: any; - - /** - * Used to get a reference to the current groupedColumns - */ - groupedColumns?: any; - - /** - * Used to get the layout of the columns - */ - layout?: any; } interface ModalDialogUngroupingColumnEvent { @@ -39048,20 +45568,6 @@ interface ModalDialogUngroupingColumnEvent { } interface ModalDialogUngroupingColumnEventUIParam { - /** - * Used to get the reference to the igGridGroupby widget. - */ - owner?: any; - - /** - * Used to get the key of the column to be grouped. - */ - key?: any; - - /** - * Used to get the layout of the columns - */ - layout?: any; } interface ModalDialogUngroupColumnEvent { @@ -39069,25 +45575,6 @@ interface ModalDialogUngroupColumnEvent { } interface ModalDialogUngroupColumnEventUIParam { - /** - * Used to get the reference to the igGridGroupby widget. - */ - owner?: any; - - /** - * Used to get a reference to the current groupedColumns - */ - groupedColumns?: any; - - /** - * Used to get the key of the column to be grouped. - */ - key?: any; - - /** - * Used to get the layout of the columns - */ - layout?: any; } interface ModalDialogSortGroupedColumnEvent { @@ -39095,25 +45582,6 @@ interface ModalDialogSortGroupedColumnEvent { } interface ModalDialogSortGroupedColumnEventUIParam { - /** - * Used to get the reference to the igGridGroupby widget. - */ - owner?: any; - - /** - * Used to get the key of the column to be grouped. - */ - key?: any; - - /** - * Used to get the layout of the columns - */ - layout?: any; - - /** - * Used to get whether column should be sorted ascending or descending - */ - isAsc?: any; } interface IgGridGroupBy { @@ -39134,6 +45602,16 @@ interface IgGridGroupBy { */ initialExpand?: boolean; + /** + * Specifies when paging is applied and there is at least one grouped column which records should be included in page processing. + * + * + * Valid values: + * "allRecords" All records are included in page processing - data records and group-by metadata records + * "dataRecordsOnly" Only data records are included in page processing(metadata group-by records are ignored) + */ + pagingMode?: string; + /** * Text that will be shown in the GroupBy area when there are no grouped columns * @@ -39405,167 +45883,102 @@ interface IgGridGroupBy { */ inherit?: boolean; + /** + * 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; + + /** + * Specifies the groupSummaries postion inside each group. + * + * + * Valid values: + * "top" One summary row will be displayed at the top for each group + * "bottom" One summary row will be displayed at the bottom for each group + * "both" Two summary rows will be be display for each group. One on the top and one on the bottom. + */ + groupSummariesPosition?: string; + /** * Event which is fired when the grouped columns collection is about to change. This event is fired even when button OK is clicked from the modal dialog(after event modalDialogButtonApplyClick is fired) - * use args.owner in order to access the GroupBy widget object - * use args.owner.grid to access the grid widget option - * use args.groupedColumns to get a reference to the current groupedColumns. - * use args.newGroupedColumns to get an object of the new grouped columns that should be applied.(it is set ONLY if called from modal dialog) - * use args.key to get a reference to the current column"s key that"s being grouped(not set if called from modal dialog) - * use args.layout to get a reference to the current layout object, if any(not set if called from modal dialog) - * use args.grid to get a reference to the current child grid element, in case it's an hierarchical grid(not set if called from modal dialog) - * use args.triggeredBy to get which user interaction triggers the event - possible options are dragAndDrop|modalDialog|sortStateChanged|removeButton|regroup */ groupedColumnsChanging?: GroupedColumnsChangingEvent; /** * Event which is fired when the groupedColumns collection has changed. This event is fired also when group/ungroup from GroupBy modal dialog but key, layout and grid are not set - * use args.owner in order to access the GroupBy widget object - * use args.owner.grid to access the grid widget option - * use args.groupedColumns to get a reference to the current groupedColumns - * use args.key to get a reference to the current column"s key that"s being grouped - * use args.layout to get a reference to the current layout object, if any - * use args.grid to get a reference to the current child grid element, in case it's an hierarchical grid(not set if called from modal dialog) - * use args.triggeredBy to get which user interaction triggers the event - possible options are dragAndDrop|modalDialog|sortStateChanged|removeButton|regroup */ groupedColumnsChanged?: GroupedColumnsChangedEvent; /** * Event fired every time the GroupBy Dialog changes its position. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupBy widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.modalDialogElement to get a reference to the Column Chooser element. This is a jQuery object. - * Use ui.originalPosition to get the original position of the GroupBy Dialog div as { top, left } object, relative to the page. - * Use ui.position to get the current position of the GroupBy Dialog div as { top, left } object, relative to the page. */ modalDialogMoving?: ModalDialogMovingEvent; /** * Event fired before the modal dialog is closed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupBy widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. */ modalDialogClosing?: ModalDialogClosingEvent; /** * Event fired after the modal dialog has been closed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupBy widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. */ modalDialogClosed?: ModalDialogClosedEvent; /** * Event fired before the modal dialog is opened. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupBy widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. */ modalDialogOpening?: ModalDialogOpeningEvent; /** * Event fired after the modal dialog is already opened. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupBy widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. */ modalDialogOpened?: ModalDialogOpenedEvent; /** * Event fired before the contents of the modal dialog are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupby widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. */ modalDialogContentsRendering?: ModalDialogContentsRenderingEvent; /** * Event fired after the contents of the modal dialog are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupBy widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. */ modalDialogContentsRendered?: ModalDialogContentsRenderedEvent; /** * Event fired when the button is Apply is clicked. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupby widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. - * Use ui.groupedColumns to get the array of grouped columns - * Use ui.groupedColumnLayouts to get array of column layouts - * Use ui.sortingExpr to get array of sorted columns */ modalDialogButtonApplyClick?: ModalDialogButtonApplyClickEvent; /** * Event fired when reset button is clicked. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupby widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. */ modalDialogButtonResetClick?: ModalDialogButtonResetClickEvent; /** * Event fired when column in modal dialog is clicked to be grouped. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupby widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.key to get the key of the column to be grouped. - * Use ui.layout to get the layout of the columns */ modalDialogGroupingColumn?: ModalDialogGroupingColumnEvent; /** * Event fired when column in modal dialog is clicked to be grouped. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupby widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.key to get the key of the column to be grouped. - * Use args.groupedColumns to get a reference to the current groupedColumns - * Use ui.layout to get the layout of the columns */ modalDialogGroupColumn?: ModalDialogGroupColumnEvent; /** * Event fired when column in modal dialog is clicked to be ungrouped. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupby widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.key to get the key of the column to be grouped. - * Use ui.layout to get the layout of the columns */ modalDialogUngroupingColumn?: ModalDialogUngroupingColumnEvent; /** * Event fired when column in modal dialog is clicked to be ungrouped. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupby widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use args.groupedColumns to get a reference to the current groupedColumns - * Use ui.key to get the key of the column to be grouped. - * Use ui.layout to get the layout of the columns */ modalDialogUngroupColumn?: ModalDialogUngroupColumnEvent; /** * Event fired when column in modal dialog is sorted. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupby widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.key to get the key of the column to be grouped. - * Use ui.layout to get the layout of the columns - * Use ui.isAsc to get whether column should be sorted ascending or descending */ modalDialogSortGroupedColumn?: ModalDialogSortGroupedColumnEvent; @@ -39711,6 +46124,20 @@ interface JQuery { */ igGridGroupBy(optionLiteral: 'option', optionName: "initialExpand", optionValue: boolean): void; + /** + * 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; + + /** + * Sets when paging is applied and there is at least one grouped column which records should be included in page processing. + * + * + * @optionValue New value to be set. + */ + igGridGroupBy(optionLiteral: 'option', optionName: "pagingMode", optionValue: string): void; + /** * Text that will be shown in the GroupBy area when there are no grouped columns * @@ -40297,29 +46724,45 @@ interface JQuery { */ igGridGroupBy(optionLiteral: 'option', optionName: "inherit", optionValue: boolean): void; + /** + * 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; + + /** + * Sets 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 + * + * + * + * @optionValue New value to be set. + */ + igGridGroupBy(optionLiteral: 'option', optionName: "groupSummaries", optionValue: any): void; + + /** + * Gets the groupSummaries postion inside each group. + * + */ + igGridGroupBy(optionLiteral: 'option', optionName: "groupSummariesPosition"): string; + + /** + * Sets the groupSummaries postion inside each group. + * + * + * @optionValue New value to be set. + */ + igGridGroupBy(optionLiteral: 'option', optionName: "groupSummariesPosition", optionValue: string): void; + /** * Event which is fired when the grouped columns collection is about to change. This event is fired even when button OK is clicked from the modal dialog(after event modalDialogButtonApplyClick is fired) - * use args.owner in order to access the GroupBy widget object - * use args.owner.grid to access the grid widget option - * use args.groupedColumns to get a reference to the current groupedColumns. - * use args.newGroupedColumns to get an object of the new grouped columns that should be applied.(it is set ONLY if called from modal dialog) - * use args.key to get a reference to the current column"s key that"s being grouped(not set if called from modal dialog) - * use args.layout to get a reference to the current layout object, if any(not set if called from modal dialog) - * use args.grid to get a reference to the current child grid element, in case it's an hierarchical grid(not set if called from modal dialog) - * use args.triggeredBy to get which user interaction triggers the event - possible options are dragAndDrop|modalDialog|sortStateChanged|removeButton|regroup */ igGridGroupBy(optionLiteral: 'option', optionName: "groupedColumnsChanging"): GroupedColumnsChangingEvent; /** * Event which is fired when the grouped columns collection is about to change. This event is fired even when button OK is clicked from the modal dialog(after event modalDialogButtonApplyClick is fired) - * use args.owner in order to access the GroupBy widget object - * use args.owner.grid to access the grid widget option - * use args.groupedColumns to get a reference to the current groupedColumns. - * use args.newGroupedColumns to get an object of the new grouped columns that should be applied.(it is set ONLY if called from modal dialog) - * use args.key to get a reference to the current column"s key that"s being grouped(not set if called from modal dialog) - * use args.layout to get a reference to the current layout object, if any(not set if called from modal dialog) - * use args.grid to get a reference to the current child grid element, in case it's an hierarchical grid(not set if called from modal dialog) - * use args.triggeredBy to get which user interaction triggers the event - possible options are dragAndDrop|modalDialog|sortStateChanged|removeButton|regroup * * @optionValue Define event handler function. */ @@ -40327,25 +46770,11 @@ interface JQuery { /** * Event which is fired when the groupedColumns collection has changed. This event is fired also when group/ungroup from GroupBy modal dialog but key, layout and grid are not set - * use args.owner in order to access the GroupBy widget object - * use args.owner.grid to access the grid widget option - * use args.groupedColumns to get a reference to the current groupedColumns - * use args.key to get a reference to the current column"s key that"s being grouped - * use args.layout to get a reference to the current layout object, if any - * use args.grid to get a reference to the current child grid element, in case it's an hierarchical grid(not set if called from modal dialog) - * use args.triggeredBy to get which user interaction triggers the event - possible options are dragAndDrop|modalDialog|sortStateChanged|removeButton|regroup */ igGridGroupBy(optionLiteral: 'option', optionName: "groupedColumnsChanged"): GroupedColumnsChangedEvent; /** * Event which is fired when the groupedColumns collection has changed. This event is fired also when group/ungroup from GroupBy modal dialog but key, layout and grid are not set - * use args.owner in order to access the GroupBy widget object - * use args.owner.grid to access the grid widget option - * use args.groupedColumns to get a reference to the current groupedColumns - * use args.key to get a reference to the current column"s key that"s being grouped - * use args.layout to get a reference to the current layout object, if any - * use args.grid to get a reference to the current child grid element, in case it's an hierarchical grid(not set if called from modal dialog) - * use args.triggeredBy to get which user interaction triggers the event - possible options are dragAndDrop|modalDialog|sortStateChanged|removeButton|regroup * * @optionValue Define event handler function. */ @@ -40353,23 +46782,11 @@ interface JQuery { /** * Event fired every time the GroupBy Dialog changes its position. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupBy widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.modalDialogElement to get a reference to the Column Chooser element. This is a jQuery object. - * Use ui.originalPosition to get the original position of the GroupBy Dialog div as { top, left } object, relative to the page. - * Use ui.position to get the current position of the GroupBy Dialog div as { top, left } object, relative to the page. */ igGridGroupBy(optionLiteral: 'option', optionName: "modalDialogMoving"): ModalDialogMovingEvent; /** * Event fired every time the GroupBy Dialog changes its position. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupBy widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.modalDialogElement to get a reference to the Column Chooser element. This is a jQuery object. - * Use ui.originalPosition to get the original position of the GroupBy Dialog div as { top, left } object, relative to the page. - * Use ui.position to get the current position of the GroupBy Dialog div as { top, left } object, relative to the page. * * @optionValue Define event handler function. */ @@ -40377,19 +46794,11 @@ interface JQuery { /** * Event fired before the modal dialog is closed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupBy widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. */ igGridGroupBy(optionLiteral: 'option', optionName: "modalDialogClosing"): ModalDialogClosingEvent; /** * Event fired before the modal dialog is closed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupBy widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. * * @optionValue Define event handler function. */ @@ -40397,19 +46806,11 @@ interface JQuery { /** * Event fired after the modal dialog has been closed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupBy widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. */ igGridGroupBy(optionLiteral: 'option', optionName: "modalDialogClosed"): ModalDialogClosedEvent; /** * Event fired after the modal dialog has been closed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupBy widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. * * @optionValue Define event handler function. */ @@ -40417,19 +46818,11 @@ interface JQuery { /** * Event fired before the modal dialog is opened. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupBy widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. */ igGridGroupBy(optionLiteral: 'option', optionName: "modalDialogOpening"): ModalDialogOpeningEvent; /** * Event fired before the modal dialog is opened. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupBy widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. * * @optionValue Define event handler function. */ @@ -40437,19 +46830,11 @@ interface JQuery { /** * Event fired after the modal dialog is already opened. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupBy widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. */ igGridGroupBy(optionLiteral: 'option', optionName: "modalDialogOpened"): ModalDialogOpenedEvent; /** * Event fired after the modal dialog is already opened. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupBy widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. * * @optionValue Define event handler function. */ @@ -40457,19 +46842,11 @@ interface JQuery { /** * Event fired before the contents of the modal dialog are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupby widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. */ igGridGroupBy(optionLiteral: 'option', optionName: "modalDialogContentsRendering"): ModalDialogContentsRenderingEvent; /** * Event fired before the contents of the modal dialog are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupby widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. * * @optionValue Define event handler function. */ @@ -40477,19 +46854,11 @@ interface JQuery { /** * Event fired after the contents of the modal dialog are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupBy widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. */ igGridGroupBy(optionLiteral: 'option', optionName: "modalDialogContentsRendered"): ModalDialogContentsRenderedEvent; /** * Event fired after the contents of the modal dialog are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupBy widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. * * @optionValue Define event handler function. */ @@ -40497,25 +46866,11 @@ interface JQuery { /** * Event fired when the button is Apply is clicked. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupby widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. - * Use ui.groupedColumns to get the array of grouped columns - * Use ui.groupedColumnLayouts to get array of column layouts - * Use ui.sortingExpr to get array of sorted columns */ igGridGroupBy(optionLiteral: 'option', optionName: "modalDialogButtonApplyClick"): ModalDialogButtonApplyClickEvent; /** * Event fired when the button is Apply is clicked. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupby widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. - * Use ui.groupedColumns to get the array of grouped columns - * Use ui.groupedColumnLayouts to get array of column layouts - * Use ui.sortingExpr to get array of sorted columns * * @optionValue Define event handler function. */ @@ -40523,19 +46878,11 @@ interface JQuery { /** * Event fired when reset button is clicked. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupby widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. */ igGridGroupBy(optionLiteral: 'option', optionName: "modalDialogButtonResetClick"): ModalDialogButtonResetClickEvent; /** * Event fired when reset button is clicked. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupby widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. * * @optionValue Define event handler function. */ @@ -40543,21 +46890,11 @@ interface JQuery { /** * Event fired when column in modal dialog is clicked to be grouped. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupby widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.key to get the key of the column to be grouped. - * Use ui.layout to get the layout of the columns */ igGridGroupBy(optionLiteral: 'option', optionName: "modalDialogGroupingColumn"): ModalDialogGroupingColumnEvent; /** * Event fired when column in modal dialog is clicked to be grouped. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupby widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.key to get the key of the column to be grouped. - * Use ui.layout to get the layout of the columns * * @optionValue Define event handler function. */ @@ -40565,23 +46902,11 @@ interface JQuery { /** * Event fired when column in modal dialog is clicked to be grouped. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupby widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.key to get the key of the column to be grouped. - * Use args.groupedColumns to get a reference to the current groupedColumns - * Use ui.layout to get the layout of the columns */ igGridGroupBy(optionLiteral: 'option', optionName: "modalDialogGroupColumn"): ModalDialogGroupColumnEvent; /** * Event fired when column in modal dialog is clicked to be grouped. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupby widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.key to get the key of the column to be grouped. - * Use args.groupedColumns to get a reference to the current groupedColumns - * Use ui.layout to get the layout of the columns * * @optionValue Define event handler function. */ @@ -40589,21 +46914,11 @@ interface JQuery { /** * Event fired when column in modal dialog is clicked to be ungrouped. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupby widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.key to get the key of the column to be grouped. - * Use ui.layout to get the layout of the columns */ igGridGroupBy(optionLiteral: 'option', optionName: "modalDialogUngroupingColumn"): ModalDialogUngroupingColumnEvent; /** * Event fired when column in modal dialog is clicked to be ungrouped. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupby widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.key to get the key of the column to be grouped. - * Use ui.layout to get the layout of the columns * * @optionValue Define event handler function. */ @@ -40611,23 +46926,11 @@ interface JQuery { /** * Event fired when column in modal dialog is clicked to be ungrouped. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupby widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use args.groupedColumns to get a reference to the current groupedColumns - * Use ui.key to get the key of the column to be grouped. - * Use ui.layout to get the layout of the columns */ igGridGroupBy(optionLiteral: 'option', optionName: "modalDialogUngroupColumn"): ModalDialogUngroupColumnEvent; /** * Event fired when column in modal dialog is clicked to be ungrouped. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupby widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use args.groupedColumns to get a reference to the current groupedColumns - * Use ui.key to get the key of the column to be grouped. - * Use ui.layout to get the layout of the columns * * @optionValue Define event handler function. */ @@ -40635,23 +46938,11 @@ interface JQuery { /** * Event fired when column in modal dialog is sorted. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupby widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.key to get the key of the column to be grouped. - * Use ui.layout to get the layout of the columns - * Use ui.isAsc to get whether column should be sorted ascending or descending */ igGridGroupBy(optionLiteral: 'option', optionName: "modalDialogSortGroupedColumn"): ModalDialogSortGroupedColumnEvent; /** * Event fired when column in modal dialog is sorted. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridGroupby widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.key to get the key of the column to be grouped. - * Use ui.layout to get the layout of the columns - * Use ui.isAsc to get whether column should be sorted ascending or descending * * @optionValue Define event handler function. */ @@ -40698,20 +46989,6 @@ interface ColumnHidingEvent { } interface ColumnHidingEventUIParam { - /** - * Used to get the reference to the GridHiding widget. - */ - owner?: any; - - /** - * Used to get the hidden column index. Has a value only if the column's key is a number. - */ - columnIndex?: any; - - /** - * Used to get the hidden column key. Has a value only if the column's key is a string. - */ - columnKey?: any; } interface ColumnHidingRefusedEvent { @@ -40719,11 +46996,6 @@ interface ColumnHidingRefusedEvent { } interface ColumnHidingRefusedEventUIParam { - /** - * Used to get the reference to the GridHiding widget. - */ - owner?: any; - columnKeys?: any; } interface ColumnShowingRefusedEvent { @@ -40731,11 +47003,6 @@ interface ColumnShowingRefusedEvent { } interface ColumnShowingRefusedEventUIParam { - /** - * Used to get the reference to the GridHiding widget. - */ - owner?: any; - columnKeys?: any; } interface MultiColumnHidingEvent { @@ -40743,15 +47010,6 @@ interface MultiColumnHidingEvent { } interface MultiColumnHidingEventUIParam { - /** - * Used to get the reference to the GridHiding widget. - */ - owner?: any; - - /** - * Used to get array of the hidden column keys. In case when click on Reset button in column chooser then this is an array of column keys. - */ - columnKeys?: any; } interface ColumnHiddenEvent { @@ -40759,20 +47017,6 @@ interface ColumnHiddenEvent { } interface ColumnHiddenEventUIParam { - /** - * Used to get the reference to the GridHiding widget. - */ - owner?: any; - - /** - * Used to get the hidden column index. Has a value only if the column's key is a number. - */ - columnIndex?: any; - - /** - * Used to get the hidden column key. Has a value only if the column's key is a string. - */ - columnKey?: any; } interface ColumnShowingEvent { @@ -40780,20 +47024,6 @@ interface ColumnShowingEvent { } interface ColumnShowingEventUIParam { - /** - * Used to get the reference to the GridHiding widget. - */ - owner?: any; - - /** - * Used to get the shown column index. - */ - columnIndex?: any; - - /** - * Used to get the shown column key. - */ - columnKey?: any; } interface ColumnShownEvent { @@ -40801,20 +47031,6 @@ interface ColumnShownEvent { } interface ColumnShownEventUIParam { - /** - * Used to get the reference to the GridHiding widget. - */ - owner?: any; - - /** - * Used to get the shown column index. - */ - columnIndex?: any; - - /** - * Used to get the shown column key. - */ - columnKey?: any; } interface ColumnChooserOpeningEvent { @@ -40822,15 +47038,6 @@ interface ColumnChooserOpeningEvent { } interface ColumnChooserOpeningEventUIParam { - /** - * Used to get the reference to the GridHiding widget. - */ - owner?: any; - - /** - * Used to get a reference to the Column Chooser element. This is a jQuery object. - */ - columnChooserElement?: any; } interface ColumnChooserOpenedEvent { @@ -40838,15 +47045,6 @@ interface ColumnChooserOpenedEvent { } interface ColumnChooserOpenedEventUIParam { - /** - * Used to get the reference to the GridHiding widget. - */ - owner?: any; - - /** - * Used to get a reference to the Column Chooser element. This is a jQuery object. - */ - columnChooserElement?: any; } interface ColumnChooserMovingEvent { @@ -40854,25 +47052,6 @@ interface ColumnChooserMovingEvent { } interface ColumnChooserMovingEventUIParam { - /** - * Used to get the reference to the GridHiding widget. - */ - owner?: any; - - /** - * Used to get a reference to the Column Chooser element. This is a jQuery object. - */ - columnChooserElement?: any; - - /** - * Used to get the original position of the column chooser div as { top, left } object, relative to the page. - */ - originalPosition?: any; - - /** - * Used to get the current position of the column chooser div as { top, left } object, relative to the page. - */ - position?: any; } interface ColumnChooserClosingEvent { @@ -40880,15 +47059,6 @@ interface ColumnChooserClosingEvent { } interface ColumnChooserClosingEventUIParam { - /** - * Used to get the reference to the GridHiding widget. - */ - owner?: any; - - /** - * Used to get a reference to the Column Chooser element. This is a jQuery object. - */ - columnChooserElement?: any; } interface ColumnChooserClosedEvent { @@ -40896,15 +47066,6 @@ interface ColumnChooserClosedEvent { } interface ColumnChooserClosedEventUIParam { - /** - * Used to get the reference to the GridHiding widget. - */ - owner?: any; - - /** - * Used to get a reference to the Column Chooser element. This is a jQuery object. - */ - columnChooserElement?: any; } interface ColumnChooserContentsRenderingEvent { @@ -40912,15 +47073,6 @@ interface ColumnChooserContentsRenderingEvent { } interface ColumnChooserContentsRenderingEventUIParam { - /** - * Used to get the reference to the GridHiding widget. - */ - owner?: any; - - /** - * Used to get a reference to the Column Chooser element. This is a jQuery object. - */ - columnChooserElement?: any; } interface ColumnChooserContentsRenderedEvent { @@ -40928,15 +47080,6 @@ interface ColumnChooserContentsRenderedEvent { } interface ColumnChooserContentsRenderedEventUIParam { - /** - * Used to get the reference to the GridHiding widget. - */ - owner?: any; - - /** - * Used to get a reference to the Column Chooser element. This is a jQuery object. - */ - columnChooserElement?: any; } interface ColumnChooserButtonApplyClickEvent { @@ -40944,25 +47087,6 @@ interface ColumnChooserButtonApplyClickEvent { } interface ColumnChooserButtonApplyClickEventUIParam { - /** - * Used to get the reference to the GridHiding widget. - */ - owner?: any; - - /** - * Used to get a reference to the Column Chooser element. This is a jQuery object. - */ - columnChooserElement?: any; - - /** - * Used to get array of columns identifiers which should be shown - */ - columnsToShow?: any; - - /** - * Used to get array of columns identifiers which should be hidden - */ - columnsToHide?: any; } interface ColumnChooserButtonResetClickEvent { @@ -40970,15 +47094,6 @@ interface ColumnChooserButtonResetClickEvent { } interface ColumnChooserButtonResetClickEventUIParam { - /** - * Used to get the reference to the GridHiding widget. - */ - owner?: any; - - /** - * Used to get a reference to the Column Chooser element. This is a jQuery object. - */ - columnChooserElement?: any; } interface IgGridHiding { @@ -41100,153 +47215,81 @@ interface IgGridHiding { /** * Event fired before a hiding operation is executed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the hidden column index. Has a value only if the column's key is a number. - * Use ui.columnKey to get the hidden column key. Has a value only if the column's key is a string. */ columnHiding?: ColumnHidingEvent; /** * Event fired when trying to hide all columns in fixed or unfixed area. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnKeys array of column keys. Has a value only if the column's key is a string. */ columnHidingRefused?: ColumnHidingRefusedEvent; /** * Event fired when trying to show column(s) in fixed area and total width of fixed are will be larger than whole grid width. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnKeys array of column keys. Has a value only if the column's key is a string. */ columnShowingRefused?: ColumnShowingRefusedEvent; /** * Event fired before a hiding operation is executed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnKeys to get array of the hidden column keys. In case when click on Reset button in column chooser then this is an array of column keys. */ multiColumnHiding?: MultiColumnHidingEvent; /** * Event fired after the hiding has been executed and results are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the hidden column index. Has a value only if the column's key is a number. - * Use ui.columnKey to get the hidden column key. Has a value only if the column's key is a string. */ columnHidden?: ColumnHiddenEvent; /** * Event fired before a showing operation is executed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the shown column index. - * Use ui.columnKey to get the shown column key. */ columnShowing?: ColumnShowingEvent; /** * Event fired after the showing has been executed and results are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the shown column index. - * Use ui.columnKey to get the shown column key. */ columnShown?: ColumnShownEvent; /** * Event fired before the column chooser is opened. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. */ columnChooserOpening?: ColumnChooserOpeningEvent; /** * Event fired after the column chooser is already opened. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. */ columnChooserOpened?: ColumnChooserOpenedEvent; /** * Event fired every time the column chooser changes its position. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. - * Use ui.originalPosition to get the original position of the column chooser div as { top, left } object, relative to the page. - * Use ui.position to get the current position of the column chooser div as { top, left } object, relative to the page. */ columnChooserMoving?: ColumnChooserMovingEvent; /** * Event fired before the column chooser is closed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. */ columnChooserClosing?: ColumnChooserClosingEvent; /** * Event fired after the column chooser has been closed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. */ columnChooserClosed?: ColumnChooserClosedEvent; /** * Event fired before the contents of the column chooser are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. */ columnChooserContentsRendering?: ColumnChooserContentsRenderingEvent; /** * Event fired after the contents of the column chooser are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. */ columnChooserContentsRendered?: ColumnChooserContentsRenderedEvent; /** * Event fired when button Apply in column chooser is clicked - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. - * Use ui.columnsToShow to get array of columns identifiers which should be shown - * Use ui.columnsToHide to get array of columns identifiers which should be hidden */ columnChooserButtonApplyClick?: ColumnChooserButtonApplyClickEvent; /** * Event fired when button Reset in column chooser is clicked - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. */ columnChooserButtonResetClick?: ColumnChooserButtonResetClickEvent; @@ -41618,21 +47661,11 @@ interface JQuery { /** * Event fired before a hiding operation is executed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the hidden column index. Has a value only if the column's key is a number. - * Use ui.columnKey to get the hidden column key. Has a value only if the column's key is a string. */ igGridHiding(optionLiteral: 'option', optionName: "columnHiding"): ColumnHidingEvent; /** * Event fired before a hiding operation is executed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the hidden column index. Has a value only if the column's key is a number. - * Use ui.columnKey to get the hidden column key. Has a value only if the column's key is a string. * * @optionValue Define event handler function. */ @@ -41640,19 +47673,11 @@ interface JQuery { /** * Event fired when trying to hide all columns in fixed or unfixed area. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnKeys array of column keys. Has a value only if the column's key is a string. */ igGridHiding(optionLiteral: 'option', optionName: "columnHidingRefused"): ColumnHidingRefusedEvent; /** * Event fired when trying to hide all columns in fixed or unfixed area. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnKeys array of column keys. Has a value only if the column's key is a string. * * @optionValue Define event handler function. */ @@ -41660,19 +47685,11 @@ interface JQuery { /** * Event fired when trying to show column(s) in fixed area and total width of fixed are will be larger than whole grid width. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnKeys array of column keys. Has a value only if the column's key is a string. */ igGridHiding(optionLiteral: 'option', optionName: "columnShowingRefused"): ColumnShowingRefusedEvent; /** * Event fired when trying to show column(s) in fixed area and total width of fixed are will be larger than whole grid width. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnKeys array of column keys. Has a value only if the column's key is a string. * * @optionValue Define event handler function. */ @@ -41680,19 +47697,11 @@ interface JQuery { /** * Event fired before a hiding operation is executed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnKeys to get array of the hidden column keys. In case when click on Reset button in column chooser then this is an array of column keys. */ igGridHiding(optionLiteral: 'option', optionName: "multiColumnHiding"): MultiColumnHidingEvent; /** * Event fired before a hiding operation is executed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnKeys to get array of the hidden column keys. In case when click on Reset button in column chooser then this is an array of column keys. * * @optionValue Define event handler function. */ @@ -41700,21 +47709,11 @@ interface JQuery { /** * Event fired after the hiding has been executed and results are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the hidden column index. Has a value only if the column's key is a number. - * Use ui.columnKey to get the hidden column key. Has a value only if the column's key is a string. */ igGridHiding(optionLiteral: 'option', optionName: "columnHidden"): ColumnHiddenEvent; /** * Event fired after the hiding has been executed and results are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the hidden column index. Has a value only if the column's key is a number. - * Use ui.columnKey to get the hidden column key. Has a value only if the column's key is a string. * * @optionValue Define event handler function. */ @@ -41722,21 +47721,11 @@ interface JQuery { /** * Event fired before a showing operation is executed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the shown column index. - * Use ui.columnKey to get the shown column key. */ igGridHiding(optionLiteral: 'option', optionName: "columnShowing"): ColumnShowingEvent; /** * Event fired before a showing operation is executed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the shown column index. - * Use ui.columnKey to get the shown column key. * * @optionValue Define event handler function. */ @@ -41744,21 +47733,11 @@ interface JQuery { /** * Event fired after the showing has been executed and results are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the shown column index. - * Use ui.columnKey to get the shown column key. */ igGridHiding(optionLiteral: 'option', optionName: "columnShown"): ColumnShownEvent; /** * Event fired after the showing has been executed and results are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the shown column index. - * Use ui.columnKey to get the shown column key. * * @optionValue Define event handler function. */ @@ -41766,19 +47745,11 @@ interface JQuery { /** * Event fired before the column chooser is opened. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. */ igGridHiding(optionLiteral: 'option', optionName: "columnChooserOpening"): ColumnChooserOpeningEvent; /** * Event fired before the column chooser is opened. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. * * @optionValue Define event handler function. */ @@ -41786,19 +47757,11 @@ interface JQuery { /** * Event fired after the column chooser is already opened. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. */ igGridHiding(optionLiteral: 'option', optionName: "columnChooserOpened"): ColumnChooserOpenedEvent; /** * Event fired after the column chooser is already opened. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. * * @optionValue Define event handler function. */ @@ -41806,23 +47769,11 @@ interface JQuery { /** * Event fired every time the column chooser changes its position. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. - * Use ui.originalPosition to get the original position of the column chooser div as { top, left } object, relative to the page. - * Use ui.position to get the current position of the column chooser div as { top, left } object, relative to the page. */ igGridHiding(optionLiteral: 'option', optionName: "columnChooserMoving"): ColumnChooserMovingEvent; /** * Event fired every time the column chooser changes its position. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. - * Use ui.originalPosition to get the original position of the column chooser div as { top, left } object, relative to the page. - * Use ui.position to get the current position of the column chooser div as { top, left } object, relative to the page. * * @optionValue Define event handler function. */ @@ -41830,19 +47781,11 @@ interface JQuery { /** * Event fired before the column chooser is closed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. */ igGridHiding(optionLiteral: 'option', optionName: "columnChooserClosing"): ColumnChooserClosingEvent; /** * Event fired before the column chooser is closed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. * * @optionValue Define event handler function. */ @@ -41850,19 +47793,11 @@ interface JQuery { /** * Event fired after the column chooser has been closed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. */ igGridHiding(optionLiteral: 'option', optionName: "columnChooserClosed"): ColumnChooserClosedEvent; /** * Event fired after the column chooser has been closed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. * * @optionValue Define event handler function. */ @@ -41870,19 +47805,11 @@ interface JQuery { /** * Event fired before the contents of the column chooser are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. */ igGridHiding(optionLiteral: 'option', optionName: "columnChooserContentsRendering"): ColumnChooserContentsRenderingEvent; /** * Event fired before the contents of the column chooser are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. * * @optionValue Define event handler function. */ @@ -41890,19 +47817,11 @@ interface JQuery { /** * Event fired after the contents of the column chooser are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. */ igGridHiding(optionLiteral: 'option', optionName: "columnChooserContentsRendered"): ColumnChooserContentsRenderedEvent; /** * Event fired after the contents of the column chooser are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. * * @optionValue Define event handler function. */ @@ -41910,23 +47829,11 @@ interface JQuery { /** * Event fired when button Apply in column chooser is clicked - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. - * Use ui.columnsToShow to get array of columns identifiers which should be shown - * Use ui.columnsToHide to get array of columns identifiers which should be hidden */ igGridHiding(optionLiteral: 'option', optionName: "columnChooserButtonApplyClick"): ColumnChooserButtonApplyClickEvent; /** * Event fired when button Apply in column chooser is clicked - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. - * Use ui.columnsToShow to get array of columns identifiers which should be shown - * Use ui.columnsToHide to get array of columns identifiers which should be hidden * * @optionValue Define event handler function. */ @@ -41934,19 +47841,11 @@ interface JQuery { /** * Event fired when button Reset in column chooser is clicked - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. */ igGridHiding(optionLiteral: 'option', optionName: "columnChooserButtonResetClick"): ColumnChooserButtonResetClickEvent; /** * Event fired when button Reset in column chooser is clicked - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. * * @optionValue Define event handler function. */ @@ -41979,20 +47878,390 @@ interface IgHierarchicalGridColumnLayout { [optionName: string]: any; } +interface IgHierarchicalGridColumnGroupOptions { + /** + * Sets whether the group is expanded or collapsed. Applied only if the allowGroupCollapsing is set to true. + * + */ + expanded?: boolean; + + /** + * Sets whether expansion indicators are visible in the group header. + * + */ + allowGroupCollapsing?: boolean; + + /** + * Sets when should the group be hidden. Applied only if the allowGroupCollapsing is set to true. + * + * + * Valid values: + * "never" never hide the group + * "always" always hide the group + * "parentcollapsed" hide the group when its parent group is collapsed + * "parentexpanded" hide the group when its parent group is expanded + */ + hidden?: string; + + /** + * Option for IgHierarchicalGridColumnGroupOptions + */ + [optionName: string]: any; +} + +interface IgHierarchicalGridColumn { + /** + * Header text for the specified column. + * + */ + headerText?: string; + + /** + * The property in the data source to which the column is bound. Also used to identify the column by, and find specific columns with API methods such as [columnByKey](ui.ighierarchicalgrid#methods:columnByKey). + * + */ + key?: string; + + /** + * Reference to a function (string or function) which will be used for formatting the cell values. The function should accept a value and return the new formatted value. [Here column formatting is explained in details](http://www.igniteui.com/help/iggrid-columns-and-layout#column-formatting) + * + * + * Valid values: + * "string" The name of the function which will be used for formatting the cell values. + * "function" Function which will be used for formatting the cell values. The function should accept a value and return the new formatted value. + */ + formatter?: string|Function; + + /** + * Gets/Sets the type of formatting for cells of the column. Default value is null. Checkout [Formatting Dates, Numbers and Strings](http://www.igniteui.com/help/formatting-dates-numbers-and-strings) for details on the valid formatting specifiers. + * + * If dataType is "date", then supported formats are following: "date", "dateLong", "dateTime", "time", "timeLong", "MM/dd/yyyy", "MMM-d, yy, h:mm:ss tt", "dddd d MMM", etc. + * If dataType is "number", then supported numeric formats are following: "number", "currency", "percent", "int", "double", "0.00", "#.0####", "0", "#.#######", etc. + * The value of "double" will be similar to "number", but with unlimited maximum number of decimal places. + * The format patterns and rules for numbers and dates are defined in $.ig.regional.defaults object. + * If dataType is "string" or not set, then format is rendered as it is with replacement of possible "{0}" flag by value in cell. Example, if format is set to "Name: {0}" and value in cell is "Bob", then value will appear as "Name: Bob" + * If value is set to "checkbox", then checkboxes are used regardless of renderCheckboxes option of the grid. That has effect only when dataType option of column is set to "bool". + */ + format?: string; + + /** + * Data type of the column cell values: string, number, bool, date, object. + * + */ + dataType?: string|number|boolean|Date|Object; + + /** + * 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 + */ + width?: string|number; + + /** + * Initial visibility of the column. A column can be hidden without the Hiding feature being enabled but there will be no UI for unhiding it. Columns can be defined as hidden in the options of the Hiding feature as well and those definitions take precedence. + * + */ + hidden?: boolean; + + /** + * Sets a template for an individual column. the contents of the template should be the HTML markup that goes inside the table cell, or the entire table cell markup. [Here's an example of creating a basic column template](http://www.igniteui.com/help/creating-a-basic-column-template-in-the-iggrid) + * + */ + template?: string; + + /** + * Sets whether column data is derived from the datasource. If set to true, then the cells in this column are not bound to the data source. The data in this column is populated using [formula](ui.ighierarchicalgrid#options:columns.formula), or using [unboundValues](ui.ighierarchicalgrid#options:columns.unboundValues), or through the [setUnboundValues](ui.ighierarchicalgrid#methods:setUnboundValues) API method. [Here's an overview of the unbound columns feature](http://www.igniteui.com/help/iggrid-unboundcolumns-overview) + * + */ + unbound?: boolean; + + /** + * Options used to configure collapsible column [groups](ui.ighierarchicalgrid#options:columns.group). + * + */ + groupOptions?: IgHierarchicalGridColumnGroupOptions; + + /** + * Array of child column definitions. If the column has the property group than the grid has multi column headers. + * + */ + group?: any[]; + + /** + * Determines the way in which dates will be displayed in the grid for this column. + * + * + * Valid values: + * "local" The dates for this column will be rendered in the client's local timezone. + * "utc" The dates for this column will be rendered in their UTC representation. + */ + dateDisplayType?: string; + + /** + * This option has been deprecated as of the June 2016 service release. + * Adjust span of multi column header cell. Use option rowSpan. + */ + rowspan?: number; + + /** + * A reference to or the name of a JavaScript function, which will calculate the value of the current cell based on other cell values in the same row. Used with [unbound columns](ui.ighierarchicalgrid#options:columns.unbound). + * + * + * Valid values: + * "string" The name of the JavaScript function. + * "function" Reference to the JavaScript function. + */ + formula?: string|Function; + + /** + * Array of values which will be populated in the column cells at initialization, if the column is [unbound](ui.ighierarchicalgrid#options:columns.unbound). + * + */ + unboundValues?: any[]; + + /** + * Space-separated list of CSS classes to be applied on the header cell of this column. + * + */ + headerCssClass?: string; + + /** + * Space-separated list of CSS classes to be applied on the data cells of this column. The class is not applied if the column has a column [template](ui.ighierarchicalgrid#options:columns.template) defined, which contains full definition in the template. + * + */ + columnCssClass?: string; + + /** + * This option is applicable only for columns with [dataType](ui.ighierarchicalgrid#options:columns.dataType) of object. Reference to a function, or the name of the function, that will be used for complex data extraction from the data records, whose return value will be used for all data operations associated with this column and will be displayed as cell value. [Here you can find more examples of how to setup a column mapper](http://www.igniteui.com/help/iggrid-columns-and-layout#defining-mapper) + * + * + * Valid values: + * "string" The name of the mapper function. + * "function" Reference to the mapper function. + */ + mapper?: string|Function; + + /** + * Specifies the row index of the cell in a Multi-Row Layout configuration. All columns must have this property set for the multi-row-layout mode to be enabled. [Here you can find more about the Multi-Row Layout feature](http://www.igniteui.com/help/iggrid-multirowlayout) + * + */ + rowIndex?: number; + + /** + * Specifies the column index of the cell in a Multi-Row Layout configuration. All columns must have this property set for the multi-row-layout mode to be enabled. [Here you can find more about the Multi-Row Layout feature](http://www.igniteui.com/help/iggrid-multirowlayout) + * + */ + columnIndex?: number; + + /** + * Specifies the navigation index of the cell for the TAB sequence when the cells are in edit mode in a Multi-Row Layout grid. Has no effect otherwise. [Here you can find more about the Multi-Row Layout feature](http://www.igniteui.com/help/iggrid-multirowlayout) + * + */ + navigationIndex?: number; + + /** + * Specifies the colSpan of the cell in a Multi-Row Layout configuration. colSpan 0 is not supported and will be changed to 1 by the grid. [Here you can find more about the Multi-Row Layout feature](http://www.igniteui.com/help/iggrid-multirowlayout) + * + */ + colSpan?: number; + + /** + * Specifies the rowSpan of the cell in a Multi-Row Layout configuration. rowSpan 0 is not supported and will be changed to 1 by the grid. [Here you can find more about the Multi-Row Layout feature](http://www.igniteui.com/help/iggrid-multirowlayout). If multi-row-layout is not used but multi-column-header is set then this option is used to adjust span of header cell. + * + */ + rowSpan?: number; + + /** + * Option for IgHierarchicalGridColumn + */ + [optionName: string]: any; +} + +interface IgHierarchicalGridFeature { + /** + * Name of the feature to be enabled. + */ + name?: string; + + /** + * Option for IgHierarchicalGridFeature + */ + [optionName: string]: any; +} + +interface IgHierarchicalGridRestSettingsCreate { + /** + * Specifies a remote URL to which create requests will be sent. This will be used for both batch and non-batch, however if template is also set, this URL will only be used for batch requests. + * + */ + url?: string; + + /** + * Specifies a remote URL template. Use ${id} in place of the resource id. + * + */ + template?: string; + + /** + * Specifies whether create requests will be sent in batches + * + */ + batch?: boolean; + + /** + * Option for IgHierarchicalGridRestSettingsCreate + */ + [optionName: string]: any; +} + +interface IgHierarchicalGridRestSettingsUpdate { + /** + * Specifies a remote URL to which update requests will be sent. This will be used for both batch and non-batch, however if template is also set, this URL will only be used for batch requests. + */ + url?: string; + + /** + * Specifies a remote URL template. Use ${id} in place of the resource id. + */ + template?: string; + + /** + * Specifies whether update requests will be sent in batches + */ + batch?: boolean; + + /** + * Option for IgHierarchicalGridRestSettingsUpdate + */ + [optionName: string]: any; +} + +interface IgHierarchicalGridRestSettingsRemove { + /** + * Specifies a remote URL to which remove requests will be sent. This will be used for both batch and non-batch, however if template is also set, this URL will only be used for batch requests. + */ + url?: string; + + /** + * Specifies a remote URL template. Use ${id} in place of the resource id. + */ + template?: string; + + /** + * Specifies whether update requests will be sent in batches + */ + batch?: boolean; + + /** + * Option for IgHierarchicalGridRestSettingsRemove + */ + [optionName: string]: any; +} + +interface IgHierarchicalGridRestSettings { + /** + * Settings for create requests + * + */ + create?: IgHierarchicalGridRestSettingsCreate; + + /** + * Settings for update requests + */ + update?: IgHierarchicalGridRestSettingsUpdate; + + /** + * Settings for remove requests + */ + remove?: IgHierarchicalGridRestSettingsRemove; + + /** + * Specifies whether the ids of the removed resources are send through the request URI + */ + encodeRemoveInRequestUri?: boolean; + + /** + * Specifies a custom function to serialize content sent to the server. It should accept a single object or an array of objects and return a string. If not specified, JSON.stringify() will be used. + * + */ + contentSerializer?: Function; + + /** + * Specifies the content type of the request. See http://api.jquery.com/jQuery.ajax/ => contentType + * + */ + contentType?: string; + + /** + * Option for IgHierarchicalGridRestSettings + */ + [optionName: string]: any; +} + +interface IgHierarchicalGridScrollSettings { + /** + * Sets gets current vertical position. + * + */ + scrollTop?: number; + + /** + * Sets gets current horizontal position. + * + */ + scrollLeft?: number; + + /** + * Sets gets the step of the default scrolling behavior when using the mouse wheel. + * + */ + wheelStep?: number; + + /** + * Sets gets if smoother scrolling with small intertia should be used when using the mouse wheel. + * + */ + smoothing?: boolean; + + /** + * Sets or gets the modifier for how many pixels will be scrolled when using the mouse wheel once. This is used only for the [smooth scrolling behavior](ui.ighierarchicalgrid#options:scrollSettings.smoothing). + * + */ + smoothingStep?: number; + + /** + * Sets or gets the modifier for how long the scroll ‘animation’ lasts when using the mouse wheel once. This is used only for the [smooth scrolling behavior](ui.ighierarchicalgrid#options:scrollSettings.smoothing). + * + */ + smoothingDuration?: number; + + /** + * Sets gets the modifier for how much the inertia scrolls on touch devices. Note: Value set to 0 would disable touch movements. Value set to -1 would invert them. + * + */ + inertiaStep?: number; + + /** + * Sets gets the modifier for how long the inertia last on touch devices. + * + */ + inertiaDuration?: number; + + /** + * Option for IgHierarchicalGridScrollSettings + */ + [optionName: string]: any; +} + interface RowExpandingEvent { (event: Event, ui: RowExpandingEventUIParam): void; } interface RowExpandingEventUIParam { - /** - * Used to access the hierarchical grid object - */ - owner?: any; - - /** - * Used to access the row element for the row that's about to be expanded - */ - parentrow?: any; } interface RowExpandedEvent { @@ -42000,15 +48269,6 @@ interface RowExpandedEvent { } interface RowExpandedEventUIParam { - /** - * Used to access the hierarchical grid object - */ - owner?: any; - - /** - * Used to access the row element for the row that was expanded - */ - parentrow?: any; } interface RowCollapsingEvent { @@ -42016,15 +48276,6 @@ interface RowCollapsingEvent { } interface RowCollapsingEventUIParam { - /** - * Used to access the hierarchical grid object - */ - owner?: any; - - /** - * Used to access the row element for the row that's about to be collapsed - */ - parentrow?: any; } interface RowCollapsedEvent { @@ -42032,15 +48283,6 @@ interface RowCollapsedEvent { } interface RowCollapsedEventUIParam { - /** - * Used to access the hierarchical grid object - */ - owner?: any; - - /** - * Used to access the row element for the row that was collapsd - */ - parentrow?: any; } interface ChildrenPopulatingEvent { @@ -42048,20 +48290,6 @@ interface ChildrenPopulatingEvent { } interface ChildrenPopulatingEventUIParam { - /** - * Used to access the hierarchical grid object - */ - owner?: any; - - /** - * Used to access the row element for the row that's about to be populated - */ - parentrow?: any; - - /** - * Used to get the data ID of the row - */ - id?: any; } interface ChildrenPopulatedEvent { @@ -42069,20 +48297,6 @@ interface ChildrenPopulatedEvent { } interface ChildrenPopulatedEventUIParam { - /** - * Used to access the hierarchical grid object - */ - owner?: any; - - /** - * Used to access the row element for the row that was populated - */ - parentrow?: any; - - /** - * Used to get the data ID of the row - */ - id?: any; } interface ChildGridRenderedEvent { @@ -42090,20 +48304,6 @@ interface ChildGridRenderedEvent { } interface ChildGridRenderedEventUIParam { - /** - * Used to access the hierarchical grid object - */ - owner?: any; - - /** - * Used to access the row element for the row that's about to be populated - */ - parentrow?: any; - - /** - * Used to get reference to the child grid - */ - childgrid?: any; } interface ChildGridCreatingEvent { @@ -42123,130 +48323,453 @@ interface ChildGridCreatedEventUIParam { interface IgHierarchicalGrid { /** * Only the first level will be data-bound initially. Also serves as "render" depth, meaning that depending on this prop, the grid will + * */ initialDataBindDepth?: number; /** * No levels will be automatically expanded when the widget is instantiated for the first time + * */ initialExpandDepth?: number; /** * If true, encodes all requests using OData conventions and the $expand syntax + * */ odata?: boolean; /** * If true, load on demand will be achieved using REST compliant resource access with appropriate url-s for * the ajax GET calls. + * */ rest?: boolean; /** * Specifies the limit on the number of levels to bind to + * */ maxDataBindDepth?: number; /** * Specifies the default property in the response where children will be located + * */ defaultChildrenDataProperty?: string; /** * If true, will autogenerate all layouts assuming default values for "childrenDataProperty" * When autoGenerateLayouts is enabled, it will automatically generate all columns recursively. (all columns on all levels) + * */ autoGenerateLayouts?: boolean; /** * Applies a linear animation - either expanding or collapsing depending on the parent row state + * */ expandCollapseAnimations?: boolean; /** * Specifies the expand column width + * */ expandColWidth?: number; /** * Specifies the delimiter for constructing paths , for hierarchical lookup of data + * */ pathSeparator?: string; /** * The row expanding/collapsing animation duration in ms. + * */ animationDuration?: number; /** * Specifies the default tooltip applied to an expand column cell, that is currently collapsed + * */ expandTooltip?: string; /** * Specifies the default tooltip applied to an expand column cell, that is currently expanded + * */ collapseTooltip?: string; - /** - * An array of column objects - */ - columns?: any[]; - /** * List of columnLayout objects that specify the structure of the child grids. All options that are applicable to a flat grid are also applicable here + * */ columnLayouts?: IgHierarchicalGridColumnLayout[]; + /** + * 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). + * + * + * Valid values: + * "string" The widget width can be set in pixels (px) or percentage (%). Example values: "800px", "800" (defaults to pixels), "100%". + * "number" The widget width can be set in pixels as a number. Example values: 800, 700. + * "null" will stretch to fit the sum of the columns widths. + */ + width?: string|number; + + /** + * 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). + * + * + * Valid values: + * "string" The widget height can be set in pixels (px) and percentage (%). + * "number" The widget height can be set as a number + * "null" will stretch vertically to fit data. + */ + height?: string|number; + + /** + * If autoAdjustHeight is set to false, the [height](ui.ighierarchicalgrid#options:height) will be set only on the scrolling container, and all other UI elements such as paging footer / filter row / headers will add on top of that, so the total height of the grid will be more than this value - the height of the scroll container (content area) will not be dynamically calculated. Setting this option to false will usually result in a lot better initial rendering performance for large data sets ( > 1000 rows rendered at once, no [virtualization](ui.ighierarchicalgrid#options:virtualization) enabled), since no reflows will be made by browsers when accessing DOM properties such as offsetHeight. + * + */ + autoAdjustHeight?: boolean; + + /** + * 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. + * + * + * Valid values: + * "string" The avarage row height can be set in pixels ("25px"). + * "number" The avarage row height can be set in pixels as a number (25). + */ + avgRowHeight?: string|number; + + /** + * 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. + * + * + * Valid values: + * "string" The avarage column width can be set in pixels ("25px"). + * "number" The avarage column width can be set in pixels as a number (25). + */ + avgColumnWidth?: string|number; + + /** + * Default column width that will be set for all columns, that don't have [column width](ui.ighierarchicalgrid#options:columns.width) defined. + * + * + * Valid values: + * "string" The default column width can be set in pixels ("100px"). + * "number" The default column width can be set in pixels as a number (100). + */ + defaultColumnWidth?: string|number; + + /** + * If no [columns](ui.ighierarchicalgrid#options:columns) collection is defined, and autoGenerateColumns is set to true, [columns](ui.ighierarchicalgrid#options:columns) will be inferred from the data source before the [dataRendering](ui.iggrid#events:dataRendering) event is fired. The inferred [columns](ui.ighierarchicalgrid#options:columns) collection will be available to the developer for modification at [dataRendering](ui.iggrid#events:dataRendering). If autoGenerateColumns is not explicitly set and [columns](ui.ighierarchicalgrid#options:columns) has at least one column defined then autoGenerateColumns is automatically set to false. + * If autoGenerateColumns is true and there are columns defined auto-generated columns will render after the explicitly defined ones. + * Since auto-generated columns don't have width defined consider setting [defaultColumnWidth](ui.ighierarchicalgrid#options:defaultColumnWidth) as well. + * + */ + autoGenerateColumns?: boolean; + + /** + * Enables/disables column and row virtualization at the same time. Virtualization can greatly enhance rendering performance. If enabled, the number of actual rendered rows (DOM elements) will be constant and related to the visible viewport of the grid. As the end user scrolls, those DOM elements will be dynamically reused to render the new data. [Here you can find more info about the performance guidelines when using the igGrid](http://www.igniteui.com/help/iggrid-performance-guide) + * + */ + virtualization?: boolean; + + /** + * Determines row virtualization mode. + * + * + * Valid values: + * "fixed" Renders only the visible rows and/or columns in the grid. On scrolling the same rows and/or columns are updated with new data from the data source. Only fixed virtualization can work with column virtualization at the same time. Fixed virtualization is not supported by some grid features: Resizing, Group By, Responsive. + * "continuous" renders a pre-defined number of rows in the grid. On scrolling the continuous virtualization loads another portion of rows and disposes the current one. + */ + virtualizationMode?: string; + + /** + * Enables virtualization for rows only. [Here you can find more info about igGrid row virtualization](http://www.igniteui.com/help/iggrid-virtualization-overview) + * + */ + rowVirtualization?: boolean; + + /** + * Enables virtualization for columns only. Column virtualization can work only in combination with fixed row virtalization. Setting columnVirtualization to true will automatically set [virtualization](ui.ighierarchicalgrid#options:virtualization) to true and [virtualizationMode](ui.ighierarchicalgrid#options:virtualizationMode) to "fixed". + * + */ + columnVirtualization?: boolean; + + /** + * Number of pixels to scroll the grid by, when virtualization is enabled, and mouse wheel scrolling is performed over the virtual grid area. If "null" the step will be equal to the [avgRowHeight](ui.ighierarchicalgrid#options:avgRowHeight). + * + */ + virtualizationMouseWheelStep?: number; + + /** + * If this option is set to true, the height of the grid row will be calculated automatically based on the [avgRowHeight](ui.ighierarchicalgrid#options:avgRowHeight) and the visible virtual records. If no [avgRowHeight](ui.ighierarchicalgrid#options:avgRowHeight) is specified, it will be calculated automatically at runtime. + * + */ + adjustVirtualHeights?: boolean; + + /** + * 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. + * + * + * Valid values: + * "infragistics" The grid will use the Infragistics Templating engine to render its [column templates](ui.ighierarchicalgrid#options:columns.template) and specific parts of the UI. + * "jsRender" The grid will use jsRender to render its [column templates](ui.ighierarchicalgrid#options:columns.template) and specific parts of the UI. + */ + templatingEngine?: string; + + /** + * An array of column objects. Checkout the [Columns and Layout](http://www.igniteui.com/help/iggrid-columns-and-layout#defining-columns) topic for details on configuring the columns array. + * + */ + columns?: IgHierarchicalGridColumn[]; + + /** + * Can be any valid data source accepted by [$.ig.DataSource](ig.datasource), or an instance of an $.ig.DataSource itself + * + */ + dataSource?: any; + + /** + * Specifies a remote URL as a data source, from which data will be retrieved using the [$.ig.DataSource](ig.datasource). + * + */ + dataSourceUrl?: string; + + /** + * Explicitly set data source type (such as "json"). Please refer to the documentation of [$.ig.DataSource type](ig.datasource#options:settings.type). + * + */ + dataSourceType?: string; + + /** + * See [$.ig.DataSource responseDataKey](ig.datasource#options:settings.responseDataKey). This is the property in the responses where data records are held, if the response is wrapped. + * + */ + responseDataKey?: string; + + /** + * See [$.ig.DataSource responseTotalRecCountKey](ig.datasource#options:settings.responseTotalRecCountKey). Property in the response specifying the total number of records on the server. + * + */ + responseTotalRecCountKey?: string; + + /** + * Specifies the HTTP verb to be used to issue the requests to a remote data source. + * + */ + requestType?: string; + + /** + * Content type of the response. See http://api.jquery.com/jQuery.ajax/ => contentType + * + */ + responseContentType?: string; + + /** + * Controls the visibility of the grid header. + * + */ + showHeader?: boolean; + + /** + * Controls the visibility of the grid footer. + * + */ + showFooter?: boolean; + + /** + * Headers will be fixed if this option is set to true, and only the grid data will be scrollable. If [virtualization](ui.ighierarchicalgrid#options:virtualization) is enabled, fixedHeaders will always act as if it's true, no matter which value is set. + * + */ + fixedHeaders?: boolean; + + /** + * Footers will be fixed if this option is set to true, and only the grid data will be scrollable. If [virtualization](ui.ighierarchicalgrid#options:virtualization) is enabled, fixedFooters will always act as if it's true, no matter which value is set. + * + */ + fixedFooters?: boolean; + + /** + * Caption text that will be shown above the grid header. + * + */ + caption?: string; + + /** + * List of grid feature definitions: sorting, paging, etc. Each feature goes with its separate options that are documented for the feature accordingly. [Here you can find detailed documentation for all igGrid features](http://www.igniteui.com/help/iggrid-features-landing-page) + * + */ + features?: IgHierarchicalGridFeature[]; + + /** + * Initial tabIndex attribute that will be set on all focusable elements. + * + */ + tabIndex?: number; + + /** + * If this option is set to false, the data to which the grid is bound will be used "as is" with no additional transformations based on [columns](ui.ighierarchicalgrid#options:columns) defined. Otherwise only the subset of data properties used in the [columns](ui.ighierarchicalgrid#options:columns) defined will be extracted in a new object and used. + * + */ + localSchemaTransform?: boolean; + + /** + * Key of the column containing unique identifiers for the data records. + * + */ + primaryKey?: string; + + /** + * If true, the transaction log will always be sent in the request for remote data, by the data source. Also this means that if there are values in the log, a POST will be performed instead of GET. + * + */ + serializeTransactionLog?: boolean; + + /** + * Automatically commits the transactions as rows/cells are being edited to the client data source. A [saveChanges](ui.ighierarchicalgrid#methods:saveChanges) call still needs to be performed in order to commit the transactions to a server-side data source. + * + */ + autoCommit?: boolean; + + /** + * If set to true, the following behavior will take place: + * If a new row is added, and then deleted, there will be no transaction added to the log. + * If a new row is added, edited, then deleted, there will be no transaction added to the log. + * If several edits are made to a row or an individual cell, this should result in a single transaction. + * Note: This option takes effect only when [autoCommit](ui.ighierarchicalgrid#options:autoCommit) is set to false. + * + */ + aggregateTransactions?: boolean; + + /** + * 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) + * + * + * Valid values: + * "date" formats only Date columns + * "number" formats only number columns + * "dateandnumber" formats both Date and number columns + * "true" formats Date and number columns + * "false" auto formatting is disabled + */ + autoFormat?: string|boolean; + + /** + * Gets sets ability to render checkboxes and use checkbox editor when dataType of a column is "bool". Checkboxes are not rendered for boolean values in columns with a [column template](ui.ighierarchicalgrid#options:columns.template). + * + */ + renderCheckboxes?: boolean; + + /** + * URL to which updating requests will be made. + * + */ + updateUrl?: string; + + /** + * Settings related to REST compliant update routines. + * + */ + restSettings?: IgHierarchicalGridRestSettings; + + /** + * Enables/disables rendering of alternating row styles (odd and even rows receive different styling). + * + */ + alternateRowStyles?: boolean; + + /** + * If set to true and all columns' widths are specified and their combined width is less than the grid width then the last column width will be automatically adjusted to fill the remaining empty space of the grid. + * + */ + autofitLastColumn?: boolean; + + /** + * Enables/disables rendering of hover styles when the mouse is over a record. This can be useful in templating scenarios, for example, where we don't want to apply hover styling to templated content. + * + */ + enableHoverStyles?: boolean; + + /** + * Nables/Disables serializing client date as UTC ISO 8061 string instead of using the local time and zone values. + * + */ + enableUTCDates?: boolean; + + /** + * Merge unbound columns values inside data source when data source is remote. If true then the unbound columns are merged to the data source at runtime on the server. Note that data source is expanded with the new data and this could cause performance issues when the data is huge. If mergeUnboundColumns is false then the unbound data is sent and merged on the client. This option is used by the [igGrid MVC Helper](http://www.igniteui.com/help/iggrid-developing-asp-net-mvc-applications-with-iggrid). + * Checkout [Populating Unbound Columns Remotely (igGrid)](http://www.igniteui.com/help/iggrid-unboundcolumns-populating-with-data-remotely) topic for more information. + * + */ + mergeUnboundColumns?: boolean; + + /** + * When dataSource is a remote URL, defines whether to set the type of the remote data source to JSONP. + * + */ + jsonpRequest?: boolean; + + /** + * Enables/disables grid adjusting its dimensions when its [width](ui.ighierarchicalgrid#options:width) and/or [height](ui.ighierarchicalgrid#options:height) is set in percent (%) and grid parent DOM container is resized. + * + */ + enableResizeContainerCheck?: boolean; + + /** + * Configures how the feature chooser icon should display on header cells - e.g. to display as gear icon or not. + * + * + * Valid values: + * "none" Always hide the feature chooser icon; The feature chooser is shown on tapping/clicking the column header. + * "desktopOnly" Always show the icon on desktop but hide when touch device detected. + * "always" Always show it in any environment. Chooser is shown when tapping the gear icon or column header. + */ + featureChooserIconDisplay?: string; + + /** + * Settings related to content scrolling. + * + */ + scrollSettings?: IgHierarchicalGridScrollSettings; + /** * Event which is fired when a hierarchical row is about to be expanded - * use args.owner to access the hierarchical grid object - * use args.parentrow to access the row element for the row that's about to be expanded */ rowExpanding?: RowExpandingEvent; /** * Event which is fired after a hierarchical row has been expanded - * use args.owner to access the hierarchical grid object - * use args.parentrow to access the row element for the row that was expanded */ rowExpanded?: RowExpandedEvent; /** * Event which is fired when a hierarchical row is about to be collapsed - * use args.owner to access the hierarchical grid object - * use args.parentrow to access the row element for the row that's about to be collapsed */ rowCollapsing?: RowCollapsingEvent; /** * Event which is fired when a hierarchical row has been collapsed - * use args.owner to access the hierarchical grid object - * use args.parentrow to access the row element for the row that was collapsd */ rowCollapsed?: RowCollapsedEvent; /** * Event which is fired when children are about to be populated (Load on demand) - * use args.owner to access the hierarchical grid object - * use args.parentrow to access the row element for the row that's about to be populated - * use args.id to get the data ID of the row */ childrenPopulating?: ChildrenPopulatingEvent; /** * Event which is fired when children have been populated (Load on demand) - * use args.owner to access the hierarchical grid object - * use args.parentrow to access the row element for the row that was populated - * use args.id to get the data ID of the row */ childrenPopulated?: ChildrenPopulatedEvent; /** * Event fired when child grid is rendered - * use args.owner to access the hierarchical grid object - * use args.parentrow to access the row element for the row that's about to be populated - * use args.childgrid to get reference to the child grid */ childGridRendered?: ChildGridRenderedEvent; @@ -42260,6 +48783,134 @@ interface IgHierarchicalGrid { */ childGridCreated?: ChildGridCreatedEvent; + /** + * Event fired when a cell is clicked. + */ + cellClick?: CellClickEvent; + + /** + * Event fired when a cell is right clicked. + */ + cellRightClick?: CellRightClickEvent; + + /** + * Event fired before data binding takes place. + * + * Return false in order to cancel data binding. + */ + dataBinding?: DataBindingEvent; + + /** + * Event fired after data binding is complete. + */ + dataBound?: DataBoundEvent; + + /** + * Event fired before the grid starts rendering (all contents). + * This event is fired only when the grid is being initialized. + * It will not be fired if the grid is rebound to its data + * (for example, when calling the dataBind() API method + * or when changing the page size (when paging is enabled)). + * Return false in order to cancel grid rendering. + */ + rendering?: RenderingEvent; + + /** + * Event fired after the whole grid widget has been rendered (including headers, footers, etc.). + * This event is fired only when the grid is being initialized. + * It will not be fired if the grid is rebound to its data + * (for example, when calling the dataBind() API method + * or when changing the page size (when paging is enabled)). + */ + rendered?: RenderedEvent; + + /** + * Event fired before the TBODY holding the data records starts its rendering. + * Return false in order to cancel data records rendering. + */ + dataRendering?: DataRenderingEvent; + + /** + * Event fired after all of the data records in the grid table body have been rendered. + */ + dataRendered?: DataRenderedEvent; + + /** + * Event fired before the header starts its rendering. + * Return false in order to cancel header rendering. + */ + headerRendering?: HeaderRenderingEvent; + + /** + * Event fired after the header has been rendered. + */ + headerRendered?: HeaderRenderedEvent; + + /** + * Event fired before the caption starts its rendering. + * Return false in order to cancel caption rendering. + */ + captionRendering?: CaptionRenderingEvent; + + /** + * Event fired after the caption has been rendered. + */ + captionRendered?: CaptionRenderedEvent; + + /** + * Event fired before the footer starts its rendering. + * + * Return false in order to cancel footer rendering. + */ + footerRendering?: FooterRenderingEvent; + + /** + * Event fired after the footer has been rendered. + */ + footerRendered?: FooterRenderedEvent; + + /** + * Event fired after every TH in the grid header has been rendered. + */ + headerCellRendered?: HeaderCellRenderedEvent; + + /** + * Event fired before actual data rows (TRs) are rendered. + * Return false in order to cancel rows rendering. + */ + rowsRendering?: RowsRenderingEvent; + + /** + * Event fired after data rows are rendered. + */ + rowsRendered?: RowsRenderedEvent; + + /** + * Event fired after $.ig.DataSource schema has been generated, in case it needs to be modified. + */ + schemaGenerated?: SchemaGeneratedEvent; + + /** + * Event fired after the columns colection has been modified(e.g. a column is hidden) + */ + columnsCollectionModified?: ColumnsCollectionModifiedEvent; + + /** + * Event fired if there is an error in the request, when the grid is doing a remote operation, + * such as data binding, paging, sorting, etc. + */ + requestError?: RequestErrorEvent; + + /** + * Fired when the grid is created and the initial structure is rendered (this doesn't necessarily imply the data will be there if the data source is remote) + */ + created?: CreatedEvent; + + /** + * Fired when the grid is destroyed + */ + destroyed?: DestroyedEvent; + /** * Option for igHierarchicalGrid */ @@ -42293,7 +48944,7 @@ 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. + * 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 @@ -42302,7 +48953,7 @@ 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. + * 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 @@ -42318,7 +48969,7 @@ 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. + * 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 @@ -42387,36 +49038,42 @@ interface JQuery { /** * Only the first level will be data-bound initially. Also serves as "render" depth, meaning that depending on this prop, the grid will + * */ igHierarchicalGrid(optionLiteral: 'option', optionName: "initialDataBindDepth"): number; /** * Only the first level will be data-bound initially. Also serves as "render" depth, meaning that depending on this prop, the grid will * + * * @optionValue New value to be set. */ igHierarchicalGrid(optionLiteral: 'option', optionName: "initialDataBindDepth", optionValue: number): void; /** * No levels will be automatically expanded when the widget is instantiated for the first time + * */ igHierarchicalGrid(optionLiteral: 'option', optionName: "initialExpandDepth"): number; /** * No levels will be automatically expanded when the widget is instantiated for the first time * + * * @optionValue New value to be set. */ igHierarchicalGrid(optionLiteral: 'option', optionName: "initialExpandDepth", optionValue: number): void; /** * If true, encodes all requests using OData conventions and the $expand syntax + * */ igHierarchicalGrid(optionLiteral: 'option', optionName: "odata"): boolean; /** * If true, encodes all requests using OData conventions and the $expand syntax * + * * @optionValue New value to be set. */ igHierarchicalGrid(optionLiteral: 'option', optionName: "odata", optionValue: boolean): void; @@ -42424,6 +49081,7 @@ interface JQuery { /** * If true, load on demand will be achieved using REST compliant resource access with appropriate url-s for * the ajax GET calls. + * */ igHierarchicalGrid(optionLiteral: 'option', optionName: "rest"): boolean; @@ -42431,30 +49089,35 @@ interface JQuery { * If true, load on demand will be achieved using REST compliant resource access with appropriate url-s for * the ajax GET calls. * + * * @optionValue New value to be set. */ igHierarchicalGrid(optionLiteral: 'option', optionName: "rest", optionValue: boolean): void; /** * Gets the limit on the number of levels to bind to + * */ igHierarchicalGrid(optionLiteral: 'option', optionName: "maxDataBindDepth"): number; /** * Sets the limit on the number of levels to bind to * + * * @optionValue New value to be set. */ igHierarchicalGrid(optionLiteral: 'option', optionName: "maxDataBindDepth", optionValue: number): void; /** * Gets the default property in the response where children will be located + * */ igHierarchicalGrid(optionLiteral: 'option', optionName: "defaultChildrenDataProperty"): string; /** * Sets the default property in the response where children will be located * + * * @optionValue New value to be set. */ igHierarchicalGrid(optionLiteral: 'option', optionName: "defaultChildrenDataProperty", optionValue: string): void; @@ -42462,6 +49125,7 @@ interface JQuery { /** * If true, will autogenerate all layouts assuming default values for "childrenDataProperty" * When autoGenerateLayouts is enabled, it will automatically generate all columns recursively. (all columns on all levels) + * */ igHierarchicalGrid(optionLiteral: 'option', optionName: "autoGenerateLayouts"): boolean; @@ -42469,117 +49133,788 @@ interface JQuery { * If true, will autogenerate all layouts assuming default values for "childrenDataProperty" * When autoGenerateLayouts is enabled, it will automatically generate all columns recursively. (all columns on all levels) * + * * @optionValue New value to be set. */ igHierarchicalGrid(optionLiteral: 'option', optionName: "autoGenerateLayouts", optionValue: boolean): void; /** * Applies a linear animation - either expanding or collapsing depending on the parent row state + * */ igHierarchicalGrid(optionLiteral: 'option', optionName: "expandCollapseAnimations"): boolean; /** * Applies a linear animation - either expanding or collapsing depending on the parent row state * + * * @optionValue New value to be set. */ igHierarchicalGrid(optionLiteral: 'option', optionName: "expandCollapseAnimations", optionValue: boolean): void; /** * Gets the expand column width + * */ igHierarchicalGrid(optionLiteral: 'option', optionName: "expandColWidth"): number; /** * Sets the expand column width * + * * @optionValue New value to be set. */ igHierarchicalGrid(optionLiteral: 'option', optionName: "expandColWidth", optionValue: number): void; /** * Gets the delimiter for constructing paths , for hierarchical lookup of data + * */ igHierarchicalGrid(optionLiteral: 'option', optionName: "pathSeparator"): string; /** * Sets the delimiter for constructing paths , for hierarchical lookup of data * + * * @optionValue New value to be set. */ igHierarchicalGrid(optionLiteral: 'option', optionName: "pathSeparator", optionValue: string): void; /** * The row expanding/collapsing animation duration in ms. + * */ igHierarchicalGrid(optionLiteral: 'option', optionName: "animationDuration"): number; /** * The row expanding/collapsing animation duration in ms. * + * * @optionValue New value to be set. */ igHierarchicalGrid(optionLiteral: 'option', optionName: "animationDuration", optionValue: number): void; /** * Gets the default tooltip applied to an expand column cell, that is currently collapsed + * */ igHierarchicalGrid(optionLiteral: 'option', optionName: "expandTooltip"): string; /** * Sets the default tooltip applied to an expand column cell, that is currently collapsed * + * * @optionValue New value to be set. */ igHierarchicalGrid(optionLiteral: 'option', optionName: "expandTooltip", optionValue: string): void; /** * Gets the default tooltip applied to an expand column cell, that is currently expanded + * */ igHierarchicalGrid(optionLiteral: 'option', optionName: "collapseTooltip"): string; /** * Sets the default tooltip applied to an expand column cell, that is currently expanded * + * * @optionValue New value to be set. */ igHierarchicalGrid(optionLiteral: 'option', optionName: "collapseTooltip", optionValue: string): void; - /** - * An array of column objects - */ - igHierarchicalGrid(optionLiteral: 'option', optionName: "columns"): any[]; - - /** - * An array of column objects - * - * @optionValue New value to be set. - */ - igHierarchicalGrid(optionLiteral: 'option', optionName: "columns", optionValue: any[]): void; - /** * List of columnLayout objects that specify the structure of the child grids. All options that are applicable to a flat grid are also applicable here + * */ igHierarchicalGrid(optionLiteral: 'option', optionName: "columnLayouts"): IgHierarchicalGridColumnLayout[]; /** * List of columnLayout objects that specify the structure of the child grids. All options that are applicable to a flat grid are also applicable here * + * * @optionValue New value to be set. */ igHierarchicalGrid(optionLiteral: 'option', optionName: "columnLayouts", optionValue: IgHierarchicalGridColumnLayout[]): 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). + * + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "width"): string|number; + + /** + * 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). + * + * + * @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; + + /** + * 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). + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "height", optionValue: string|number): void; + + /** + * If autoAdjustHeight is set to false, the [height](ui.ighierarchicalgrid#options:height) will be set only on the scrolling container, and all other UI elements such as paging footer / filter row / headers will add on top of that, so the total height of the grid will be more than this value - the height of the scroll container (content area) will not be dynamically calculated. Setting this option to false will usually result in a lot better initial rendering performance for large data ( > 1000 rows rendered at once, no [virtualization](ui.ighierarchicalgrid#options:virtualization) enabled), since no reflows will be made by browsers when accessing DOM properties such as offsetHeight. + * + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "autoAdjustHeight"): boolean; + + /** + * If autoAdjustHeight is set to false, the [height](ui.ighierarchicalgrid#options:height) will be set only on the scrolling container, and all other UI elements such as paging footer / filter row / headers will add on top of that, so the total height of the grid will be more than this value - the height of the scroll container (content area) will not be dynamically calculated. Setting this option to false will usually result in a lot better initial rendering performance for large data sets ( > 1000 rows rendered at once, no [virtualization](ui.ighierarchicalgrid#options:virtualization) enabled), since no reflows will be made by browsers when accessing DOM properties such as offsetHeight. + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "autoAdjustHeight", optionValue: boolean): void; + + /** + * 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; + + /** + * 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. + * + * + * @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; + + /** + * 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. + * + * + * @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; + + /** + * Default column width that will be set for all columns, that don't have [column width](ui.ighierarchicalgrid#options:columns.width) defined. + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "defaultColumnWidth", optionValue: string|number): void; + + /** + * If no [columns](ui.ighierarchicalgrid#options:columns) collection is defined, and autoGenerateColumns is set to true, [columns](ui.ighierarchicalgrid#options:columns) will be inferred from the data source before the [dataRendering](ui.iggrid#events:dataRendering) event is fired. The inferred [columns](ui.ighierarchicalgrid#options:columns) collection will be available to the developer for modification at [dataRendering](ui.iggrid#events:dataRendering). If autoGenerateColumns is not explicitly set and [columns](ui.ighierarchicalgrid#options:columns) has at least one column defined then autoGenerateColumns is automatically set to false. + * If autoGenerateColumns is true and there are columns defined auto-generated columns will render after the explicitly defined ones. + * Since auto-generated columns don't have width defined consider setting [defaultColumnWidth](ui.ighierarchicalgrid#options:defaultColumnWidth) as well. + * + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "autoGenerateColumns"): boolean; + + /** + * If no [columns](ui.ighierarchicalgrid#options:columns) collection is defined, and autoGenerateColumns is set to true, [columns](ui.ighierarchicalgrid#options:columns) will be inferred from the data source before the [dataRendering](ui.iggrid#events:dataRendering) event is fired. The inferred [columns](ui.ighierarchicalgrid#options:columns) collection will be available to the developer for modification at [dataRendering](ui.iggrid#events:dataRendering). If autoGenerateColumns is not explicitly set and [columns](ui.ighierarchicalgrid#options:columns) has at least one column defined then autoGenerateColumns is automatically set to false. + * If autoGenerateColumns is true and there are columns defined auto-generated columns will render after the explicitly defined ones. + * Since auto-generated columns don't have width defined consider setting [defaultColumnWidth](ui.ighierarchicalgrid#options:defaultColumnWidth) as well. + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "autoGenerateColumns", optionValue: boolean): void; + + /** + * Enables/disables column and row virtualization at the same time. Virtualization can greatly enhance rendering performance. If enabled, the number of actual rendered rows (DOM elements) will be constant and related to the visible viewport of the grid. As the end user scrolls, those DOM elements will be dynamically reused to render the new data. [Here you can find more info about the performance guidelines when using the igGrid](http://www.igniteui.com/help/iggrid-performance-guide) + * + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "virtualization"): boolean; + + /** + * Enables/disables column and row virtualization at the same time. Virtualization can greatly enhance rendering performance. If enabled, the number of actual rendered rows (DOM elements) will be constant and related to the visible viewport of the grid. As the end user scrolls, those DOM elements will be dynamically reused to render the new data. [Here you can find more info about the performance guidelines when using the igGrid](http://www.igniteui.com/help/iggrid-performance-guide) + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "virtualization", optionValue: boolean): void; + + /** + * Determines row virtualization mode. + * + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "virtualizationMode"): string; + + /** + * Determines row virtualization mode. + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "virtualizationMode", optionValue: string): void; + + /** + * Enables virtualization for rows only. [Here you can find more info about igGrid row virtualization](http://www.igniteui.com/help/iggrid-virtualization-overview) + * + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "rowVirtualization"): boolean; + + /** + * Enables virtualization for rows only. [Here you can find more info about igGrid row virtualization](http://www.igniteui.com/help/iggrid-virtualization-overview) + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "rowVirtualization", optionValue: boolean): void; + + /** + * Enables virtualization for columns only. Column virtualization can work only in combination with fixed row virtalization. Setting columnVirtualization to true will automatically set [virtualization](ui.ighierarchicalgrid#options:virtualization) to true and [virtualizationMode](ui.ighierarchicalgrid#options:virtualizationMode) to "fixed". + * + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "columnVirtualization"): boolean; + + /** + * Enables virtualization for columns only. Column virtualization can work only in combination with fixed row virtalization. Setting columnVirtualization to true will automatically set [virtualization](ui.ighierarchicalgrid#options:virtualization) to true and [virtualizationMode](ui.ighierarchicalgrid#options:virtualizationMode) to "fixed". + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "columnVirtualization", optionValue: boolean): void; + + /** + * Number of pixels to scroll the grid by, when virtualization is enabled, and mouse wheel scrolling is performed over the virtual grid area. If "null" the step will be equal to the [avgRowHeight](ui.ighierarchicalgrid#options:avgRowHeight). + * + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "virtualizationMouseWheelStep"): number; + + /** + * Number of pixels to scroll the grid by, when virtualization is enabled, and mouse wheel scrolling is performed over the virtual grid area. If "null" the step will be equal to the [avgRowHeight](ui.ighierarchicalgrid#options:avgRowHeight). + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "virtualizationMouseWheelStep", optionValue: number): void; + + /** + * If this option is set to true, the height of the grid row will be calculated automatically based on the [avgRowHeight](ui.ighierarchicalgrid#options:avgRowHeight) and the visible virtual records. If no [avgRowHeight](ui.ighierarchicalgrid#options:avgRowHeight) is specified, it will be calculated automatically at runtime. + * + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "adjustVirtualHeights"): boolean; + + /** + * If this option is set to true, the height of the grid row will be calculated automatically based on the [avgRowHeight](ui.ighierarchicalgrid#options:avgRowHeight) and the visible virtual records. If no [avgRowHeight](ui.ighierarchicalgrid#options:avgRowHeight) is specified, it will be calculated automatically at runtime. + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "adjustVirtualHeights", optionValue: boolean): void; + + /** + * 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; + + /** + * 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. + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "templatingEngine", optionValue: string): void; + + /** + * An array of column objects. Checkout the [Columns and Layout](http://www.igniteui.com/help/iggrid-columns-and-layout#defining-columns) topic for details on configuring the columns array. + * + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "columns"): IgHierarchicalGridColumn[]; + + /** + * An array of column objects. Checkout the [Columns and Layout](http://www.igniteui.com/help/iggrid-columns-and-layout#defining-columns) topic for details on configuring the columns array. + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "columns", optionValue: IgHierarchicalGridColumn[]): void; + + /** + * Can be any valid data source accepted by [$.ig.DataSource](ig.datasource), or an instance of an $.ig.DataSource itself + * + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "dataSource"): any; + + /** + * Can be any valid data source accepted by [$.ig.DataSource](ig.datasource), or an instance of an $.ig.DataSource itself + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "dataSource", optionValue: any): void; + + /** + * Gets a remote URL as a data source, from which data will be retrieved using the [$.ig.DataSource](ig.datasource). + * + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "dataSourceUrl"): string; + + /** + * Sets a remote URL as a data source, from which data will be retrieved using the [$.ig.DataSource](ig.datasource). + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "dataSourceUrl", 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). + * + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "dataSourceType"): string; + + /** + * Explicitly set data source type (such as "json"). Please refer to the documentation of [$.ig.DataSource type](ig.datasource#options:settings.type). + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "dataSourceType", optionValue: string): void; + + /** + * See [$.ig.DataSource responseDataKey](ig.datasource#options:settings.responseDataKey). This is the property in the responses where data records are held, if the response is wrapped. + * + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "responseDataKey"): string; + + /** + * See [$.ig.DataSource responseDataKey](ig.datasource#options:settings.responseDataKey). This is the property in the responses where data records are held, if the response is wrapped. + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "responseDataKey", optionValue: string): void; + + /** + * See [$.ig.DataSource responseTotalRecCountKey](ig.datasource#options:settings.responseTotalRecCountKey). Property in the response specifying the total number of records on the server. + * + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "responseTotalRecCountKey"): string; + + /** + * See [$.ig.DataSource responseTotalRecCountKey](ig.datasource#options:settings.responseTotalRecCountKey). Property in the response specifying the total number of records on the server. + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "responseTotalRecCountKey", optionValue: string): void; + + /** + * Gets the HTTP verb to be used to issue the requests to a remote data source. + * + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "requestType"): string; + + /** + * Sets the HTTP verb to be used to issue the requests to a remote data source. + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "requestType", optionValue: string): void; + + /** + * Content type of the response. See http://api.jquery.com/jQuery.ajax/ => contentType + * + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "responseContentType"): string; + + /** + * Content type of the response. See http://api.jquery.com/jQuery.ajax/ => contentType + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "responseContentType", optionValue: string): void; + + /** + * Controls the visibility of the grid header. + * + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "showHeader"): boolean; + + /** + * Controls the visibility of the grid header. + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "showHeader", optionValue: boolean): void; + + /** + * Controls the visibility of the grid footer. + * + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "showFooter"): boolean; + + /** + * Controls the visibility of the grid footer. + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "showFooter", optionValue: boolean): void; + + /** + * Headers will be fixed if this option is set to true, and only the grid data will be scrollable. If [virtualization](ui.ighierarchicalgrid#options:virtualization) is enabled, fixedHeaders will always act as if it's true, no matter which value is set. + * + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "fixedHeaders"): boolean; + + /** + * Headers will be fixed if this option is set to true, and only the grid data will be scrollable. If [virtualization](ui.ighierarchicalgrid#options:virtualization) is enabled, fixedHeaders will always act as if it's true, no matter which value is set. + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "fixedHeaders", optionValue: boolean): void; + + /** + * Footers will be fixed if this option is set to true, and only the grid data will be scrollable. If [virtualization](ui.ighierarchicalgrid#options:virtualization) is enabled, fixedFooters will always act as if it's true, no matter which value is set. + * + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "fixedFooters"): boolean; + + /** + * Footers will be fixed if this option is set to true, and only the grid data will be scrollable. If [virtualization](ui.ighierarchicalgrid#options:virtualization) is enabled, fixedFooters will always act as if it's true, no matter which value is set. + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "fixedFooters", optionValue: boolean): void; + + /** + * Caption text that will be shown above the grid header. + * + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "caption"): string; + + /** + * Caption text that will be shown above the grid header. + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "caption", optionValue: string): void; + + /** + * List of grid feature definitions: sorting, paging, etc. Each feature goes with its separate options that are documented for the feature accordingly. [Here you can find detailed documentation for all igGrid features](http://www.igniteui.com/help/iggrid-features-landing-page) + * + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "features"): IgHierarchicalGridFeature[]; + + /** + * List of grid feature definitions: sorting, paging, etc. Each feature goes with its separate options that are documented for the feature accordingly. [Here you can find detailed documentation for all igGrid features](http://www.igniteui.com/help/iggrid-features-landing-page) + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "features", optionValue: IgHierarchicalGridFeature[]): void; + + /** + * Initial tabIndex attribute that will be set on all focusable elements. + * + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "tabIndex"): number; + + /** + * Initial tabIndex attribute that will be set on all focusable elements. + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "tabIndex", optionValue: number): void; + + /** + * If this option is set to false, the data to which the grid is bound will be used "as is" with no additional transformations based on [columns](ui.ighierarchicalgrid#options:columns) defined. Otherwise only the subset of data properties used in the [columns](ui.ighierarchicalgrid#options:columns) defined will be extracted in a new object and used. + * + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "localSchemaTransform"): boolean; + + /** + * If this option is set to false, the data to which the grid is bound will be used "as is" with no additional transformations based on [columns](ui.ighierarchicalgrid#options:columns) defined. Otherwise only the subset of data properties used in the [columns](ui.ighierarchicalgrid#options:columns) defined will be extracted in a new object and used. + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "localSchemaTransform", optionValue: boolean): void; + + /** + * Key of the column containing unique identifiers for the data records. + * + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "primaryKey"): string; + + /** + * Key of the column containing unique identifiers for the data records. + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "primaryKey", optionValue: string): void; + + /** + * If true, the transaction log will always be sent in the request for remote data, by the data source. Also this means that if there are values in the log, a POST will be performed instead of GET. + * + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "serializeTransactionLog"): boolean; + + /** + * If true, the transaction log will always be sent in the request for remote data, by the data source. Also this means that if there are values in the log, a POST will be performed instead of GET. + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "serializeTransactionLog", optionValue: boolean): void; + + /** + * Automatically commits the transactions as rows/cells are being edited to the client data source. A [saveChanges](ui.ighierarchicalgrid#methods:saveChanges) call still needs to be performed in order to commit the transactions to a server-side data source. + * + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "autoCommit"): boolean; + + /** + * Automatically commits the transactions as rows/cells are being edited to the client data source. A [saveChanges](ui.ighierarchicalgrid#methods:saveChanges) call still needs to be performed in order to commit the transactions to a server-side data source. + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "autoCommit", optionValue: boolean): void; + + /** + * If set to true, the following behavior will take place: + * If a new row is added, and then deleted, there will be no transaction added to the log. + * If a new row is added, edited, then deleted, there will be no transaction added to the log. + * If several edits are made to a row or an individual cell, this should result in a single transaction. + * Note: This option takes effect only when [autoCommit](ui.ighierarchicalgrid#options:autoCommit) is set to false. + * + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "aggregateTransactions"): boolean; + + /** + * If set to true, the following behavior will take place: + * If a new row is added, and then deleted, there will be no transaction added to the log. + * If a new row is added, edited, then deleted, there will be no transaction added to the log. + * If several edits are made to a row or an individual cell, this should result in a single transaction. + * Note: This option takes effect only when [autoCommit](ui.ighierarchicalgrid#options:autoCommit) is set to false. + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "aggregateTransactions", optionValue: boolean): void; + + /** + * 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; + + /** + * 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) + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "autoFormat", optionValue: string|boolean): void; + + /** + * Gets ability to render checkboxes and use checkbox editor when dataType of a column is "bool". Checkboxes are not rendered for boolean values in columns with a [column template](ui.ighierarchicalgrid#options:columns.template). + * + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "renderCheckboxes"): boolean; + + /** + * Sets ability to render checkboxes and use checkbox editor when dataType of a column is "bool". Checkboxes are not rendered for boolean values in columns with a [column template](ui.ighierarchicalgrid#options:columns.template). + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "renderCheckboxes", optionValue: boolean): void; + + /** + * URL to which updating requests will be made. + * + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "updateUrl"): string; + + /** + * URL to which updating requests will be made. + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "updateUrl", optionValue: string): void; + + /** + * Settings related to REST compliant update routines. + * + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "restSettings"): IgHierarchicalGridRestSettings; + + /** + * Settings related to REST compliant update routines. + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "restSettings", optionValue: IgHierarchicalGridRestSettings): void; + + /** + * Enables/disables rendering of alternating row styles (odd and even rows receive different styling). + * + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "alternateRowStyles"): boolean; + + /** + * Enables/disables rendering of alternating row styles (odd and even rows receive different styling). + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "alternateRowStyles", optionValue: boolean): void; + + /** + * If set to true and all columns' widths are specified and their combined width is less than the grid width then the last column width will be automatically adjusted to fill the remaining empty space of the grid. + * + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "autofitLastColumn"): boolean; + + /** + * If set to true and all columns' widths are specified and their combined width is less than the grid width then the last column width will be automatically adjusted to fill the remaining empty space of the grid. + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "autofitLastColumn", optionValue: boolean): void; + + /** + * Enables/disables rendering of hover styles when the mouse is over a record. This can be useful in templating scenarios, for example, where we don't want to apply hover styling to templated content. + * + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "enableHoverStyles"): boolean; + + /** + * Enables/disables rendering of hover styles when the mouse is over a record. This can be useful in templating scenarios, for example, where we don't want to apply hover styling to templated content. + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "enableHoverStyles", optionValue: boolean): void; + + /** + * Nables/Disables serializing client date as UTC ISO 8061 string instead of using the local time and zone values. + * + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "enableUTCDates"): boolean; + + /** + * Nables/Disables serializing client date as UTC ISO 8061 string instead of using the local time and zone values. + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "enableUTCDates", optionValue: boolean): void; + + /** + * Merge unbound columns values inside data source when data source is remote. If true then the unbound columns are merged to the data source at runtime on the server. Note that data source is expanded with the new data and this could cause performance issues when the data is huge. If mergeUnboundColumns is false then the unbound data is sent and merged on the client. This option is used by the [igGrid MVC Helper](http://www.igniteui.com/help/iggrid-developing-asp-net-mvc-applications-with-iggrid). + * Checkout [Populating Unbound Columns Remotely (igGrid)](http://www.igniteui.com/help/iggrid-unboundcolumns-populating-with-data-remotely) topic for more information. + * + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "mergeUnboundColumns"): boolean; + + /** + * Merge unbound columns values inside data source when data source is remote. If true then the unbound columns are merged to the data source at runtime on the server. Note that data source is expanded with the new data and this could cause performance issues when the data is huge. If mergeUnboundColumns is false then the unbound data is sent and merged on the client. This option is used by the [igGrid MVC Helper](http://www.igniteui.com/help/iggrid-developing-asp-net-mvc-applications-with-iggrid). + * Checkout [Populating Unbound Columns Remotely (igGrid)](http://www.igniteui.com/help/iggrid-unboundcolumns-populating-with-data-remotely) topic for more information. + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "mergeUnboundColumns", optionValue: boolean): void; + + /** + * When dataSource is a remote URL, defines whether to set the type of the remote data source to JSONP. + * + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "jsonpRequest"): boolean; + + /** + * When dataSource is a remote URL, defines whether to set the type of the remote data source to JSONP. + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "jsonpRequest", optionValue: boolean): void; + + /** + * Enables/disables grid adjusting its dimensions when its [width](ui.ighierarchicalgrid#options:width) and/or [height](ui.ighierarchicalgrid#options:height) is set in percent (%) and grid parent DOM container is resized. + * + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "enableResizeContainerCheck"): boolean; + + /** + * Enables/disables grid adjusting its dimensions when its [width](ui.ighierarchicalgrid#options:width) and/or [height](ui.ighierarchicalgrid#options:height) is set in percent (%) and grid parent DOM container is resized. + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "enableResizeContainerCheck", optionValue: boolean): void; + + /** + * 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; + + /** + * Configures how the feature chooser icon should display on header cells - e.g. to display as gear icon or not. + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "featureChooserIconDisplay", optionValue: string): void; + + /** + * Settings related to content scrolling. + * + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "scrollSettings"): IgHierarchicalGridScrollSettings; + + /** + * Settings related to content scrolling. + * + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "scrollSettings", optionValue: IgHierarchicalGridScrollSettings): void; + /** * Event which is fired when a hierarchical row is about to be expanded - * use args.owner to access the hierarchical grid object - * use args.parentrow to access the row element for the row that's about to be expanded */ igHierarchicalGrid(optionLiteral: 'option', optionName: "rowExpanding"): RowExpandingEvent; /** * Event which is fired when a hierarchical row is about to be expanded - * use args.owner to access the hierarchical grid object - * use args.parentrow to access the row element for the row that's about to be expanded * * @optionValue Define event handler function. */ @@ -42587,15 +49922,11 @@ interface JQuery { /** * Event which is fired after a hierarchical row has been expanded - * use args.owner to access the hierarchical grid object - * use args.parentrow to access the row element for the row that was expanded */ igHierarchicalGrid(optionLiteral: 'option', optionName: "rowExpanded"): RowExpandedEvent; /** * Event which is fired after a hierarchical row has been expanded - * use args.owner to access the hierarchical grid object - * use args.parentrow to access the row element for the row that was expanded * * @optionValue Define event handler function. */ @@ -42603,15 +49934,11 @@ interface JQuery { /** * Event which is fired when a hierarchical row is about to be collapsed - * use args.owner to access the hierarchical grid object - * use args.parentrow to access the row element for the row that's about to be collapsed */ igHierarchicalGrid(optionLiteral: 'option', optionName: "rowCollapsing"): RowCollapsingEvent; /** * Event which is fired when a hierarchical row is about to be collapsed - * use args.owner to access the hierarchical grid object - * use args.parentrow to access the row element for the row that's about to be collapsed * * @optionValue Define event handler function. */ @@ -42619,15 +49946,11 @@ interface JQuery { /** * Event which is fired when a hierarchical row has been collapsed - * use args.owner to access the hierarchical grid object - * use args.parentrow to access the row element for the row that was collapsd */ igHierarchicalGrid(optionLiteral: 'option', optionName: "rowCollapsed"): RowCollapsedEvent; /** * Event which is fired when a hierarchical row has been collapsed - * use args.owner to access the hierarchical grid object - * use args.parentrow to access the row element for the row that was collapsd * * @optionValue Define event handler function. */ @@ -42635,17 +49958,11 @@ interface JQuery { /** * Event which is fired when children are about to be populated (Load on demand) - * use args.owner to access the hierarchical grid object - * use args.parentrow to access the row element for the row that's about to be populated - * use args.id to get the data ID of the row */ igHierarchicalGrid(optionLiteral: 'option', optionName: "childrenPopulating"): ChildrenPopulatingEvent; /** * Event which is fired when children are about to be populated (Load on demand) - * use args.owner to access the hierarchical grid object - * use args.parentrow to access the row element for the row that's about to be populated - * use args.id to get the data ID of the row * * @optionValue Define event handler function. */ @@ -42653,17 +49970,11 @@ interface JQuery { /** * Event which is fired when children have been populated (Load on demand) - * use args.owner to access the hierarchical grid object - * use args.parentrow to access the row element for the row that was populated - * use args.id to get the data ID of the row */ igHierarchicalGrid(optionLiteral: 'option', optionName: "childrenPopulated"): ChildrenPopulatedEvent; /** * Event which is fired when children have been populated (Load on demand) - * use args.owner to access the hierarchical grid object - * use args.parentrow to access the row element for the row that was populated - * use args.id to get the data ID of the row * * @optionValue Define event handler function. */ @@ -42671,17 +49982,11 @@ interface JQuery { /** * Event fired when child grid is rendered - * use args.owner to access the hierarchical grid object - * use args.parentrow to access the row element for the row that's about to be populated - * use args.childgrid to get reference to the child grid */ igHierarchicalGrid(optionLiteral: 'option', optionName: "childGridRendered"): ChildGridRenderedEvent; /** * Event fired when child grid is rendered - * use args.owner to access the hierarchical grid object - * use args.parentrow to access the row element for the row that's about to be populated - * use args.childgrid to get reference to the child grid * * @optionValue Define event handler function. */ @@ -42710,6 +50015,306 @@ interface JQuery { * @optionValue Define event handler function. */ igHierarchicalGrid(optionLiteral: 'option', optionName: "childGridCreated", optionValue: ChildGridCreatedEvent): void; + + /** + * Event fired when a cell is clicked. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "cellClick"): CellClickEvent; + + /** + * Event fired when a cell is clicked. + * + * @optionValue Define event handler function. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "cellClick", optionValue: CellClickEvent): void; + + /** + * Event fired when a cell is right clicked. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "cellRightClick"): CellRightClickEvent; + + /** + * Event fired when a cell is right clicked. + * + * @optionValue Define event handler function. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "cellRightClick", optionValue: CellRightClickEvent): void; + + /** + * Event fired before data binding takes place. + * + * Return false in order to cancel data binding. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "dataBinding"): DataBindingEvent; + + /** + * Event fired before data binding takes place. + * + * Return false in order to cancel data binding. + * + * @optionValue Define event handler function. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "dataBinding", optionValue: DataBindingEvent): void; + + /** + * Event fired after data binding is complete. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "dataBound"): DataBoundEvent; + + /** + * Event fired after data binding is complete. + * + * @optionValue Define event handler function. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "dataBound", optionValue: DataBoundEvent): void; + + /** + * Event fired before the grid starts rendering (all contents). + * This event is fired only when the grid is being initialized. + * It will not be fired if the grid is rebound to its data + * (for example, when calling the dataBind() API method + * or when changing the page size (when paging is enabled)). + * Return false in order to cancel grid rendering. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "rendering"): RenderingEvent; + + /** + * Event fired before the grid starts rendering (all contents). + * This event is fired only when the grid is being initialized. + * It will not be fired if the grid is rebound to its data + * (for example, when calling the dataBind() API method + * or when changing the page size (when paging is enabled)). + * Return false in order to cancel grid rendering. + * + * @optionValue Define event handler function. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "rendering", optionValue: RenderingEvent): void; + + /** + * Event fired after the whole grid widget has been rendered (including headers, footers, etc.). + * This event is fired only when the grid is being initialized. + * It will not be fired if the grid is rebound to its data + * (for example, when calling the dataBind() API method + * or when changing the page size (when paging is enabled)). + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "rendered"): RenderedEvent; + + /** + * Event fired after the whole grid widget has been rendered (including headers, footers, etc.). + * This event is fired only when the grid is being initialized. + * It will not be fired if the grid is rebound to its data + * (for example, when calling the dataBind() API method + * or when changing the page size (when paging is enabled)). + * + * @optionValue Define event handler function. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "rendered", optionValue: RenderedEvent): void; + + /** + * Event fired before the TBODY holding the data records starts its rendering. + * Return false in order to cancel data records rendering. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "dataRendering"): DataRenderingEvent; + + /** + * Event fired before the TBODY holding the data records starts its rendering. + * Return false in order to cancel data records rendering. + * + * @optionValue Define event handler function. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "dataRendering", optionValue: DataRenderingEvent): void; + + /** + * Event fired after all of the data records in the grid table body have been rendered. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "dataRendered"): DataRenderedEvent; + + /** + * Event fired after all of the data records in the grid table body have been rendered. + * + * @optionValue Define event handler function. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "dataRendered", optionValue: DataRenderedEvent): void; + + /** + * Event fired before the header starts its rendering. + * Return false in order to cancel header rendering. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "headerRendering"): HeaderRenderingEvent; + + /** + * Event fired before the header starts its rendering. + * Return false in order to cancel header rendering. + * + * @optionValue Define event handler function. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "headerRendering", optionValue: HeaderRenderingEvent): void; + + /** + * Event fired after the header has been rendered. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "headerRendered"): HeaderRenderedEvent; + + /** + * Event fired after the header has been rendered. + * + * @optionValue Define event handler function. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "headerRendered", optionValue: HeaderRenderedEvent): void; + + /** + * Event fired before the caption starts its rendering. + * Return false in order to cancel caption rendering. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "captionRendering"): CaptionRenderingEvent; + + /** + * Event fired before the caption starts its rendering. + * Return false in order to cancel caption rendering. + * + * @optionValue Define event handler function. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "captionRendering", optionValue: CaptionRenderingEvent): void; + + /** + * Event fired after the caption has been rendered. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "captionRendered"): CaptionRenderedEvent; + + /** + * Event fired after the caption has been rendered. + * + * @optionValue Define event handler function. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "captionRendered", optionValue: CaptionRenderedEvent): void; + + /** + * Event fired before the footer starts its rendering. + * + * Return false in order to cancel footer rendering. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "footerRendering"): FooterRenderingEvent; + + /** + * Event fired before the footer starts its rendering. + * + * Return false in order to cancel footer rendering. + * + * @optionValue Define event handler function. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "footerRendering", optionValue: FooterRenderingEvent): void; + + /** + * Event fired after the footer has been rendered. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "footerRendered"): FooterRenderedEvent; + + /** + * Event fired after the footer has been rendered. + * + * @optionValue Define event handler function. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "footerRendered", optionValue: FooterRenderedEvent): void; + + /** + * Event fired after every TH in the grid header has been rendered. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "headerCellRendered"): HeaderCellRenderedEvent; + + /** + * Event fired after every TH in the grid header has been rendered. + * + * @optionValue Define event handler function. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "headerCellRendered", optionValue: HeaderCellRenderedEvent): void; + + /** + * Event fired before actual data rows (TRs) are rendered. + * Return false in order to cancel rows rendering. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "rowsRendering"): RowsRenderingEvent; + + /** + * Event fired before actual data rows (TRs) are rendered. + * Return false in order to cancel rows rendering. + * + * @optionValue Define event handler function. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "rowsRendering", optionValue: RowsRenderingEvent): void; + + /** + * Event fired after data rows are rendered. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "rowsRendered"): RowsRenderedEvent; + + /** + * Event fired after data rows are rendered. + * + * @optionValue Define event handler function. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "rowsRendered", optionValue: RowsRenderedEvent): void; + + /** + * Event fired after $.ig.DataSource schema has been generated, in case it needs to be modified. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "schemaGenerated"): SchemaGeneratedEvent; + + /** + * Event fired after $.ig.DataSource schema has been generated, in case it needs to be modified. + * + * @optionValue Define event handler function. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "schemaGenerated", optionValue: SchemaGeneratedEvent): void; + + /** + * Event fired after the columns colection has been modified(e.g. a column is hidden) + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "columnsCollectionModified"): ColumnsCollectionModifiedEvent; + + /** + * Event fired after the columns colection has been modified(e.g. a column is hidden) + * + * @optionValue Define event handler function. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "columnsCollectionModified", optionValue: ColumnsCollectionModifiedEvent): void; + + /** + * Event fired if there is an error in the request, when the grid is doing a remote operation, + * such as data binding, paging, sorting, etc. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "requestError"): RequestErrorEvent; + + /** + * Event fired if there is an error in the request, when the grid is doing a remote operation, + * such as data binding, paging, sorting, etc. + * + * @optionValue Define event handler function. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "requestError", optionValue: RequestErrorEvent): void; + + /** + * Fired when the grid is created and the initial structure is rendered (this doesn't necessarily imply the data will be there if the data source is remote) + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "created"): CreatedEvent; + + /** + * Fired when the grid is created and the initial structure is rendered (this doesn't necessarily imply the data will be there if the data source is remote) + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "created", optionValue: CreatedEvent): void; + + /** + * Fired when the grid is destroyed + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "destroyed"): DestroyedEvent; + + /** + * Fired when the grid is destroyed + * + * @optionValue New value to be set. + */ + igHierarchicalGrid(optionLiteral: 'option', optionName: "destroyed", optionValue: DestroyedEvent): void; igHierarchicalGrid(options: IgHierarchicalGrid): JQuery; igHierarchicalGrid(optionLiteral: 'option', optionName: string): any; igHierarchicalGrid(optionLiteral: 'option', options: IgHierarchicalGrid): JQuery; @@ -42721,20 +50326,6 @@ interface GroupCollapsingEvent { } interface GroupCollapsingEventUIParam { - /** - * Used to get the reference to the GridMultiColumnHeaders widget. - */ - owner?: any; - - /** - * Used to get the column object for the current group that is collapsing. - */ - column?: any; - - /** - * Used to get a reference to the jQuery object for the column being collapsing (th). - */ - element?: any; } interface GroupCollapsedEvent { @@ -42742,20 +50333,6 @@ interface GroupCollapsedEvent { } interface GroupCollapsedEventUIParam { - /** - * Used to get the reference to the GridMultiColumnHeaders widget. - */ - owner?: any; - - /** - * Used to get the column object for the current group that is collapsed. - */ - column?: any; - - /** - * Used to get a reference to the jQuery object for the column being collapsed (th). - */ - element?: any; } interface GroupExpandingEvent { @@ -42763,20 +50340,6 @@ interface GroupExpandingEvent { } interface GroupExpandingEventUIParam { - /** - * Used to get the reference to the GridMultiColumnHeaders widget. - */ - owner?: any; - - /** - * Used to get the column object for the current group that is expanding. - */ - column?: any; - - /** - * Used to get a reference to the jQuery object for the column being expanded (th). - */ - element?: any; } interface GroupExpandedEvent { @@ -42784,20 +50347,6 @@ interface GroupExpandedEvent { } interface GroupExpandedEventUIParam { - /** - * Used to get the reference to the GridMultiColumnHeaders widget. - */ - owner?: any; - - /** - * Used to get the column object for the current group that is expanded. - */ - column?: any; - - /** - * Used to get a reference to the jQuery object for the column being expanded (th). - */ - element?: any; } interface IgGridMultiColumnHeaders { @@ -42808,41 +50357,21 @@ interface IgGridMultiColumnHeaders { /** * Event fired before a group collapsing operation is executed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridMultiColumnHeaders widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.column to get the column object for the current group that is collapsing. - * Use ui.element to get a reference to the jQuery object for the column being collapsing (th). */ groupCollapsing?: GroupCollapsingEvent; /** * Event fired after the group collapsing has been executed and results are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridMultiColumnHeaders widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.column to get the column object for the current group that is collapsed. - * Use ui.element to get a reference to the jQuery object for the column being collapsed (th). */ groupCollapsed?: GroupCollapsedEvent; /** * Event fired before a group expanding operation is executed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridMultiColumnHeaders widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.column to get the column object for the current group that is expanding. - * Use ui.element to get a reference to the jQuery object for the column being expanded (th). */ groupExpanding?: GroupExpandingEvent; /** * Event fired after the group expanding has been executed and results are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridMultiColumnHeaders widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.column to get the column object for the current group that is expanded. - * Use ui.element to get a reference to the jQuery object for the column being expanded (th). */ groupExpanded?: GroupExpandedEvent; @@ -42914,21 +50443,11 @@ interface JQuery { /** * Event fired before a group collapsing operation is executed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridMultiColumnHeaders widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.column to get the column object for the current group that is collapsing. - * Use ui.element to get a reference to the jQuery object for the column being collapsing (th). */ igGridMultiColumnHeaders(optionLiteral: 'option', optionName: "groupCollapsing"): GroupCollapsingEvent; /** * Event fired before a group collapsing operation is executed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridMultiColumnHeaders widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.column to get the column object for the current group that is collapsing. - * Use ui.element to get a reference to the jQuery object for the column being collapsing (th). * * @optionValue Define event handler function. */ @@ -42936,21 +50455,11 @@ interface JQuery { /** * Event fired after the group collapsing has been executed and results are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridMultiColumnHeaders widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.column to get the column object for the current group that is collapsed. - * Use ui.element to get a reference to the jQuery object for the column being collapsed (th). */ igGridMultiColumnHeaders(optionLiteral: 'option', optionName: "groupCollapsed"): GroupCollapsedEvent; /** * Event fired after the group collapsing has been executed and results are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridMultiColumnHeaders widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.column to get the column object for the current group that is collapsed. - * Use ui.element to get a reference to the jQuery object for the column being collapsed (th). * * @optionValue Define event handler function. */ @@ -42958,21 +50467,11 @@ interface JQuery { /** * Event fired before a group expanding operation is executed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridMultiColumnHeaders widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.column to get the column object for the current group that is expanding. - * Use ui.element to get a reference to the jQuery object for the column being expanded (th). */ igGridMultiColumnHeaders(optionLiteral: 'option', optionName: "groupExpanding"): GroupExpandingEvent; /** * Event fired before a group expanding operation is executed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridMultiColumnHeaders widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.column to get the column object for the current group that is expanding. - * Use ui.element to get a reference to the jQuery object for the column being expanded (th). * * @optionValue Define event handler function. */ @@ -42980,21 +50479,11 @@ interface JQuery { /** * Event fired after the group expanding has been executed and results are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridMultiColumnHeaders widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.column to get the column object for the current group that is expanded. - * Use ui.element to get a reference to the jQuery object for the column being expanded (th). */ igGridMultiColumnHeaders(optionLiteral: 'option', optionName: "groupExpanded"): GroupExpandedEvent; /** * Event fired after the group expanding has been executed and results are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridMultiColumnHeaders widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.column to get the column object for the current group that is expanded. - * Use ui.element to get a reference to the jQuery object for the column being expanded (th). * * @optionValue Define event handler function. */ @@ -43010,20 +50499,6 @@ interface PageIndexChangingEvent { } interface PageIndexChangingEventUIParam { - /** - * Used to get reference to GridPaging. - */ - owner?: any; - - /** - * Used to get current page index. - */ - currentPageIndex?: any; - - /** - * Used to get new page index. - */ - newPageIndex?: any; } interface PageIndexChangedEvent { @@ -43031,15 +50506,6 @@ interface PageIndexChangedEvent { } interface PageIndexChangedEventUIParam { - /** - * Used to get reference to GridPaging. - */ - owner?: any; - - /** - * Used to get current page index. - */ - pageIndex?: any; } interface PageSizeChangingEvent { @@ -43047,16 +50513,6 @@ interface PageSizeChangingEvent { } interface PageSizeChangingEventUIParam { - /** - * Used to get reference to GridPaging. - */ - owner?: any; - - /** - * Used to get current page size. - */ - currentPageSize?: any; - /** * Used to get new page size. */ @@ -43068,15 +50524,6 @@ interface PageSizeChangedEvent { } interface PageSizeChangedEventUIParam { - /** - * Used to get reference to GridPaging. - */ - owner?: any; - - /** - * Used to get current page size. - */ - pageSize?: any; } interface PagerRenderingEvent { @@ -43084,15 +50531,6 @@ interface PagerRenderingEvent { } interface PagerRenderingEventUIParam { - /** - * Used to get reference to GridPaging. - */ - owner?: any; - - /** - * Used to get reference to grid's data source. - */ - dataSource?: any; } interface PagerRenderedEvent { @@ -43100,15 +50538,6 @@ interface PagerRenderedEvent { } interface PagerRenderedEventUIParam { - /** - * Used to get reference to GridPaging. - */ - owner?: any; - - /** - * Used to get reference to grid's data source. - */ - dataSource?: any; } interface IgGridPaging { @@ -43333,59 +50762,34 @@ interface IgGridPaging { /** * Event fired before the page index is changed. * Return false in order to cancel page index changing. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridPaging. - * Use ui.owner.grid to get reference to the grid. - * Use ui.currentPageIndex to get current page index. - * Use ui.newPageIndex to get new page index. */ pageIndexChanging?: PageIndexChangingEvent; /** * Event fired after the page index is changed , but before grid data rebinds - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridPaging. - * Use ui.owner.grid to get reference to the grid. - * Use ui.pageIndex to get current page index. */ pageIndexChanged?: PageIndexChangedEvent; /** * Event fired when the page size is about to be changed from the page size dropdown. * Return false in order to cancel page size changing. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridPaging. - * Use ui.owner.grid to get reference to the grid. - * Use ui.currentPageSize to get current page size. * Use ui.newPageSize to get new page size. */ pageSizeChanging?: PageSizeChangingEvent; /** * Event fired after the page size is changed from the page size dropdown. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridPaging. - * Use ui.owner.grid to get reference to the grid. - * Use ui.pageSize to get current page size. */ pageSizeChanged?: PageSizeChangedEvent; /** * Event fired before the pager footer is rendered (the whole area below the grid records). - * Return false in order to cancel pager footer rendering. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridPaging. - * Use ui.owner.grid to get reference to the grid. - * Use ui.dataSource to get reference to grid's data source. + * Event fired after the page size is changed from the page size dropdown. */ pagerRendering?: PagerRenderingEvent; /** * Event fired after the pager footer is rendered - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridPaging. - * Use ui.owner.grid to get reference to the grid. - * Use ui.dataSource to get reference to grid's data source. */ pagerRendered?: PagerRenderedEvent; @@ -43916,22 +51320,12 @@ interface JQuery { /** * Event fired before the page index is changed. * Return false in order to cancel page index changing. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridPaging. - * Use ui.owner.grid to get reference to the grid. - * Use ui.currentPageIndex to get current page index. - * Use ui.newPageIndex to get new page index. */ igGridPaging(optionLiteral: 'option', optionName: "pageIndexChanging"): PageIndexChangingEvent; /** * Event fired before the page index is changed. * Return false in order to cancel page index changing. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridPaging. - * Use ui.owner.grid to get reference to the grid. - * Use ui.currentPageIndex to get current page index. - * Use ui.newPageIndex to get new page index. * * @optionValue Define event handler function. */ @@ -43939,19 +51333,11 @@ interface JQuery { /** * Event fired after the page index is changed , but before grid data rebinds - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridPaging. - * Use ui.owner.grid to get reference to the grid. - * Use ui.pageIndex to get current page index. */ igGridPaging(optionLiteral: 'option', optionName: "pageIndexChanged"): PageIndexChangedEvent; /** * Event fired after the page index is changed , but before grid data rebinds - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridPaging. - * Use ui.owner.grid to get reference to the grid. - * Use ui.pageIndex to get current page index. * * @optionValue Define event handler function. */ @@ -43960,10 +51346,6 @@ interface JQuery { /** * Event fired when the page size is about to be changed from the page size dropdown. * Return false in order to cancel page size changing. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridPaging. - * Use ui.owner.grid to get reference to the grid. - * Use ui.currentPageSize to get current page size. * Use ui.newPageSize to get new page size. */ igGridPaging(optionLiteral: 'option', optionName: "pageSizeChanging"): PageSizeChangingEvent; @@ -43971,10 +51353,6 @@ interface JQuery { /** * Event fired when the page size is about to be changed from the page size dropdown. * Return false in order to cancel page size changing. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridPaging. - * Use ui.owner.grid to get reference to the grid. - * Use ui.currentPageSize to get current page size. * Use ui.newPageSize to get new page size. * * @optionValue Define event handler function. @@ -43983,19 +51361,11 @@ interface JQuery { /** * Event fired after the page size is changed from the page size dropdown. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridPaging. - * Use ui.owner.grid to get reference to the grid. - * Use ui.pageSize to get current page size. */ igGridPaging(optionLiteral: 'option', optionName: "pageSizeChanged"): PageSizeChangedEvent; /** * Event fired after the page size is changed from the page size dropdown. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridPaging. - * Use ui.owner.grid to get reference to the grid. - * Use ui.pageSize to get current page size. * * @optionValue Define event handler function. */ @@ -44003,21 +51373,13 @@ interface JQuery { /** * Event fired before the pager footer is rendered (the whole area below the grid records). - * Return false in order to cancel pager footer rendering. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridPaging. - * Use ui.owner.grid to get reference to the grid. - * Use ui.dataSource to get reference to grid's data source. + * Event fired after the page size is changed from the page size dropdown. */ igGridPaging(optionLiteral: 'option', optionName: "pagerRendering"): PagerRenderingEvent; /** * Event fired before the pager footer is rendered (the whole area below the grid records). - * Return false in order to cancel pager footer rendering. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridPaging. - * Use ui.owner.grid to get reference to the grid. - * Use ui.dataSource to get reference to grid's data source. + * Event fired after the page size is changed from the page size dropdown. * * @optionValue Define event handler function. */ @@ -44025,19 +51387,11 @@ interface JQuery { /** * Event fired after the pager footer is rendered - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridPaging. - * Use ui.owner.grid to get reference to the grid. - * Use ui.dataSource to get reference to grid's data source. */ igGridPaging(optionLiteral: 'option', optionName: "pagerRendered"): PagerRenderedEvent; /** * Event fired after the pager footer is rendered - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridPaging. - * Use ui.owner.grid to get reference to the grid. - * Use ui.dataSource to get reference to grid's data source. * * @optionValue Define event handler function. */ @@ -44090,25 +51444,6 @@ interface ColumnResizingEvent { } interface ColumnResizingEventUIParam { - /** - * Used to get the reference to the GridResizing widget. - */ - owner?: any; - - /** - * Used to get the resized column index. - */ - columnIndex?: any; - - /** - * Used to get the resized column key. - */ - columnKey?: any; - - /** - * Used to get the desired width(before min/max coercion) for the resized column. - */ - desiredWidth?: any; } interface ColumnResizingRefusedEvent { @@ -44116,25 +51451,6 @@ interface ColumnResizingRefusedEvent { } interface ColumnResizingRefusedEventUIParam { - /** - * Used to get the reference to the GridResizing widget. - */ - owner?: any; - - /** - * Used to get the resized column index. - */ - columnIndex?: any; - - /** - * Used to get the resized column key. - */ - columnKey?: any; - - /** - * Used to get the desired width(before min/max coercion) for the resized column. - */ - desiredWidth?: any; } interface ColumnResizedEvent { @@ -44142,30 +51458,6 @@ interface ColumnResizedEvent { } interface ColumnResizedEventUIParam { - /** - * Used to get the reference to the GridResizing widget. - */ - owner?: any; - - /** - * Used to get the resized column index. - */ - columnIndex?: any; - - /** - * Used to get the resized column key. - */ - columnKey?: any; - - /** - * Used to get the original column width. - */ - originalWidth?: any; - - /** - * Used to get the final column width after resizing. - */ - newWidth?: any; } interface IgGridResizing { @@ -44200,35 +51492,16 @@ interface IgGridResizing { /** * Event fired before a resizing operation is executed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridResizing widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the resized column index. - * Use ui.columnKey to get the resized column key. - * Use ui.desiredWidth to get the desired width(before min/max coercion) for the resized column. */ columnResizing?: ColumnResizingEvent; /** * Event fired(only when columnFixing is enabled) when trying to resize column in fixed area so total width of unfixed area to be less than minimalVisibleAreaWidth(option defined in columnFixing) - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridResizing widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the resized column index. - * Use ui.columnKey to get the resized column key. - * Use ui.desiredWidth to get the desired width(before min/max coercion) for the resized column. */ columnResizingRefused?: ColumnResizingRefusedEvent; /** * Event fired after the resizing has been executed and results are rendered - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridResizing widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the resized column index. - * Use ui.columnKey to get the resized column key. - * Use ui.originalWidth to get the original column width. - * Use ui.newWidth to get the final column width after resizing. */ columnResized?: ColumnResizedEvent; @@ -44329,23 +51602,11 @@ interface JQuery { /** * Event fired before a resizing operation is executed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridResizing widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the resized column index. - * Use ui.columnKey to get the resized column key. - * Use ui.desiredWidth to get the desired width(before min/max coercion) for the resized column. */ igGridResizing(optionLiteral: 'option', optionName: "columnResizing"): ColumnResizingEvent; /** * Event fired before a resizing operation is executed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridResizing widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the resized column index. - * Use ui.columnKey to get the resized column key. - * Use ui.desiredWidth to get the desired width(before min/max coercion) for the resized column. * * @optionValue Define event handler function. */ @@ -44353,23 +51614,11 @@ interface JQuery { /** * Event fired(only when columnFixing is enabled) when trying to resize column in fixed area so total width of unfixed area to be less than minimalVisibleAreaWidth(option defined in columnFixing) - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridResizing widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the resized column index. - * Use ui.columnKey to get the resized column key. - * Use ui.desiredWidth to get the desired width(before min/max coercion) for the resized column. */ igGridResizing(optionLiteral: 'option', optionName: "columnResizingRefused"): ColumnResizingRefusedEvent; /** * Event fired(only when columnFixing is enabled) when trying to resize column in fixed area so total width of unfixed area to be less than minimalVisibleAreaWidth(option defined in columnFixing) - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridResizing widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the resized column index. - * Use ui.columnKey to get the resized column key. - * Use ui.desiredWidth to get the desired width(before min/max coercion) for the resized column. * * @optionValue Define event handler function. */ @@ -44377,25 +51626,11 @@ interface JQuery { /** * Event fired after the resizing has been executed and results are rendered - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridResizing widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the resized column index. - * Use ui.columnKey to get the resized column key. - * Use ui.originalWidth to get the original column width. - * Use ui.newWidth to get the final column width after resizing. */ igGridResizing(optionLiteral: 'option', optionName: "columnResized"): ColumnResizedEvent; /** * Event fired after the resizing has been executed and results are rendered - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridResizing widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the resized column index. - * Use ui.columnKey to get the resized column key. - * Use ui.originalWidth to get the original column width. - * Use ui.newWidth to get the final column width after resizing. * * @optionValue Define event handler function. */ @@ -44479,20 +51714,6 @@ interface ResponsiveColumnHidingEvent { } interface ResponsiveColumnHidingEventUIParam { - /** - * Used to get the reference to the igGridResponsive widget. - */ - owner?: any; - - /** - * Used to get the hidden column index. Has a value only if the column's key is a number. - */ - columnIndex?: any; - - /** - * Used to get the hidden column key. Has a value only if the column's key is a string. - */ - columnKey?: any; } interface ResponsiveColumnHiddenEvent { @@ -44500,20 +51721,6 @@ interface ResponsiveColumnHiddenEvent { } interface ResponsiveColumnHiddenEventUIParam { - /** - * Used to get the reference to the igGridResponsive widget. - */ - owner?: any; - - /** - * Used to get the hidden column index. Has a value only if the column's key is a number. - */ - columnIndex?: any; - - /** - * Used to get the hidden column key. Has a value only if the column's key is a string. - */ - columnKey?: any; } interface ResponsiveColumnShowingEvent { @@ -44521,20 +51728,6 @@ interface ResponsiveColumnShowingEvent { } interface ResponsiveColumnShowingEventUIParam { - /** - * Used to get the reference to the igGridResponsive widget. - */ - owner?: any; - - /** - * Used to get the shown column index. Has a value only if the column's key is a number. - */ - columnIndex?: any; - - /** - * Used to get the shown column key. Has a value only if the column's key is a string. - */ - columnKey?: any; } interface ResponsiveColumnShownEvent { @@ -44542,20 +51735,6 @@ interface ResponsiveColumnShownEvent { } interface ResponsiveColumnShownEventUIParam { - /** - * Used to get the reference to the igGridResponsive widget. - */ - owner?: any; - - /** - * Used to get the shown column index. Has a value only if the column's key is a number. - */ - columnIndex?: any; - - /** - * Used to get the shown column key. Has a value only if the column's key is a string. - */ - columnKey?: any; } interface ResponsiveModeChangedEvent { @@ -44563,20 +51742,6 @@ interface ResponsiveModeChangedEvent { } interface ResponsiveModeChangedEventUIParam { - /** - * Used to get the reference to the igGridResponsive widget. - */ - owner?: any; - - /** - * Used to get the previously assumed mode. - */ - previousMode?: any; - - /** - * Used to get the newly assumed mode. - */ - mode?: any; } interface IgGridResponsive { @@ -44667,51 +51832,26 @@ interface IgGridResponsive { /** * Event fired before a hiding operation is executed on a collection of columns. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridResponsive widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.columnIndex to get the hidden column index. Has a value only if the column's key is a number. - * Use ui.columnKey to get the hidden column key. Has a value only if the column's key is a string. */ responsiveColumnHiding?: ResponsiveColumnHidingEvent; /** * Event fired after a hiding operation is executed on the collection of columns. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridResponsive widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.columnIndex to get the hidden column index. Has a value only if the column's key is a number. - * Use ui.columnKey to get the hidden column key. Has a value only if the column's key is a string. */ responsiveColumnHidden?: ResponsiveColumnHiddenEvent; /** * Event fired before a showing operation is executed on a collection of columns. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridResponsive widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.columnIndex to get the shown column index. Has a value only if the column's key is a number. - * Use ui.columnKey to get the shown column key. Has a value only if the column's key is a string. */ responsiveColumnShowing?: ResponsiveColumnShowingEvent; /** * Event fired after a showing operation is executed on the collection of columns. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridResponsive widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.columnIndex to get the shown column index. Has a value only if the column's key is a number. - * Use ui.columnKey to get the shown column key. Has a value only if the column's key is a string. */ responsiveColumnShown?: ResponsiveColumnShownEvent; /** * Event which is fired when the widget detects an environment change. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridResponsive widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.previousMode to get the previously assumed mode. - * Use ui.mode to get the newly assumed mode. */ responsiveModeChanged?: ResponsiveModeChangedEvent; @@ -44748,10 +51888,10 @@ interface ResponsiveModeSettings { } declare namespace Infragistics { - class ResponsiveMode { - constructor(settings: ResponsiveModeSettings); - isActive(): void; - } +class ResponsiveMode { + constructor(settings: ResponsiveModeSettings); + isActive(): void; +} } interface IgniteUIStatic { ResponsiveMode: typeof Infragistics.ResponsiveMode; @@ -44768,10 +51908,10 @@ interface InfragisticsModeSettings { } declare namespace Infragistics { - class InfragisticsMode { - constructor(settings: InfragisticsModeSettings); - isActive(): void; - } +class InfragisticsMode { + constructor(settings: InfragisticsModeSettings); + isActive(): void; +} } interface IgniteUIStatic { InfragisticsMode: typeof Infragistics.InfragisticsMode; @@ -44788,10 +51928,10 @@ interface BootstrapModeSettings { } declare namespace Infragistics { - class BootstrapMode { - constructor(settings: BootstrapModeSettings); - isActive(): void; - } +class BootstrapMode { + constructor(settings: BootstrapModeSettings); + isActive(): void; +} } interface IgniteUIStatic { BootstrapMode: typeof Infragistics.BootstrapMode; @@ -44971,21 +52111,11 @@ interface JQuery { /** * Event fired before a hiding operation is executed on a collection of columns. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridResponsive widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.columnIndex to get the hidden column index. Has a value only if the column's key is a number. - * Use ui.columnKey to get the hidden column key. Has a value only if the column's key is a string. */ igGridResponsive(optionLiteral: 'option', optionName: "responsiveColumnHiding"): ResponsiveColumnHidingEvent; /** * Event fired before a hiding operation is executed on a collection of columns. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridResponsive widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.columnIndex to get the hidden column index. Has a value only if the column's key is a number. - * Use ui.columnKey to get the hidden column key. Has a value only if the column's key is a string. * * @optionValue Define event handler function. */ @@ -44993,21 +52123,11 @@ interface JQuery { /** * Event fired after a hiding operation is executed on the collection of columns. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridResponsive widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.columnIndex to get the hidden column index. Has a value only if the column's key is a number. - * Use ui.columnKey to get the hidden column key. Has a value only if the column's key is a string. */ igGridResponsive(optionLiteral: 'option', optionName: "responsiveColumnHidden"): ResponsiveColumnHiddenEvent; /** * Event fired after a hiding operation is executed on the collection of columns. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridResponsive widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.columnIndex to get the hidden column index. Has a value only if the column's key is a number. - * Use ui.columnKey to get the hidden column key. Has a value only if the column's key is a string. * * @optionValue Define event handler function. */ @@ -45015,21 +52135,11 @@ interface JQuery { /** * Event fired before a showing operation is executed on a collection of columns. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridResponsive widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.columnIndex to get the shown column index. Has a value only if the column's key is a number. - * Use ui.columnKey to get the shown column key. Has a value only if the column's key is a string. */ igGridResponsive(optionLiteral: 'option', optionName: "responsiveColumnShowing"): ResponsiveColumnShowingEvent; /** * Event fired before a showing operation is executed on a collection of columns. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridResponsive widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.columnIndex to get the shown column index. Has a value only if the column's key is a number. - * Use ui.columnKey to get the shown column key. Has a value only if the column's key is a string. * * @optionValue Define event handler function. */ @@ -45037,21 +52147,11 @@ interface JQuery { /** * Event fired after a showing operation is executed on the collection of columns. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridResponsive widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.columnIndex to get the shown column index. Has a value only if the column's key is a number. - * Use ui.columnKey to get the shown column key. Has a value only if the column's key is a string. */ igGridResponsive(optionLiteral: 'option', optionName: "responsiveColumnShown"): ResponsiveColumnShownEvent; /** * Event fired after a showing operation is executed on the collection of columns. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridResponsive widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.columnIndex to get the shown column index. Has a value only if the column's key is a number. - * Use ui.columnKey to get the shown column key. Has a value only if the column's key is a string. * * @optionValue Define event handler function. */ @@ -45059,21 +52159,11 @@ interface JQuery { /** * Event which is fired when the widget detects an environment change. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridResponsive widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.previousMode to get the previously assumed mode. - * Use ui.mode to get the newly assumed mode. */ igGridResponsive(optionLiteral: 'option', optionName: "responsiveModeChanged"): ResponsiveModeChangedEvent; /** * Event which is fired when the widget detects an environment change. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridResponsive widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * Use ui.previousMode to get the previously assumed mode. - * Use ui.mode to get the newly assumed mode. * * @optionValue Define event handler function. */ @@ -45089,40 +52179,6 @@ interface RowSelectorClickedEvent { } interface RowSelectorClickedEventUIParam { - /** - * Used to get reference to the row the clicked row selector resides in. - */ - row?: any; - - /** - * Used to get reference to the fixed row the clicked row selector resides in(if there are fixed columns). - */ - fixedRow?: any; - - /** - * Used to get the index of the row the clicked row selector resides in. - */ - rowIndex?: any; - - /** - * Used to get the key of the row the clicked row selector resides in. - */ - rowKey?: any; - - /** - * Used tor to get reference to the row selector cell. - */ - rowSelector?: any; - - /** - * Used to get reference to RowSelectors. - */ - owner?: any; - - /** - * Used to get reference to the grid the RowSelectors are initialized for. - */ - grid?: any; } interface CheckBoxStateChangingEvent { @@ -45130,50 +52186,6 @@ interface CheckBoxStateChangingEvent { } interface CheckBoxStateChangingEventUIParam { - /** - * Used to get reference to the row the clicked row selector resides in. - */ - row?: any; - - /** - * Used to get the index of the row the clicked row selector resides in. - */ - rowIndex?: any; - - /** - * Used to get the key of the row the clicked row selector resides in. - */ - rowKey?: any; - - /** - * Used tor to get reference to the row selector cell. - */ - rowSelector?: any; - - /** - * Used to get reference to igRowSelectors. - */ - owner?: any; - - /** - * Used to get reference to the grid the RowSelectors are initialized for. - */ - grid?: any; - - /** - * Used to get the current state of the checkbox ("on","off"). - */ - currentState?: any; - - /** - * Used to get the new state of the checkbox ("on","off"). - */ - newState?: any; - - /** - * Used to check if the header check box is the one being clicked. In this case no row related args are passed. - */ - isHeader?: any; } interface CheckBoxStateChangedEvent { @@ -45181,45 +52193,6 @@ interface CheckBoxStateChangedEvent { } interface CheckBoxStateChangedEventUIParam { - /** - * Used to get reference to the row the clicked row selector resides in. - */ - row?: any; - - /** - * Used to get the index of the row the clicked row selector resides in. - */ - rowIndex?: any; - - /** - * Used to get the key of the row the clicked row selector resides in. - */ - rowKey?: any; - - /** - * Used tor to get reference to the row selector cell. - */ - rowSelector?: any; - - /** - * Used to get reference to igRowSelectors. - */ - owner?: any; - - /** - * Used to get reference to the grid the RowSelectors are initialized for. - */ - grid?: any; - - /** - * Used to get the state of the checkbox ("on","off"). - */ - state?: any; - - /** - * Used to check if the header check box is the one being clicked. In this case no row related args are passed. - */ - isHeader?: any; } interface IgGridRowSelectors { @@ -45242,6 +52215,7 @@ interface IgGridRowSelectors { rowNumberingSeed?: number; /** + * defines width of the row selector`s column in pixels or percentage. * * * Valid values: @@ -45298,43 +52272,16 @@ interface IgGridRowSelectors { /** * Event fired after a row selector is clicked. - * Function takes arguments evt and ui. - * Use ui.row to get reference to the row the clicked row selector resides in. - * Use ui.fixedRow to get reference to the fixed row the clicked row selector resides in(if there are fixed columns). - * Use ui.rowIndex to get the index of the row the clicked row selector resides in. - * Use ui.rowKey to get the key of the row the clicked row selector resides in. - * Use ui.rowSelector to get reference to the row selector cell. - * Use ui.owner to get reference to RowSelectors. - * Use ui.grid to get reference to the grid the RowSelectors are initialized for. */ rowSelectorClicked?: RowSelectorClickedEvent; /** * Event fired when a row selector checkbox is changing. - * Function takes arguments evt and ui. - * Use ui.row to get reference to the row the clicked row selector resides in. - * Use ui.rowIndex to get the index of the row the clicked row selector resides in. - * Use ui.rowKey to get the key of the row the clicked row selector resides in. - * Use ui.rowSelector to get reference to the row selector cell. - * Use ui.owner to get reference to igRowSelectors. - * Use ui.grid to get reference to the grid the RowSelectors are initialized for. - * Use ui.currentState to get the current state of the checkbox ("on","off"). - * Use ui.newState to get the new state of the checkbox ("on","off"). - * Use ui.isHeader to check if the header check box is the one being clicked. In this case no row related args are passed. */ checkBoxStateChanging?: CheckBoxStateChangingEvent; /** * Event fired after a row selector checkbox had changed state. - * Function takes arguments evt and ui. - * Use ui.row to get reference to the row the clicked row selector resides in. - * Use ui.rowIndex to get the index of the row the clicked row selector resides in. - * Use ui.rowKey to get the key of the row the clicked row selector resides in. - * Use ui.rowSelector to get reference to the row selector cell. - * Use ui.owner to get reference to igRowSelectors. - * Use ui.grid to get reference to the grid the RowSelectors are initialized for. - * Use ui.state to get the state of the checkbox ("on","off"). - * Use ui.isHeader to check if the header check box is the one being clicked. In this case no row related args are passed. */ checkBoxStateChanged?: CheckBoxStateChangedEvent; @@ -45396,12 +52343,14 @@ interface JQuery { igGridRowSelectors(optionLiteral: 'option', optionName: "rowNumberingSeed", optionValue: number): void; /** - * * + * Defines width of the row selector`s column in pixels or percentage. + * */ igGridRowSelectors(optionLiteral: 'option', optionName: "rowSelectorColumnWidth"): string|number; /** - * * + * Defines width of the row selector`s column in pixels or percentage. + * * * @optionValue New value to be set. */ @@ -45511,27 +52460,11 @@ interface JQuery { /** * Event fired after a row selector is clicked. - * Function takes arguments evt and ui. - * Use ui.row to get reference to the row the clicked row selector resides in. - * Use ui.fixedRow to get reference to the fixed row the clicked row selector resides in(if there are fixed columns). - * Use ui.rowIndex to get the index of the row the clicked row selector resides in. - * Use ui.rowKey to get the key of the row the clicked row selector resides in. - * Use ui.rowSelector to get reference to the row selector cell. - * Use ui.owner to get reference to RowSelectors. - * Use ui.grid to get reference to the grid the RowSelectors are initialized for. */ igGridRowSelectors(optionLiteral: 'option', optionName: "rowSelectorClicked"): RowSelectorClickedEvent; /** * Event fired after a row selector is clicked. - * Function takes arguments evt and ui. - * Use ui.row to get reference to the row the clicked row selector resides in. - * Use ui.fixedRow to get reference to the fixed row the clicked row selector resides in(if there are fixed columns). - * Use ui.rowIndex to get the index of the row the clicked row selector resides in. - * Use ui.rowKey to get the key of the row the clicked row selector resides in. - * Use ui.rowSelector to get reference to the row selector cell. - * Use ui.owner to get reference to RowSelectors. - * Use ui.grid to get reference to the grid the RowSelectors are initialized for. * * @optionValue Define event handler function. */ @@ -45539,31 +52472,11 @@ interface JQuery { /** * Event fired when a row selector checkbox is changing. - * Function takes arguments evt and ui. - * Use ui.row to get reference to the row the clicked row selector resides in. - * Use ui.rowIndex to get the index of the row the clicked row selector resides in. - * Use ui.rowKey to get the key of the row the clicked row selector resides in. - * Use ui.rowSelector to get reference to the row selector cell. - * Use ui.owner to get reference to igRowSelectors. - * Use ui.grid to get reference to the grid the RowSelectors are initialized for. - * Use ui.currentState to get the current state of the checkbox ("on","off"). - * Use ui.newState to get the new state of the checkbox ("on","off"). - * Use ui.isHeader to check if the header check box is the one being clicked. In this case no row related args are passed. */ igGridRowSelectors(optionLiteral: 'option', optionName: "checkBoxStateChanging"): CheckBoxStateChangingEvent; /** * Event fired when a row selector checkbox is changing. - * Function takes arguments evt and ui. - * Use ui.row to get reference to the row the clicked row selector resides in. - * Use ui.rowIndex to get the index of the row the clicked row selector resides in. - * Use ui.rowKey to get the key of the row the clicked row selector resides in. - * Use ui.rowSelector to get reference to the row selector cell. - * Use ui.owner to get reference to igRowSelectors. - * Use ui.grid to get reference to the grid the RowSelectors are initialized for. - * Use ui.currentState to get the current state of the checkbox ("on","off"). - * Use ui.newState to get the new state of the checkbox ("on","off"). - * Use ui.isHeader to check if the header check box is the one being clicked. In this case no row related args are passed. * * @optionValue Define event handler function. */ @@ -45571,29 +52484,11 @@ interface JQuery { /** * Event fired after a row selector checkbox had changed state. - * Function takes arguments evt and ui. - * Use ui.row to get reference to the row the clicked row selector resides in. - * Use ui.rowIndex to get the index of the row the clicked row selector resides in. - * Use ui.rowKey to get the key of the row the clicked row selector resides in. - * Use ui.rowSelector to get reference to the row selector cell. - * Use ui.owner to get reference to igRowSelectors. - * Use ui.grid to get reference to the grid the RowSelectors are initialized for. - * Use ui.state to get the state of the checkbox ("on","off"). - * Use ui.isHeader to check if the header check box is the one being clicked. In this case no row related args are passed. */ igGridRowSelectors(optionLiteral: 'option', optionName: "checkBoxStateChanged"): CheckBoxStateChangedEvent; /** * Event fired after a row selector checkbox had changed state. - * Function takes arguments evt and ui. - * Use ui.row to get reference to the row the clicked row selector resides in. - * Use ui.rowIndex to get the index of the row the clicked row selector resides in. - * Use ui.rowKey to get the key of the row the clicked row selector resides in. - * Use ui.rowSelector to get reference to the row selector cell. - * Use ui.owner to get reference to igRowSelectors. - * Use ui.grid to get reference to the grid the RowSelectors are initialized for. - * Use ui.state to get the state of the checkbox ("on","off"). - * Use ui.isHeader to check if the header check box is the one being clicked. In this case no row related args are passed. * * @optionValue Define event handler function. */ @@ -45609,30 +52504,6 @@ interface RowSelectionChangingEvent { } interface RowSelectionChangingEventUIParam { - /** - * Used to get reference to GridSelection. - */ - owner?: any; - - /** - * Used to get reference to row object. - */ - row?: any; - - /** - * Used to get reference to rows object array. - */ - selectedRows?: any; - - /** - * Used to get the start index for a range row selection. - */ - startIndex?: any; - - /** - * Used to get the end index for a range row selection. - */ - endIndex?: any; } interface RowSelectionChangedEvent { @@ -45640,20 +52511,6 @@ interface RowSelectionChangedEvent { } interface RowSelectionChangedEventUIParam { - /** - * Used to get reference to GridSelection. - */ - owner?: any; - - /** - * Used to get reference to row object. - */ - row?: any; - - /** - * Used to get reference to rows object array. - */ - selectedRows?: any; } interface CellSelectionChangingEvent { @@ -45661,40 +52518,6 @@ interface CellSelectionChangingEvent { } interface CellSelectionChangingEventUIParam { - /** - * Used to get reference to GridSelection. - */ - owner?: any; - - /** - * Used to get reference to cell object. - */ - cell?: any; - - /** - * Used to get reference to selected cells object array. - */ - selectedCells?: any; - - /** - * Used to get the column index for the first cell in a range selection. - */ - firstColumnIndex?: any; - - /** - * Used to get the row index for the first cell in a range selection. - */ - firstRowIndex?: any; - - /** - * Used to get the column index for the last cell in a range selection. - */ - lastColumnIndex?: any; - - /** - * Used to get the row index for the last cell in a range selection. - */ - lastRowIndex?: any; } interface CellSelectionChangedEvent { @@ -45702,20 +52525,6 @@ interface CellSelectionChangedEvent { } interface CellSelectionChangedEventUIParam { - /** - * Used to get reference to GridSelection. - */ - owner?: any; - - /** - * Used to get reference to cell object. - */ - cell?: any; - - /** - * Used to get reference to selected cells object array. - */ - selectedCells?: any; } interface ActiveCellChangingEvent { @@ -45723,15 +52532,6 @@ interface ActiveCellChangingEvent { } interface ActiveCellChangingEventUIParam { - /** - * Used to get reference to GridSelection. - */ - owner?: any; - - /** - * Used to get reference to cell object. - */ - cell?: any; } interface ActiveCellChangedEvent { @@ -45739,15 +52539,6 @@ interface ActiveCellChangedEvent { } interface ActiveCellChangedEventUIParam { - /** - * Used to get reference to GridSelection. - */ - owner?: any; - - /** - * Used to get reference to cell object. - */ - cell?: any; } interface ActiveRowChangingEvent { @@ -45755,15 +52546,6 @@ interface ActiveRowChangingEvent { } interface ActiveRowChangingEventUIParam { - /** - * Used to get reference to GridSelection. - */ - owner?: any; - - /** - * Used to get reference to row object. - */ - row?: any; } interface ActiveRowChangedEvent { @@ -45771,15 +52553,6 @@ interface ActiveRowChangedEvent { } interface ActiveRowChangedEventUIParam { - /** - * Used to get reference to GridSelection. - */ - owner?: any; - - /** - * Used to get reference to row object. - */ - row?: any; } interface IgGridSelection { @@ -45850,122 +52623,44 @@ interface IgGridSelection { /** * Event fired before row(s) are about to be selected (cancellable). * Return false in order to cancel selection changing. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.row to get reference to row object. - * Use ui.row.element to get reference to row DOM element. - * Use ui.row.index to get row index. - * Use ui.row.id to get the row id if primary key is defined or persistence is enabled. - * Use ui.selectedRows to get reference to rows object array. - * Use ui.startIndex to get the start index for a range row selection. - * Use ui.endIndex to get the end index for a range row selection. */ rowSelectionChanging?: RowSelectionChangingEvent; /** * Event fired after row(s) are selected. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.row to get reference to row object. - * Use ui.row.element to get reference to row DOM element. - * Use ui.row.index to get row index. - * Use ui.row.id to get the row id if primary key is defined or persistence is enabled. - * Use ui.selectedRows to get reference to rows object array. */ rowSelectionChanged?: RowSelectionChangedEvent; /** * Event fired before cell(s) are about to be selected (cancellable). * Return false in order to cancel cell selection changing. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.cell to get reference to cell object. - * Use ui.cell.element to get reference to cell DOM element. - * Use ui.cell.columnKey to get reference to column key. - * Use ui.cell.rowId to get the row id if primary key is defined or persistence is enabled. - * Use ui.cell.index to get column index. - * Use ui.cell.row to get reference to row DOM element. - * Use ui.cell.rowIndex to get row index. - * Use ui.selectedCells to get reference to selected cells object array. - * Use ui.firstColumnIndex to get the column index for the first cell in a range selection. - * Use ui.firstRowIndex to get the row index for the first cell in a range selection. - * Use ui.lastColumnIndex to get the column index for the last cell in a range selection. - * Use ui.lastRowIndex to get the row index for the last cell in a range selection. */ cellSelectionChanging?: CellSelectionChangingEvent; /** * Event fired after cell(s) are selected. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.cell to get reference to cell object. - * Use ui.cell.element to get reference to cell DOM element. - * Use ui.cell.columnKey to get reference to column key. - * Use ui.cell.rowId to get the row id if primary key is defined or persistence is enabled. - * Use ui.cell.index to get column index. - * Use ui.cell.row to get reference to row DOM element. - * Use ui.cell.rowIndex to get row index. - * Use ui.selectedCells to get reference to selected cells object array. */ cellSelectionChanged?: CellSelectionChangedEvent; /** * Event fired before a cell becomes active (focus style applied) (cancellable). * Return false in order to cancel active cell changing. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.cell to get reference to cell object. - * Use ui.cell.element to get reference to cell DOM element. - * Use ui.cell.columnKey to get column key. - * Use ui.cell.rowId to get the row id if primary key is defined or persistence is enabled. - * Use ui.cell.index to get column index. - * Use ui.cell.row to get reference to row DOM element. - * Use ui.cell.rowIndex to get row index. */ activeCellChanging?: ActiveCellChangingEvent; /** * Event fired after a cell becomes active (focus style applied). - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.cell to get reference to cell object. - * Use ui.cell.element to get reference to cell DOM element. - * Use ui.cell.columnKey to get column key. - * Use ui.cell.rowId to get the row id if primary key is defined or persistence is enabled. - * Use ui.cell.index to get column index. - * Use ui.cell.row to get reference to row DOM element. - * Use ui.cell.rowIndex to get row index. */ activeCellChanged?: ActiveCellChangedEvent; /** * Event fired before a row becomes active (focus style applied) (cancellable). * Return false in order to cancel active row changing. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.row to get reference to row object. - * Use ui.row.element to get reference to active row DOM element. - * Use ui.row.index to get active row index. - * Use ui.row.id to get the active row id if primary key is defined or persistence is enabled. */ activeRowChanging?: ActiveRowChangingEvent; /** * Event fired after a row becomes active (focus style applied). - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.row to get reference to row object. - * Use ui.row.element to get reference to active row DOM element. - * Use ui.row.index to get active row index. - * Use ui.row.id to get the active row id if primary key is defined or persistence is enabled. */ activeRowChanged?: ActiveRowChangedEvent; @@ -46050,28 +52745,28 @@ interface IgGridSelectionMethods { /** * Returns an array of selected cells in arbitrary order where every objects has the format { element: , row: , index: , rowIndex: , columnKey: } . * - * If multiple selection is disabled the function will return null. + * If multiple selection is disabled the function will return null. */ selectedCells(): any[]; /** * Returns an array of selected rows in arbitrary order where every object has the format { element: , index: } . * - * If multiple selection is disabled the function will return null. + * If multiple selection is disabled the function will return null. */ selectedRows(): any[]; /** * Returns the currently selected cell that has the format { element: , row: , index: , rowIndex: , columnKey: }, if any. * - * If multiple selection is enabled the function will return null. + * If multiple selection is enabled the function will return null. */ selectedCell(): Object; /** * Returns the currently selected row that has the format { element: , index: }, if any. * - * If multiple selection is enabled the function will return null. + * If multiple selection is enabled the function will return null. */ selectedRow(): Object; @@ -46108,93 +52803,93 @@ interface SelectionCollectionSettings { } declare namespace Infragistics { - class SelectionCollection { - constructor(settings: SelectionCollectionSettings); - addSubscriber(subscriber: Object, owner: Object): void; - removeSubscriber(subscriberId: Object, owner: Object): void; - changeOwner(newOwner: Object): void; - isSelected(identifier: Object, forOwner: Object): void; - isActive(identifier: Object, forOwner: Object): void; - elementFromIdentifier(identifier: Object): void; - toggle(element: Object): void; - activate(identifier: Object, element: Object, suppress: Object): void; - deactivate(suppress: Object): void; - select(identifier: Object, add: Object, info: Object, suppress: Object): void; - rangeSelect(range: Object, add: Object, prevRange: Object, info: Object, suppress: Object): void; - rangeDeselect(range: Object, info: Object, suppress: Object): void; - deselect(identifier: Object, info: Object, suppress: Object): void; - deselectAll(suppress: Object): void; - clearSelection(forOwner: Object): void; - cleanAll(forOwner: Object): void; - onlyOneSelected(): void; - selectedCells(): void; - selectedRows(): void; - selectionLength(): void; - } +class SelectionCollection { + constructor(settings: SelectionCollectionSettings); + addSubscriber(subscriber: Object, owner: Object): void; + removeSubscriber(subscriberId: Object, owner: Object): void; + changeOwner(newOwner: Object): void; + isSelected(identifier: Object, forOwner: Object): void; + isActive(identifier: Object, forOwner: Object): void; + elementFromIdentifier(identifier: Object): void; + toggle(element: Object): void; + activate(identifier: Object, element: Object, suppress: Object): void; + deactivate(suppress: Object): void; + select(identifier: Object, add: Object, info: Object, suppress: Object): void; + rangeSelect(range: Object, add: Object, prevRange: Object, info: Object, suppress: Object): void; + rangeDeselect(range: Object, info: Object, suppress: Object): void; + deselect(identifier: Object, info: Object, suppress: Object): void; + deselectAll(suppress: Object): void; + clearSelection(forOwner: Object): void; + cleanAll(forOwner: Object): void; + onlyOneSelected(): void; + selectedCells(): void; + selectedRows(): void; + selectionLength(): void; +} } interface IgniteUIStatic { SelectionCollection: typeof Infragistics.SelectionCollection; } declare namespace Infragistics { - class SelectedRowsCollection { - constructor(settings: SelectionCollectionSettings); - isSelected(identifier: Object, forOwner: Object): void; - isActive(identifier: Object, forOwner: Object): void; - selectedDataRows(): void; - selectedRows(): void; - activeRow(): void; - elementFromIdentifier(identifier: Object): void; - elementPosition(identifier: Object, element: Object): void; - onlyOneSelected(): void; - addSubscriber(subscriber: Object, owner: Object): void; - removeSubscriber(subscriberId: Object, owner: Object): void; - changeOwner(newOwner: Object): void; - toggle(element: Object): void; - activate(identifier: Object, element: Object, suppress: Object): void; - deactivate(suppress: Object): void; - select(identifier: Object, add: Object, info: Object, suppress: Object): void; - rangeSelect(range: Object, add: Object, prevRange: Object, info: Object, suppress: Object): void; - rangeDeselect(range: Object, info: Object, suppress: Object): void; - deselect(identifier: Object, info: Object, suppress: Object): void; - deselectAll(suppress: Object): void; - clearSelection(forOwner: Object): void; - cleanAll(forOwner: Object): void; - selectedCells(): void; - selectionLength(): void; - } +class SelectedRowsCollection { + constructor(settings: SelectionCollectionSettings); + isSelected(identifier: Object, forOwner: Object): void; + isActive(identifier: Object, forOwner: Object): void; + selectedDataRows(): void; + selectedRows(): void; + activeRow(): void; + elementFromIdentifier(identifier: Object): void; + elementPosition(identifier: Object, element: Object): void; + onlyOneSelected(): void; + addSubscriber(subscriber: Object, owner: Object): void; + removeSubscriber(subscriberId: Object, owner: Object): void; + changeOwner(newOwner: Object): void; + toggle(element: Object): void; + activate(identifier: Object, element: Object, suppress: Object): void; + deactivate(suppress: Object): void; + select(identifier: Object, add: Object, info: Object, suppress: Object): void; + rangeSelect(range: Object, add: Object, prevRange: Object, info: Object, suppress: Object): void; + rangeDeselect(range: Object, info: Object, suppress: Object): void; + deselect(identifier: Object, info: Object, suppress: Object): void; + deselectAll(suppress: Object): void; + clearSelection(forOwner: Object): void; + cleanAll(forOwner: Object): void; + selectedCells(): void; + selectionLength(): void; +} } interface IgniteUIStatic { SelectedRowsCollection: typeof Infragistics.SelectedRowsCollection; } declare namespace Infragistics { - class SelectedCellsCollection { - constructor(settings: SelectionCollectionSettings); - isSelected(identifier: Object, forOwner: Object): void; - atLeastOneSelected(rowId: Object, forOwner: Object): void; - isActive(identifier: Object, forOwner: Object): void; - selectedCells(): void; - activeCell(): void; - elementFromIdentifier(identifier: Object): void; - elementPosition(identifier: Object, element: Object): void; - onlyOneSelected(): void; - addSubscriber(subscriber: Object, owner: Object): void; - removeSubscriber(subscriberId: Object, owner: Object): void; - changeOwner(newOwner: Object): void; - toggle(element: Object): void; - activate(identifier: Object, element: Object, suppress: Object): void; - deactivate(suppress: Object): void; - select(identifier: Object, add: Object, info: Object, suppress: Object): void; - rangeSelect(range: Object, add: Object, prevRange: Object, info: Object, suppress: Object): void; - rangeDeselect(range: Object, info: Object, suppress: Object): void; - deselect(identifier: Object, info: Object, suppress: Object): void; - deselectAll(suppress: Object): void; - clearSelection(forOwner: Object): void; - cleanAll(forOwner: Object): void; - selectedRows(): void; - selectionLength(): void; - } +class SelectedCellsCollection { + constructor(settings: SelectionCollectionSettings); + isSelected(identifier: Object, forOwner: Object): void; + atLeastOneSelected(rowId: Object, forOwner: Object): void; + isActive(identifier: Object, forOwner: Object): void; + selectedCells(): void; + activeCell(): void; + elementFromIdentifier(identifier: Object): void; + elementPosition(identifier: Object, element: Object): void; + onlyOneSelected(): void; + addSubscriber(subscriber: Object, owner: Object): void; + removeSubscriber(subscriberId: Object, owner: Object): void; + changeOwner(newOwner: Object): void; + toggle(element: Object): void; + activate(identifier: Object, element: Object, suppress: Object): void; + deactivate(suppress: Object): void; + select(identifier: Object, add: Object, info: Object, suppress: Object): void; + rangeSelect(range: Object, add: Object, prevRange: Object, info: Object, suppress: Object): void; + rangeDeselect(range: Object, info: Object, suppress: Object): void; + deselect(identifier: Object, info: Object, suppress: Object): void; + deselectAll(suppress: Object): void; + clearSelection(forOwner: Object): void; + cleanAll(forOwner: Object): void; + selectedRows(): void; + selectionLength(): void; +} } interface IgniteUIStatic { SelectedCellsCollection: typeof Infragistics.SelectedCellsCollection; @@ -46361,32 +53056,12 @@ interface JQuery { /** * Event fired before row(s) are about to be selected (cancellable). * Return false in order to cancel selection changing. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.row to get reference to row object. - * Use ui.row.element to get reference to row DOM element. - * Use ui.row.index to get row index. - * Use ui.row.id to get the row id if primary key is defined or persistence is enabled. - * Use ui.selectedRows to get reference to rows object array. - * Use ui.startIndex to get the start index for a range row selection. - * Use ui.endIndex to get the end index for a range row selection. */ igGridSelection(optionLiteral: 'option', optionName: "rowSelectionChanging"): RowSelectionChangingEvent; /** * Event fired before row(s) are about to be selected (cancellable). * Return false in order to cancel selection changing. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.row to get reference to row object. - * Use ui.row.element to get reference to row DOM element. - * Use ui.row.index to get row index. - * Use ui.row.id to get the row id if primary key is defined or persistence is enabled. - * Use ui.selectedRows to get reference to rows object array. - * Use ui.startIndex to get the start index for a range row selection. - * Use ui.endIndex to get the end index for a range row selection. * * @optionValue Define event handler function. */ @@ -46394,27 +53069,11 @@ interface JQuery { /** * Event fired after row(s) are selected. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.row to get reference to row object. - * Use ui.row.element to get reference to row DOM element. - * Use ui.row.index to get row index. - * Use ui.row.id to get the row id if primary key is defined or persistence is enabled. - * Use ui.selectedRows to get reference to rows object array. */ igGridSelection(optionLiteral: 'option', optionName: "rowSelectionChanged"): RowSelectionChangedEvent; /** * Event fired after row(s) are selected. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.row to get reference to row object. - * Use ui.row.element to get reference to row DOM element. - * Use ui.row.index to get row index. - * Use ui.row.id to get the row id if primary key is defined or persistence is enabled. - * Use ui.selectedRows to get reference to rows object array. * * @optionValue Define event handler function. */ @@ -46423,42 +53082,12 @@ interface JQuery { /** * Event fired before cell(s) are about to be selected (cancellable). * Return false in order to cancel cell selection changing. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.cell to get reference to cell object. - * Use ui.cell.element to get reference to cell DOM element. - * Use ui.cell.columnKey to get reference to column key. - * Use ui.cell.rowId to get the row id if primary key is defined or persistence is enabled. - * Use ui.cell.index to get column index. - * Use ui.cell.row to get reference to row DOM element. - * Use ui.cell.rowIndex to get row index. - * Use ui.selectedCells to get reference to selected cells object array. - * Use ui.firstColumnIndex to get the column index for the first cell in a range selection. - * Use ui.firstRowIndex to get the row index for the first cell in a range selection. - * Use ui.lastColumnIndex to get the column index for the last cell in a range selection. - * Use ui.lastRowIndex to get the row index for the last cell in a range selection. */ igGridSelection(optionLiteral: 'option', optionName: "cellSelectionChanging"): CellSelectionChangingEvent; /** * Event fired before cell(s) are about to be selected (cancellable). * Return false in order to cancel cell selection changing. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.cell to get reference to cell object. - * Use ui.cell.element to get reference to cell DOM element. - * Use ui.cell.columnKey to get reference to column key. - * Use ui.cell.rowId to get the row id if primary key is defined or persistence is enabled. - * Use ui.cell.index to get column index. - * Use ui.cell.row to get reference to row DOM element. - * Use ui.cell.rowIndex to get row index. - * Use ui.selectedCells to get reference to selected cells object array. - * Use ui.firstColumnIndex to get the column index for the first cell in a range selection. - * Use ui.firstRowIndex to get the row index for the first cell in a range selection. - * Use ui.lastColumnIndex to get the column index for the last cell in a range selection. - * Use ui.lastRowIndex to get the row index for the last cell in a range selection. * * @optionValue Define event handler function. */ @@ -46466,33 +53095,11 @@ interface JQuery { /** * Event fired after cell(s) are selected. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.cell to get reference to cell object. - * Use ui.cell.element to get reference to cell DOM element. - * Use ui.cell.columnKey to get reference to column key. - * Use ui.cell.rowId to get the row id if primary key is defined or persistence is enabled. - * Use ui.cell.index to get column index. - * Use ui.cell.row to get reference to row DOM element. - * Use ui.cell.rowIndex to get row index. - * Use ui.selectedCells to get reference to selected cells object array. */ igGridSelection(optionLiteral: 'option', optionName: "cellSelectionChanged"): CellSelectionChangedEvent; /** * Event fired after cell(s) are selected. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.cell to get reference to cell object. - * Use ui.cell.element to get reference to cell DOM element. - * Use ui.cell.columnKey to get reference to column key. - * Use ui.cell.rowId to get the row id if primary key is defined or persistence is enabled. - * Use ui.cell.index to get column index. - * Use ui.cell.row to get reference to row DOM element. - * Use ui.cell.rowIndex to get row index. - * Use ui.selectedCells to get reference to selected cells object array. * * @optionValue Define event handler function. */ @@ -46501,32 +53108,12 @@ interface JQuery { /** * Event fired before a cell becomes active (focus style applied) (cancellable). * Return false in order to cancel active cell changing. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.cell to get reference to cell object. - * Use ui.cell.element to get reference to cell DOM element. - * Use ui.cell.columnKey to get column key. - * Use ui.cell.rowId to get the row id if primary key is defined or persistence is enabled. - * Use ui.cell.index to get column index. - * Use ui.cell.row to get reference to row DOM element. - * Use ui.cell.rowIndex to get row index. */ igGridSelection(optionLiteral: 'option', optionName: "activeCellChanging"): ActiveCellChangingEvent; /** * Event fired before a cell becomes active (focus style applied) (cancellable). * Return false in order to cancel active cell changing. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.cell to get reference to cell object. - * Use ui.cell.element to get reference to cell DOM element. - * Use ui.cell.columnKey to get column key. - * Use ui.cell.rowId to get the row id if primary key is defined or persistence is enabled. - * Use ui.cell.index to get column index. - * Use ui.cell.row to get reference to row DOM element. - * Use ui.cell.rowIndex to get row index. * * @optionValue Define event handler function. */ @@ -46534,31 +53121,11 @@ interface JQuery { /** * Event fired after a cell becomes active (focus style applied). - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.cell to get reference to cell object. - * Use ui.cell.element to get reference to cell DOM element. - * Use ui.cell.columnKey to get column key. - * Use ui.cell.rowId to get the row id if primary key is defined or persistence is enabled. - * Use ui.cell.index to get column index. - * Use ui.cell.row to get reference to row DOM element. - * Use ui.cell.rowIndex to get row index. */ igGridSelection(optionLiteral: 'option', optionName: "activeCellChanged"): ActiveCellChangedEvent; /** * Event fired after a cell becomes active (focus style applied). - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.cell to get reference to cell object. - * Use ui.cell.element to get reference to cell DOM element. - * Use ui.cell.columnKey to get column key. - * Use ui.cell.rowId to get the row id if primary key is defined or persistence is enabled. - * Use ui.cell.index to get column index. - * Use ui.cell.row to get reference to row DOM element. - * Use ui.cell.rowIndex to get row index. * * @optionValue Define event handler function. */ @@ -46567,26 +53134,12 @@ interface JQuery { /** * Event fired before a row becomes active (focus style applied) (cancellable). * Return false in order to cancel active row changing. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.row to get reference to row object. - * Use ui.row.element to get reference to active row DOM element. - * Use ui.row.index to get active row index. - * Use ui.row.id to get the active row id if primary key is defined or persistence is enabled. */ igGridSelection(optionLiteral: 'option', optionName: "activeRowChanging"): ActiveRowChangingEvent; /** * Event fired before a row becomes active (focus style applied) (cancellable). * Return false in order to cancel active row changing. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.row to get reference to row object. - * Use ui.row.element to get reference to active row DOM element. - * Use ui.row.index to get active row index. - * Use ui.row.id to get the active row id if primary key is defined or persistence is enabled. * * @optionValue Define event handler function. */ @@ -46594,25 +53147,11 @@ interface JQuery { /** * Event fired after a row becomes active (focus style applied). - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.row to get reference to row object. - * Use ui.row.element to get reference to active row DOM element. - * Use ui.row.index to get active row index. - * Use ui.row.id to get the active row id if primary key is defined or persistence is enabled. */ igGridSelection(optionLiteral: 'option', optionName: "activeRowChanged"): ActiveRowChangedEvent; /** * Event fired after a row becomes active (focus style applied). - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.row to get reference to row object. - * Use ui.row.element to get reference to active row DOM element. - * Use ui.row.index to get active row index. - * Use ui.row.id to get the active row id if primary key is defined or persistence is enabled. * * @optionValue Define event handler function. */ @@ -46623,738 +53162,6 @@ interface JQuery { igGridSelection(optionLiteral: 'option', optionName: string, optionValue: any): JQuery; igGridSelection(methodName: string, ...methodParams: any[]): any; } -interface ButtonOKClickEvent { - (event: Event, ui: ButtonOKClickEventUIParam): void; -} - -interface ButtonOKClickEventUIParam { - /** - * Used to get the reference to the igGridModalDialog widget. - */ - owner?: any; - - /** - * Used to get the reference to the igGridModalDialog element - */ - modalDialog?: any; -} - -interface ButtonCancelClickEvent { - (event: Event, ui: ButtonCancelClickEventUIParam): void; -} - -interface ButtonCancelClickEventUIParam { - /** - * Used to get the reference to the igGridModalDialog widget. - */ - owner?: any; - - /** - * Used to get the reference to the igGridModalDialog element - */ - modalDialog?: any; -} - -interface IgGridModalDialog { - buttonApplyText?: string; - buttonCancelText?: string; - buttonApplyTitle?: any; - buttonCancelTitle?: any; - modalDialogCaptionText?: string; - - /** - * The default modal dialog width in pixels. - */ - modalDialogWidth?: number; - - /** - * The default modal dialog height in pixels. - */ - modalDialogHeight?: number; - renderFooterButtons?: boolean; - animationDuration?: number; - buttonApplyDisabled?: boolean; - - /** - * If true and Enter is pressed - close modal dialog(NOTE: buttonApplyDisabled should be set to false - otherwise this options is ignored) - */ - closeModalDialogOnEnter?: boolean; - - /** - * Tab index to assign to containers and buttons inside the dialog - */ - tabIndex?: number; - - /** - * Event fired before the modal dialog is opened. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridModalDialog widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - */ - modalDialogOpening?: ModalDialogOpeningEvent; - - /** - * Event fired after the modal dialog is already opened. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridModalDialog widget. - * Use ui.modalDialog to get the reference to the igGridModalDialog element - */ - modalDialogOpened?: ModalDialogOpenedEvent; - - /** - * Event fired every time the modal dialog changes its position. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridModalDialog widget. - * Use ui.modalDialog to get the reference to the igGridModalDialog element - * Use ui.originalPosition to get the original position of the modal dialog div as { top, left } object, relative to the page. - * Use ui.position to get the current position of the modal dialog div as { top, left } object, relative to the page. - */ - modalDialogMoving?: ModalDialogMovingEvent; - - /** - * Event fired before the modal dialog is closed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridModalDialog widget. - * Use ui.modalDialog to get the reference to the igGridModalDialog element - */ - modalDialogClosing?: ModalDialogClosingEvent; - - /** - * Event fired after the modal dialog has been closed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridModalDialog widget. - * Use ui.modalDialog to get the reference to the igGridModalDialog element - */ - modalDialogClosed?: ModalDialogClosedEvent; - - /** - * Event fired before the contents of the modal dialog are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridModalDialog widget. - * Use ui.modalDialog to get the reference to the igGridModalDialog element - */ - modalDialogContentsRendering?: ModalDialogContentsRenderingEvent; - - /** - * Event fired after the contents of the modal dialog are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridModalDialog widget. - * Use ui.modalDialog to get the reference to the igGridModalDialog element - */ - modalDialogContentsRendered?: ModalDialogContentsRenderedEvent; - - /** - * Event fired when the button OK/Apply is clicked - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridModalDialog widget. - * Use ui.modalDialog to get the reference to the igGridModalDialog element - */ - buttonOKClick?: ButtonOKClickEvent; - - /** - * Event fired when the button Cancel is clicked - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridModalDialog widget. - * Use ui.modalDialog to get the reference to the igGridModalDialog element - */ - buttonCancelClick?: ButtonCancelClickEvent; - - /** - * Option for igGridModalDialog - */ - [optionName: string]: any; -} -interface IgGridModalDialogMethods { - openModalDialog(): void; - closeModalDialog(accepted: Object, fromUI: Object): void; - getCaptionButtonContainer(): void; - getFooter(): void; - getContent(): void; - destroy(): void; -} -interface JQuery { - data(propertyName: "igGridModalDialog"): IgGridModalDialogMethods; -} - -interface IgEditorFilter { - /** - * Option for igEditorFilter - */ - [optionName: string]: any; -} -interface IgEditorFilterMethods { - setFocus(delay: Object, toggle: Object): void; - remove(): void; - exitEditMode(): void; - validator(): void; - hasInvalidMessage(): void; - destroy(): void; -} -interface JQuery { - data(propertyName: "igEditorFilter"): IgEditorFilterMethods; -} - -declare namespace Infragistics { - class EditorProvider { - /** - * Create handlers cache - * - * @param callbacks - * @param key - * @param editorOptions - * @param tabIndex - * @param format - * @param element - */ - createEditor(callbacks: Object, key: Object, editorOptions: Object, tabIndex: Object, format: Object, element: Object): void; - keyDown(evt: Object, ui: Object): void; - attachErrorEvents(errorShowing: Object, errorShown: Object, errorHidden: Object): void; - getEditor(): void; - refreshValue(): void; - getValue(): void; - setValue(val: Object): void; - setFocus(toggle: Object): void; - setSize(width: Object, height: Object): void; - removeFromParent(): void; - destroy(): void; - validator(): void; - validate(): void; - requestValidate(evt: Object): void; - isValid(): void; - } -} - -declare namespace Infragistics { - class EditorProviderBase { - /** - * Call parent createEditor - * - * @param callbacks - * @param key - * @param editorOptions - * @param tabIndex - * @param format - * @param element - */ - createEditor(callbacks: Object, key: Object, editorOptions: Object, tabIndex: Object, format: Object, element: Object): void; - textChanged(evt: Object, ui: Object): void; - setSize(width: Object, height: Object): void; - setFocus(): void; - removeFromParent(): void; - destroy(): void; - refreshValue(): void; - validator(): void; - isValid(): void; - keyDown(evt: Object, ui: Object): void; - attachErrorEvents(errorShowing: Object, errorShown: Object, errorHidden: Object): void; - getEditor(): void; - getValue(): void; - setValue(val: Object): void; - validate(): void; - requestValidate(evt: Object): void; - } -} - -declare namespace Infragistics { - class EditorProviderText { - createEditor(callbacks: Object, key: Object, editorOptions: Object, tabIndex: Object, format: Object, element: Object): void; - keyDown(evt: Object, ui: Object): void; - textChanged(evt: Object, ui: Object): void; - setSize(width: Object, height: Object): void; - setFocus(): void; - removeFromParent(): void; - destroy(): void; - refreshValue(): void; - validator(): void; - isValid(): void; - } -} - -declare namespace Infragistics { - class EditorProviderNumeric { - createEditor(callbacks: Object, key: Object, editorOptions: Object, tabIndex: Object, format: Object, element: Object): void; - getValue(): void; - textChanged(evt: Object, ui: Object): void; - setSize(width: Object, height: Object): void; - setFocus(): void; - removeFromParent(): void; - destroy(): void; - refreshValue(): void; - validator(): void; - isValid(): void; - } -} - -declare namespace Infragistics { - class EditorProviderCurrency { - createEditor(callbacks: Object, key: Object, editorOptions: Object, tabIndex: Object, format: Object, element: Object): void; - textChanged(evt: Object, ui: Object): void; - setSize(width: Object, height: Object): void; - setFocus(): void; - removeFromParent(): void; - destroy(): void; - refreshValue(): void; - validator(): void; - isValid(): void; - } -} - -declare namespace Infragistics { - class EditorProviderPercent { - createEditor(callbacks: Object, key: Object, editorOptions: Object, tabIndex: Object, format: Object, element: Object): void; - textChanged(evt: Object, ui: Object): void; - setSize(width: Object, height: Object): void; - setFocus(): void; - removeFromParent(): void; - destroy(): void; - refreshValue(): void; - validator(): void; - isValid(): void; - } -} - -declare namespace Infragistics { - class EditorProviderMask { - createEditor(callbacks: Object, key: Object, editorOptions: Object, tabIndex: Object, format: Object, element: Object): void; - textChanged(evt: Object, ui: Object): void; - setSize(width: Object, height: Object): void; - setFocus(): void; - removeFromParent(): void; - destroy(): void; - refreshValue(): void; - validator(): void; - isValid(): void; - } -} - -declare namespace Infragistics { - class EditorProviderDate { - createEditor(callbacks: Object, key: Object, editorOptions: Object, tabIndex: Object, format: Object, element: Object): void; - textChanged(evt: Object, ui: Object): void; - setSize(width: Object, height: Object): void; - setFocus(): void; - removeFromParent(): void; - destroy(): void; - refreshValue(): void; - validator(): void; - isValid(): void; - } -} - -declare namespace Infragistics { - class EditorProviderDatePicker { - createEditor(callbacks: Object, key: Object, editorOptions: Object, tabIndex: Object, format: Object, element: Object): void; - removeFromParent(): void; - textChanged(evt: Object, ui: Object): void; - setSize(width: Object, height: Object): void; - setFocus(): void; - destroy(): void; - refreshValue(): void; - validator(): void; - isValid(): void; - } -} - -declare namespace Infragistics { - class EditorProviderBoolean { - createEditor(callbacks: Object, key: Object, editorOptions: Object, tabIndex: Object, format: Object, element: Object): void; - valueChanged(evt: Object, ui: Object): void; - refreshValue(): void; - getValue(): void; - setValue(val: Object): void; - setSize(width: Object, height: Object): void; - removeFromParent(): void; - destroy(): void; - textChanged(evt: Object, ui: Object): void; - setFocus(): void; - validator(): void; - isValid(): void; - } -} - -declare namespace Infragistics { - class EditorProviderCombo { - createEditor(callbacks: Object, key: Object, editorOptions: Object, tabIndex: Object, format: Object, element: Object): void; - keyDown(evt: Object, ui: Object): void; - internalSelectionChanged(evt: Object, ui: Object): void; - selectionChanged(evt: Object, ui: Object): void; - refreshValue(): void; - getValue(): void; - setValue(val: Object, fire: Object): void; - setSize(width: Object, height: Object): void; - setFocus(): void; - removeFromParent(): void; - validator(): void; - destroy(): void; - isValid(): void; - attachErrorEvents(errorShowing: Object, errorShown: Object, errorHidden: Object): void; - getEditor(): void; - validate(): void; - requestValidate(evt: Object): void; - } -} - -declare namespace Infragistics { - class EditorProviderObjectCombo { - getValue(): void; - setValue(val: Object, fire: Object): void; - createEditor(callbacks: Object, key: Object, editorOptions: Object, tabIndex: Object, format: Object, element: Object): void; - keyDown(evt: Object, ui: Object): void; - internalSelectionChanged(evt: Object, ui: Object): void; - selectionChanged(evt: Object, ui: Object): void; - refreshValue(): void; - setSize(width: Object, height: Object): void; - setFocus(): void; - removeFromParent(): void; - validator(): void; - destroy(): void; - isValid(): void; - } -} - -declare namespace Infragistics { - class EditorProviderRating { - createEditor(callbacks: Object, key: Object, editorOptions: Object, tabIndex: Object, format: Object, element: Object): void; - internalValueChange(evt: Object, ui: Object): void; - valueChange(evt: Object, ui: Object): void; - setValue(val: Object): void; - setSize(width: Object, height: Object): void; - setFocus(): void; - validator(): void; - destroy(): void; - isValid(): void; - keyDown(evt: Object, ui: Object): void; - attachErrorEvents(errorShowing: Object, errorShown: Object, errorHidden: Object): void; - getEditor(): void; - refreshValue(): void; - getValue(): void; - removeFromParent(): void; - validate(): void; - requestValidate(evt: Object): void; - } -} - -declare namespace Infragistics { - class SortingExpressionsManager { - setGridInstance(grid: Object): void; - - /** - * Insert expr at the first position of the se (sorting expressions) if there are not any other expressions with flag group by - * otherwise if there are such expressions inserts after the last - * - * @param se - * @param expr - * @param feature - */ - addSortingExpression(se: Object, expr: Object, feature: Object): void; - setFormattersForSortingExprs(exprs: Object, grid: Object): void; - } -} - -interface JQuery { - igGridModalDialog(methodName: "openModalDialog"): void; - igGridModalDialog(methodName: "closeModalDialog", accepted: Object, fromUI: Object): void; - igGridModalDialog(methodName: "getCaptionButtonContainer"): void; - igGridModalDialog(methodName: "getFooter"): void; - igGridModalDialog(methodName: "getContent"): void; - igGridModalDialog(methodName: "destroy"): void; - - /** - */ - igGridModalDialog(optionLiteral: 'option', optionName: "buttonApplyText"): string; - - /** - */ - igGridModalDialog(optionLiteral: 'option', optionName: "buttonApplyText", optionValue: string): void; - - /** - */ - igGridModalDialog(optionLiteral: 'option', optionName: "buttonCancelText"): string; - - /** - */ - igGridModalDialog(optionLiteral: 'option', optionName: "buttonCancelText", optionValue: string): void; - - /** - */ - igGridModalDialog(optionLiteral: 'option', optionName: "buttonApplyTitle"): any; - - /** - */ - igGridModalDialog(optionLiteral: 'option', optionName: "buttonApplyTitle", optionValue: any): void; - - /** - */ - igGridModalDialog(optionLiteral: 'option', optionName: "buttonCancelTitle"): any; - - /** - */ - igGridModalDialog(optionLiteral: 'option', optionName: "buttonCancelTitle", optionValue: any): void; - - /** - */ - igGridModalDialog(optionLiteral: 'option', optionName: "modalDialogCaptionText"): string; - - /** - */ - igGridModalDialog(optionLiteral: 'option', optionName: "modalDialogCaptionText", optionValue: string): void; - - /** - * The default modal dialog width in pixels. - */ - igGridModalDialog(optionLiteral: 'option', optionName: "modalDialogWidth"): number; - - /** - * The default modal dialog width in pixels. - * - * @optionValue New value to be set. - */ - igGridModalDialog(optionLiteral: 'option', optionName: "modalDialogWidth", optionValue: number): void; - - /** - * The default modal dialog height in pixels. - */ - igGridModalDialog(optionLiteral: 'option', optionName: "modalDialogHeight"): number; - - /** - * The default modal dialog height in pixels. - * - * @optionValue New value to be set. - */ - igGridModalDialog(optionLiteral: 'option', optionName: "modalDialogHeight", optionValue: number): void; - - /** - */ - igGridModalDialog(optionLiteral: 'option', optionName: "renderFooterButtons"): boolean; - - /** - */ - igGridModalDialog(optionLiteral: 'option', optionName: "renderFooterButtons", optionValue: boolean): void; - - /** - */ - igGridModalDialog(optionLiteral: 'option', optionName: "animationDuration"): number; - - /** - */ - igGridModalDialog(optionLiteral: 'option', optionName: "animationDuration", optionValue: number): void; - - /** - */ - igGridModalDialog(optionLiteral: 'option', optionName: "buttonApplyDisabled"): boolean; - - /** - */ - igGridModalDialog(optionLiteral: 'option', optionName: "buttonApplyDisabled", optionValue: boolean): void; - - /** - * If true and Enter is pressed - close modal dialog(NOTE: buttonApplyDisabled should be set to false - otherwise this options is ignored) - */ - igGridModalDialog(optionLiteral: 'option', optionName: "closeModalDialogOnEnter"): boolean; - - /** - * If true and Enter is pressed - close modal dialog(NOTE: buttonApplyDisabled should be set to false - otherwise this options is ignored) - * - * @optionValue New value to be set. - */ - igGridModalDialog(optionLiteral: 'option', optionName: "closeModalDialogOnEnter", optionValue: boolean): void; - - /** - * Tab index to assign to containers and buttons inside the dialog - */ - igGridModalDialog(optionLiteral: 'option', optionName: "tabIndex"): number; - - /** - * Tab index to assign to containers and buttons inside the dialog - * - * @optionValue New value to be set. - */ - igGridModalDialog(optionLiteral: 'option', optionName: "tabIndex", optionValue: number): void; - - /** - * Event fired before the modal dialog is opened. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridModalDialog widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - */ - igGridModalDialog(optionLiteral: 'option', optionName: "modalDialogOpening"): ModalDialogOpeningEvent; - - /** - * Event fired before the modal dialog is opened. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridModalDialog widget. - * Use ui.owner.grid to get the reference to the igGrid widget. - * - * @optionValue Define event handler function. - */ - igGridModalDialog(optionLiteral: 'option', optionName: "modalDialogOpening", optionValue: ModalDialogOpeningEvent): void; - - /** - * Event fired after the modal dialog is already opened. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridModalDialog widget. - * Use ui.modalDialog to get the reference to the igGridModalDialog element - */ - igGridModalDialog(optionLiteral: 'option', optionName: "modalDialogOpened"): ModalDialogOpenedEvent; - - /** - * Event fired after the modal dialog is already opened. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridModalDialog widget. - * Use ui.modalDialog to get the reference to the igGridModalDialog element - * - * @optionValue Define event handler function. - */ - igGridModalDialog(optionLiteral: 'option', optionName: "modalDialogOpened", optionValue: ModalDialogOpenedEvent): void; - - /** - * Event fired every time the modal dialog changes its position. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridModalDialog widget. - * Use ui.modalDialog to get the reference to the igGridModalDialog element - * Use ui.originalPosition to get the original position of the modal dialog div as { top, left } object, relative to the page. - * Use ui.position to get the current position of the modal dialog div as { top, left } object, relative to the page. - */ - igGridModalDialog(optionLiteral: 'option', optionName: "modalDialogMoving"): ModalDialogMovingEvent; - - /** - * Event fired every time the modal dialog changes its position. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridModalDialog widget. - * Use ui.modalDialog to get the reference to the igGridModalDialog element - * Use ui.originalPosition to get the original position of the modal dialog div as { top, left } object, relative to the page. - * Use ui.position to get the current position of the modal dialog div as { top, left } object, relative to the page. - * - * @optionValue Define event handler function. - */ - igGridModalDialog(optionLiteral: 'option', optionName: "modalDialogMoving", optionValue: ModalDialogMovingEvent): void; - - /** - * Event fired before the modal dialog is closed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridModalDialog widget. - * Use ui.modalDialog to get the reference to the igGridModalDialog element - */ - igGridModalDialog(optionLiteral: 'option', optionName: "modalDialogClosing"): ModalDialogClosingEvent; - - /** - * Event fired before the modal dialog is closed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridModalDialog widget. - * Use ui.modalDialog to get the reference to the igGridModalDialog element - * - * @optionValue Define event handler function. - */ - igGridModalDialog(optionLiteral: 'option', optionName: "modalDialogClosing", optionValue: ModalDialogClosingEvent): void; - - /** - * Event fired after the modal dialog has been closed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridModalDialog widget. - * Use ui.modalDialog to get the reference to the igGridModalDialog element - */ - igGridModalDialog(optionLiteral: 'option', optionName: "modalDialogClosed"): ModalDialogClosedEvent; - - /** - * Event fired after the modal dialog has been closed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridModalDialog widget. - * Use ui.modalDialog to get the reference to the igGridModalDialog element - * - * @optionValue Define event handler function. - */ - igGridModalDialog(optionLiteral: 'option', optionName: "modalDialogClosed", optionValue: ModalDialogClosedEvent): void; - - /** - * Event fired before the contents of the modal dialog are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridModalDialog widget. - * Use ui.modalDialog to get the reference to the igGridModalDialog element - */ - igGridModalDialog(optionLiteral: 'option', optionName: "modalDialogContentsRendering"): ModalDialogContentsRenderingEvent; - - /** - * Event fired before the contents of the modal dialog are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridModalDialog widget. - * Use ui.modalDialog to get the reference to the igGridModalDialog element - * - * @optionValue Define event handler function. - */ - igGridModalDialog(optionLiteral: 'option', optionName: "modalDialogContentsRendering", optionValue: ModalDialogContentsRenderingEvent): void; - - /** - * Event fired after the contents of the modal dialog are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridModalDialog widget. - * Use ui.modalDialog to get the reference to the igGridModalDialog element - */ - igGridModalDialog(optionLiteral: 'option', optionName: "modalDialogContentsRendered"): ModalDialogContentsRenderedEvent; - - /** - * Event fired after the contents of the modal dialog are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridModalDialog widget. - * Use ui.modalDialog to get the reference to the igGridModalDialog element - * - * @optionValue Define event handler function. - */ - igGridModalDialog(optionLiteral: 'option', optionName: "modalDialogContentsRendered", optionValue: ModalDialogContentsRenderedEvent): void; - - /** - * Event fired when the button OK/Apply is clicked - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridModalDialog widget. - * Use ui.modalDialog to get the reference to the igGridModalDialog element - */ - igGridModalDialog(optionLiteral: 'option', optionName: "buttonOKClick"): ButtonOKClickEvent; - - /** - * Event fired when the button OK/Apply is clicked - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridModalDialog widget. - * Use ui.modalDialog to get the reference to the igGridModalDialog element - * - * @optionValue Define event handler function. - */ - igGridModalDialog(optionLiteral: 'option', optionName: "buttonOKClick", optionValue: ButtonOKClickEvent): void; - - /** - * Event fired when the button Cancel is clicked - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridModalDialog widget. - * Use ui.modalDialog to get the reference to the igGridModalDialog element - */ - igGridModalDialog(optionLiteral: 'option', optionName: "buttonCancelClick"): ButtonCancelClickEvent; - - /** - * Event fired when the button Cancel is clicked - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the igGridModalDialog widget. - * Use ui.modalDialog to get the reference to the igGridModalDialog element - * - * @optionValue Define event handler function. - */ - igGridModalDialog(optionLiteral: 'option', optionName: "buttonCancelClick", optionValue: ButtonCancelClickEvent): void; - igGridModalDialog(options: IgGridModalDialog): JQuery; - igGridModalDialog(optionLiteral: 'option', optionName: string): any; - igGridModalDialog(optionLiteral: 'option', options: IgGridModalDialog): JQuery; - igGridModalDialog(optionLiteral: 'option', optionName: string, optionValue: any): JQuery; - igGridModalDialog(methodName: string, ...methodParams: any[]): any; -} -interface JQuery { - igEditorFilter(methodName: "setFocus", delay: Object, toggle: Object): void; - igEditorFilter(methodName: "remove"): void; - igEditorFilter(methodName: "exitEditMode"): void; - igEditorFilter(methodName: "validator"): void; - igEditorFilter(methodName: "hasInvalidMessage"): void; - igEditorFilter(methodName: "destroy"): void; - igEditorFilter(options: IgEditorFilter): JQuery; - igEditorFilter(optionLiteral: 'option', optionName: string): any; - igEditorFilter(optionLiteral: 'option', options: IgEditorFilter): JQuery; - igEditorFilter(optionLiteral: 'option', optionName: string, optionValue: any): JQuery; - igEditorFilter(methodName: string, ...methodParams: any[]): any; -} interface IgGridSortingColumnSetting { /** * Identifies the grid column by key. Either key or index must be set in every column setting. @@ -47423,25 +53230,6 @@ interface ColumnSortingEvent { } interface ColumnSortingEventUIParam { - /** - * Used to get reference to GridSorting. - */ - owner?: any; - - /** - * Used to get column key. - */ - columnKey?: any; - - /** - * Used to get sorting direction. - */ - direction?: any; - - /** - * Used to get sorting expressions. - */ - newExpressions?: any; } interface ColumnSortedEvent { @@ -47449,25 +53237,6 @@ interface ColumnSortedEvent { } interface ColumnSortedEventUIParam { - /** - * Used to get reference to GridSorting. - */ - owner?: any; - - /** - * Used to get column key. - */ - columnKey?: any; - - /** - * Used to get sorting direction. - */ - direction?: any; - - /** - * Used to get sorted expressions. - */ - expressions?: any; } interface ModalDialogSortingChangedEvent { @@ -47475,25 +53244,6 @@ interface ModalDialogSortingChangedEvent { } interface ModalDialogSortingChangedEventUIParam { - /** - * Used to get the reference to the GridSorting widget. - */ - owner?: any; - - /** - * Used to get a reference to the modal dialog element. This is a jQuery object. - */ - modalDialogElement?: any; - - /** - * Used to get the column key - */ - columnKey?: any; - - /** - * Used to get whether column should be ascending or not. If true it should be ascending - */ - isAsc?: any; } interface ModalDialogButtonUnsortClickEvent { @@ -47501,20 +53251,6 @@ interface ModalDialogButtonUnsortClickEvent { } interface ModalDialogButtonUnsortClickEventUIParam { - /** - * Used to get the reference to the GridSorting widget. - */ - owner?: any; - - /** - * Used to get a reference to the modal dialog element. This is a jQuery object. - */ - modalDialogElement?: any; - - /** - * Used to get the column key - */ - columnKey?: any; } interface ModalDialogSortClickEvent { @@ -47522,20 +53258,6 @@ interface ModalDialogSortClickEvent { } interface ModalDialogSortClickEventUIParam { - /** - * Used to get the reference to the GridSorting widget. - */ - owner?: any; - - /** - * Used to get a reference to the modal dialog element. This is a jQuery object. - */ - modalDialogElement?: any; - - /** - * Used to get the column key - */ - columnKey?: any; } interface IgGridSorting { @@ -47749,138 +53471,71 @@ interface IgGridSorting { /** * Event fired before sorting is invoked for a certain column. * Return false in order to cancel column sorting. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSorting. - * Use ui.owner.grid to get reference to grid. - * Use ui.columnKey to get column key. - * Use ui.direction to get sorting direction. - * Use ui.newExpressions to get sorting expressions. */ columnSorting?: ColumnSortingEvent; /** * Event fired after the column has already been sorted and data - re-rendered. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSorting. - * Use ui.owner.grid to get reference to grid. - * Use ui.columnKey to get column key. - * Use ui.direction to get sorting direction. - * Use ui.expressions to get sorted expressions. */ columnSorted?: ColumnSortedEvent; /** * Event fired before the modal dialog is opened. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the modal dialog element. This is a jQuery object. */ modalDialogOpening?: ModalDialogOpeningEvent; /** * Event fired after the modal dialog is already opened. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. */ modalDialogOpened?: ModalDialogOpenedEvent; /** * Event fired every time the modal dialog changes its position. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. - * Use ui.originalPosition to get the original position of the modal dialog div as { top, left } object, relative to the page. - * Use ui.position to get the current position of the modal dialog div as { top, left } object, relative to the page. */ modalDialogMoving?: ModalDialogMovingEvent; /** * Event fired before the modal dialog is closed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. */ modalDialogClosing?: ModalDialogClosingEvent; /** * Event fired after the modal dialog has been closed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. */ modalDialogClosed?: ModalDialogClosedEvent; /** * Event fired before the contents of the modal dialog are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. */ modalDialogContentsRendering?: ModalDialogContentsRenderingEvent; /** * Event fired after the contents of the modal dialog are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. */ modalDialogContentsRendered?: ModalDialogContentsRenderedEvent; /** * Event fired when sorting of column is changed in modal dialog. Column should be sorted - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. - * Use ui.columnKey to get the column key - * Use ui.isAsc to get whether column should be ascending or not. If true it should be ascending */ modalDialogSortingChanged?: ModalDialogSortingChangedEvent; /** * Event fired when button to unsort column is clicked in modal dialog - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. - * Use ui.columnKey to get the column key */ modalDialogButtonUnsortClick?: ModalDialogButtonUnsortClickEvent; /** * Event fired when column(which is not sorted) is clicked to be sorted in modal dialog - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. - * Use ui.columnKey to get the column key */ modalDialogSortClick?: ModalDialogSortClickEvent; /** * Event fired when button Apply in modal dialog is clicked - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. - * Use ui.columnsToSort to get array of columns which should be sorted - array of objects of sort order - Asc/Desc and columnIdentifier */ modalDialogButtonApplyClick?: ModalDialogButtonApplyClickEvent; /** * Event fired when the button to reset sorting is clicked. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. */ modalDialogButtonResetClick?: ModalDialogButtonResetClickEvent; @@ -48398,24 +54053,12 @@ interface JQuery { /** * Event fired before sorting is invoked for a certain column. * Return false in order to cancel column sorting. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSorting. - * Use ui.owner.grid to get reference to grid. - * Use ui.columnKey to get column key. - * Use ui.direction to get sorting direction. - * Use ui.newExpressions to get sorting expressions. */ igGridSorting(optionLiteral: 'option', optionName: "columnSorting"): ColumnSortingEvent; /** * Event fired before sorting is invoked for a certain column. * Return false in order to cancel column sorting. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSorting. - * Use ui.owner.grid to get reference to grid. - * Use ui.columnKey to get column key. - * Use ui.direction to get sorting direction. - * Use ui.newExpressions to get sorting expressions. * * @optionValue Define event handler function. */ @@ -48423,23 +54066,11 @@ interface JQuery { /** * Event fired after the column has already been sorted and data - re-rendered. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSorting. - * Use ui.owner.grid to get reference to grid. - * Use ui.columnKey to get column key. - * Use ui.direction to get sorting direction. - * Use ui.expressions to get sorted expressions. */ igGridSorting(optionLiteral: 'option', optionName: "columnSorted"): ColumnSortedEvent; /** * Event fired after the column has already been sorted and data - re-rendered. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSorting. - * Use ui.owner.grid to get reference to grid. - * Use ui.columnKey to get column key. - * Use ui.direction to get sorting direction. - * Use ui.expressions to get sorted expressions. * * @optionValue Define event handler function. */ @@ -48447,19 +54078,11 @@ interface JQuery { /** * Event fired before the modal dialog is opened. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the modal dialog element. This is a jQuery object. */ igGridSorting(optionLiteral: 'option', optionName: "modalDialogOpening"): ModalDialogOpeningEvent; /** * Event fired before the modal dialog is opened. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the modal dialog element. This is a jQuery object. * * @optionValue Define event handler function. */ @@ -48467,19 +54090,11 @@ interface JQuery { /** * Event fired after the modal dialog is already opened. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. */ igGridSorting(optionLiteral: 'option', optionName: "modalDialogOpened"): ModalDialogOpenedEvent; /** * Event fired after the modal dialog is already opened. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. * * @optionValue Define event handler function. */ @@ -48487,23 +54102,11 @@ interface JQuery { /** * Event fired every time the modal dialog changes its position. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. - * Use ui.originalPosition to get the original position of the modal dialog div as { top, left } object, relative to the page. - * Use ui.position to get the current position of the modal dialog div as { top, left } object, relative to the page. */ igGridSorting(optionLiteral: 'option', optionName: "modalDialogMoving"): ModalDialogMovingEvent; /** * Event fired every time the modal dialog changes its position. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. - * Use ui.originalPosition to get the original position of the modal dialog div as { top, left } object, relative to the page. - * Use ui.position to get the current position of the modal dialog div as { top, left } object, relative to the page. * * @optionValue Define event handler function. */ @@ -48511,19 +54114,11 @@ interface JQuery { /** * Event fired before the modal dialog is closed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. */ igGridSorting(optionLiteral: 'option', optionName: "modalDialogClosing"): ModalDialogClosingEvent; /** * Event fired before the modal dialog is closed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. * * @optionValue Define event handler function. */ @@ -48531,19 +54126,11 @@ interface JQuery { /** * Event fired after the modal dialog has been closed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. */ igGridSorting(optionLiteral: 'option', optionName: "modalDialogClosed"): ModalDialogClosedEvent; /** * Event fired after the modal dialog has been closed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. * * @optionValue Define event handler function. */ @@ -48551,19 +54138,11 @@ interface JQuery { /** * Event fired before the contents of the modal dialog are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. */ igGridSorting(optionLiteral: 'option', optionName: "modalDialogContentsRendering"): ModalDialogContentsRenderingEvent; /** * Event fired before the contents of the modal dialog are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. * * @optionValue Define event handler function. */ @@ -48571,19 +54150,11 @@ interface JQuery { /** * Event fired after the contents of the modal dialog are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. */ igGridSorting(optionLiteral: 'option', optionName: "modalDialogContentsRendered"): ModalDialogContentsRenderedEvent; /** * Event fired after the contents of the modal dialog are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. * * @optionValue Define event handler function. */ @@ -48591,23 +54162,11 @@ interface JQuery { /** * Event fired when sorting of column is changed in modal dialog. Column should be sorted - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. - * Use ui.columnKey to get the column key - * Use ui.isAsc to get whether column should be ascending or not. If true it should be ascending */ igGridSorting(optionLiteral: 'option', optionName: "modalDialogSortingChanged"): ModalDialogSortingChangedEvent; /** * Event fired when sorting of column is changed in modal dialog. Column should be sorted - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. - * Use ui.columnKey to get the column key - * Use ui.isAsc to get whether column should be ascending or not. If true it should be ascending * * @optionValue Define event handler function. */ @@ -48615,21 +54174,11 @@ interface JQuery { /** * Event fired when button to unsort column is clicked in modal dialog - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. - * Use ui.columnKey to get the column key */ igGridSorting(optionLiteral: 'option', optionName: "modalDialogButtonUnsortClick"): ModalDialogButtonUnsortClickEvent; /** * Event fired when button to unsort column is clicked in modal dialog - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. - * Use ui.columnKey to get the column key * * @optionValue Define event handler function. */ @@ -48637,21 +54186,11 @@ interface JQuery { /** * Event fired when column(which is not sorted) is clicked to be sorted in modal dialog - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. - * Use ui.columnKey to get the column key */ igGridSorting(optionLiteral: 'option', optionName: "modalDialogSortClick"): ModalDialogSortClickEvent; /** * Event fired when column(which is not sorted) is clicked to be sorted in modal dialog - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. - * Use ui.columnKey to get the column key * * @optionValue Define event handler function. */ @@ -48659,21 +54198,11 @@ interface JQuery { /** * Event fired when button Apply in modal dialog is clicked - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. - * Use ui.columnsToSort to get array of columns which should be sorted - array of objects of sort order - Asc/Desc and columnIdentifier */ igGridSorting(optionLiteral: 'option', optionName: "modalDialogButtonApplyClick"): ModalDialogButtonApplyClickEvent; /** * Event fired when button Apply in modal dialog is clicked - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. - * Use ui.columnsToSort to get array of columns which should be sorted - array of objects of sort order - Asc/Desc and columnIdentifier * * @optionValue Define event handler function. */ @@ -48681,19 +54210,11 @@ interface JQuery { /** * Event fired when the button to reset sorting is clicked. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. */ igGridSorting(optionLiteral: 'option', optionName: "modalDialogButtonResetClick"): ModalDialogButtonResetClickEvent; /** * Event fired when the button to reset sorting is clicked. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. * * @optionValue Define event handler function. */ @@ -48744,16 +54265,13 @@ interface IgGridSummariesColumnSettingSummaryOperand { order?: number; /** - * Specifies the number of digits after the decimal point for result of the current summary operand. This property will be ignored when isGridFormatter is true + * Specifies a format that will be applied to the current summary operant. + * When this option is not set, the [format](ui.iggrid#options:columns.format) of the column it is in will taken into account. + * When this option and the column [format](ui.iggrid#options:columns.format) is not set, the regional settings will be taken depending on the [autoFormat](ui.iggrid#options:autoFormat) option. + * If the column type is not specified in the [autoFormat](ui.iggrid#options:autoFormat) option and no format is set for both column and summary operand, no formatting is applied. * */ - decimalDisplay?: number; - - /** - * Specifies whether to be used grid formatter for result for the current summary operand. - * - */ - isGridFormatter?: boolean; + format?: string; /** * Option for IgGridSummariesColumnSettingSummaryOperand @@ -48797,10 +54315,6 @@ interface SummariesCalculatingEvent { } interface SummariesCalculatingEventUIParam { - /** - * Used to access the igGridSummaries widget object. - */ - owner?: any; } interface SummariesCalculatedEvent { @@ -48808,15 +54322,6 @@ interface SummariesCalculatedEvent { } interface SummariesCalculatedEventUIParam { - /** - * Used to get data for calculated summaries - */ - data?: any; - - /** - * Used to access the igGridSummaries widget object. - */ - owner?: any; } interface SummariesMethodSelectionChangedEvent { @@ -48824,25 +54329,6 @@ interface SummariesMethodSelectionChangedEvent { } interface SummariesMethodSelectionChangedEventUIParam { - /** - * Used to get column key of the column where it is changed selection of summary method - */ - columnKey?: any; - - /** - * Used to get whether method is selected or not - */ - isSelected?: any; - - /** - * Used to get summary method name - */ - methodName?: any; - - /** - * Used to access the igGridSummaries widget object. - */ - owner?: any; } interface SummariesTogglingEvent { @@ -48850,15 +54336,6 @@ interface SummariesTogglingEvent { } interface SummariesTogglingEventUIParam { - /** - * Used to get whether summaries are shown or not. - */ - isToShow?: any; - - /** - * Used to access the igGridSummaries widget object. - */ - owner?: any; } interface SummariesToggledEvent { @@ -48866,15 +54343,6 @@ interface SummariesToggledEvent { } interface SummariesToggledEventUIParam { - /** - * Used to get whether summaries are shown or not. - */ - isToShow?: any; - - /** - * Used to access the igGridSummaries widget object. - */ - owner?: any; } interface DropDownOKClickedEvent { @@ -48882,20 +54350,6 @@ interface DropDownOKClickedEvent { } interface DropDownOKClickedEventUIParam { - /** - * Used to get column key for which OK button is clicked. - */ - columnKey?: any; - - /** - * Used to get data about which summary methods are(not) selected. Format of event data is {type: "min", active: false}; - */ - eventData?: any; - - /** - * Used to access the igGridSummaries widget object. - */ - owner?: any; } interface DropDownCancelClickedEvent { @@ -48903,15 +54357,6 @@ interface DropDownCancelClickedEvent { } interface DropDownCancelClickedEventUIParam { - /** - * Used to get column key for which Cancel button is clicked. - */ - columnKey?: any; - - /** - * Used to access the igGridSummaries widget object. - */ - owner?: any; } interface IgGridSummaries { @@ -48968,12 +54413,6 @@ interface IgGridSummaries { */ compactRenderingMode?: any; - /** - * The number of digits after the decimal point. If gridFormatter is True then this option is ignored. - * - */ - defaultDecimalDisplay?: number; - /** * Show header button icon in the header cell. On click - shows/hides summaries. If false then summary icon should not be shown in the feature chooser(if shown). * @@ -49051,12 +54490,6 @@ interface IgGridSummaries { */ resultTemplate?: string; - /** - * If this property is enabled and in summaryOperand isGridFormatter is undefined then use grid formatting for cells - * - */ - isGridFormatter?: boolean; - /** * 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) * @@ -49077,94 +54510,59 @@ interface IgGridSummaries { /** * Event fired before drop down is opened for a specific column summary * Return false in order to cancel opening the drop down. - * Function takes arguments evt and ui. - * Use ui.columnKey to get column key of the column where drop down is opening. - * Use ui.owner in order to access the igGridSummaries widget object. */ dropDownOpening?: DropDownOpeningEvent; /** * Event fired after the summaries dropdown is opened for a specific column - * Function takes arguments evt and ui. - * Use ui.columnKey to get column key of the column where drop down is shown. - * Use ui.owner in order to access the igGridSummaries widget object. */ dropDownOpened?: DropDownOpenedEvent; /** * Event fired before the dropdown for a summary column starts closing * Return false in order to cancel closing the drop down. - * Function takes arguments evt and ui. - * Use ui.columnKey to get column key of the column where drop down is closing. - * Use ui.owner in order to access the igGridSummaries widget object. */ dropDownClosing?: DropDownClosingEvent; /** * Event fired after the dropdown for a summary column is closed - * Function takes arguments evt and ui. - * Use ui.columnKey to get column key of the column where drop down is closing. - * Use ui.owner in order to access the igGridSummaries widget object. */ dropDownClosed?: DropDownClosedEvent; /** * Event fired before summaries calculations are made * Return false in order to cancel calculation of summaries. - * Function takes arguments evt and ui. - * Use ui.owner in order to access the igGridSummaries widget object. */ summariesCalculating?: SummariesCalculatingEvent; /** * Event fired after summaries calculation are completely made - * Function takes arguments evt and ui. - * Use ui.data to get data for calculated summaries - * Use ui.owner in order to access the igGridSummaries widget object. */ summariesCalculated?: SummariesCalculatedEvent; /** * Event fired when user selects/deselects summary method from checkbox - * Function takes arguments evt and ui. - * Use ui.columnKey to get column key of the column where it is changed selection of summary method - * Use ui.isSelected to get whether method is selected or not - * Use ui.methodName to get summary method name - * Use ui.owner in order to access the igGridSummaries widget object. */ summariesMethodSelectionChanged?: SummariesMethodSelectionChangedEvent; /** * Event is fired bofore summary rows start toggling * Return false in order to cancel showing/hiding of summaries. - * Function takes arguments evt and ui. - * Use ui.isToShow to get whether summaries are shown or not. - * Use ui.owner in order to access the igGridSummaries widget object. */ summariesToggling?: SummariesTogglingEvent; /** * Event is fired after summary rows are toggled - * Function takes arguments evt and ui. - * Use ui.isToShow to get whether summaries are shown or not. - * Use ui.owner in order to access the igGridSummaries widget object. */ summariesToggled?: SummariesToggledEvent; /** * Event is fired when OK button is clicked in drop down - * Function takes arguments evt and ui. - * Use ui.columnKey to get column key for which OK button is clicked. - * Use ui.eventData to get data about which summary methods are(not) selected. Format of event data is {type: "min", active: false}; - * Use ui.owner in order to access the igGridSummaries widget object. */ dropDownOKClicked?: DropDownOKClickedEvent; /** * Event is fired when Cancel button is clicked in drop down. - * Function takes arguments evt and ui. - * Use ui.columnKey to get column key for which Cancel button is clicked. - * Use ui.owner in order to access the igGridSummaries widget object. */ dropDownCancelClicked?: DropDownCancelClickedEvent; @@ -49374,20 +54772,6 @@ interface JQuery { */ igGridSummaries(optionLiteral: 'option', optionName: "compactRenderingMode", optionValue: any): void; - /** - * The number of digits after the decimal point. If gridFormatter is True then this option is ignored. - * - */ - igGridSummaries(optionLiteral: 'option', optionName: "defaultDecimalDisplay"): number; - - /** - * The number of digits after the decimal point. If gridFormatter is True then this option is ignored. - * - * - * @optionValue New value to be set. - */ - igGridSummaries(optionLiteral: 'option', optionName: "defaultDecimalDisplay", optionValue: number): void; - /** * Show header button icon in the header cell. On click - shows/hides summaries. If false then summary icon should not be shown in the feature chooser(if shown). * @@ -49556,20 +54940,6 @@ interface JQuery { */ igGridSummaries(optionLiteral: 'option', optionName: "resultTemplate", optionValue: string): void; - /** - * If this property is enabled and in summaryOperand isGridFormatter is undefined then use grid formatting for cells - * - */ - igGridSummaries(optionLiteral: 'option', optionName: "isGridFormatter"): boolean; - - /** - * If this property is enabled and in summaryOperand isGridFormatter is undefined then use grid formatting for cells - * - * - * @optionValue New value to be set. - */ - igGridSummaries(optionLiteral: 'option', optionName: "isGridFormatter", optionValue: boolean): void; - /** * 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) * @@ -49613,18 +54983,12 @@ interface JQuery { /** * Event fired before drop down is opened for a specific column summary * Return false in order to cancel opening the drop down. - * Function takes arguments evt and ui. - * Use ui.columnKey to get column key of the column where drop down is opening. - * Use ui.owner in order to access the igGridSummaries widget object. */ igGridSummaries(optionLiteral: 'option', optionName: "dropDownOpening"): DropDownOpeningEvent; /** * Event fired before drop down is opened for a specific column summary * Return false in order to cancel opening the drop down. - * Function takes arguments evt and ui. - * Use ui.columnKey to get column key of the column where drop down is opening. - * Use ui.owner in order to access the igGridSummaries widget object. * * @optionValue Define event handler function. */ @@ -49632,17 +54996,11 @@ interface JQuery { /** * Event fired after the summaries dropdown is opened for a specific column - * Function takes arguments evt and ui. - * Use ui.columnKey to get column key of the column where drop down is shown. - * Use ui.owner in order to access the igGridSummaries widget object. */ igGridSummaries(optionLiteral: 'option', optionName: "dropDownOpened"): DropDownOpenedEvent; /** * Event fired after the summaries dropdown is opened for a specific column - * Function takes arguments evt and ui. - * Use ui.columnKey to get column key of the column where drop down is shown. - * Use ui.owner in order to access the igGridSummaries widget object. * * @optionValue Define event handler function. */ @@ -49651,18 +55009,12 @@ interface JQuery { /** * Event fired before the dropdown for a summary column starts closing * Return false in order to cancel closing the drop down. - * Function takes arguments evt and ui. - * Use ui.columnKey to get column key of the column where drop down is closing. - * Use ui.owner in order to access the igGridSummaries widget object. */ igGridSummaries(optionLiteral: 'option', optionName: "dropDownClosing"): DropDownClosingEvent; /** * Event fired before the dropdown for a summary column starts closing * Return false in order to cancel closing the drop down. - * Function takes arguments evt and ui. - * Use ui.columnKey to get column key of the column where drop down is closing. - * Use ui.owner in order to access the igGridSummaries widget object. * * @optionValue Define event handler function. */ @@ -49670,17 +55022,11 @@ interface JQuery { /** * Event fired after the dropdown for a summary column is closed - * Function takes arguments evt and ui. - * Use ui.columnKey to get column key of the column where drop down is closing. - * Use ui.owner in order to access the igGridSummaries widget object. */ igGridSummaries(optionLiteral: 'option', optionName: "dropDownClosed"): DropDownClosedEvent; /** * Event fired after the dropdown for a summary column is closed - * Function takes arguments evt and ui. - * Use ui.columnKey to get column key of the column where drop down is closing. - * Use ui.owner in order to access the igGridSummaries widget object. * * @optionValue Define event handler function. */ @@ -49689,16 +55035,12 @@ interface JQuery { /** * Event fired before summaries calculations are made * Return false in order to cancel calculation of summaries. - * Function takes arguments evt and ui. - * Use ui.owner in order to access the igGridSummaries widget object. */ igGridSummaries(optionLiteral: 'option', optionName: "summariesCalculating"): SummariesCalculatingEvent; /** * Event fired before summaries calculations are made * Return false in order to cancel calculation of summaries. - * Function takes arguments evt and ui. - * Use ui.owner in order to access the igGridSummaries widget object. * * @optionValue Define event handler function. */ @@ -49706,17 +55048,11 @@ interface JQuery { /** * Event fired after summaries calculation are completely made - * Function takes arguments evt and ui. - * Use ui.data to get data for calculated summaries - * Use ui.owner in order to access the igGridSummaries widget object. */ igGridSummaries(optionLiteral: 'option', optionName: "summariesCalculated"): SummariesCalculatedEvent; /** * Event fired after summaries calculation are completely made - * Function takes arguments evt and ui. - * Use ui.data to get data for calculated summaries - * Use ui.owner in order to access the igGridSummaries widget object. * * @optionValue Define event handler function. */ @@ -49724,21 +55060,11 @@ interface JQuery { /** * Event fired when user selects/deselects summary method from checkbox - * Function takes arguments evt and ui. - * Use ui.columnKey to get column key of the column where it is changed selection of summary method - * Use ui.isSelected to get whether method is selected or not - * Use ui.methodName to get summary method name - * Use ui.owner in order to access the igGridSummaries widget object. */ igGridSummaries(optionLiteral: 'option', optionName: "summariesMethodSelectionChanged"): SummariesMethodSelectionChangedEvent; /** * Event fired when user selects/deselects summary method from checkbox - * Function takes arguments evt and ui. - * Use ui.columnKey to get column key of the column where it is changed selection of summary method - * Use ui.isSelected to get whether method is selected or not - * Use ui.methodName to get summary method name - * Use ui.owner in order to access the igGridSummaries widget object. * * @optionValue Define event handler function. */ @@ -49747,18 +55073,12 @@ interface JQuery { /** * Event is fired bofore summary rows start toggling * Return false in order to cancel showing/hiding of summaries. - * Function takes arguments evt and ui. - * Use ui.isToShow to get whether summaries are shown or not. - * Use ui.owner in order to access the igGridSummaries widget object. */ igGridSummaries(optionLiteral: 'option', optionName: "summariesToggling"): SummariesTogglingEvent; /** * Event is fired bofore summary rows start toggling * Return false in order to cancel showing/hiding of summaries. - * Function takes arguments evt and ui. - * Use ui.isToShow to get whether summaries are shown or not. - * Use ui.owner in order to access the igGridSummaries widget object. * * @optionValue Define event handler function. */ @@ -49766,17 +55086,11 @@ interface JQuery { /** * Event is fired after summary rows are toggled - * Function takes arguments evt and ui. - * Use ui.isToShow to get whether summaries are shown or not. - * Use ui.owner in order to access the igGridSummaries widget object. */ igGridSummaries(optionLiteral: 'option', optionName: "summariesToggled"): SummariesToggledEvent; /** * Event is fired after summary rows are toggled - * Function takes arguments evt and ui. - * Use ui.isToShow to get whether summaries are shown or not. - * Use ui.owner in order to access the igGridSummaries widget object. * * @optionValue Define event handler function. */ @@ -49784,19 +55098,11 @@ interface JQuery { /** * Event is fired when OK button is clicked in drop down - * Function takes arguments evt and ui. - * Use ui.columnKey to get column key for which OK button is clicked. - * Use ui.eventData to get data about which summary methods are(not) selected. Format of event data is {type: "min", active: false}; - * Use ui.owner in order to access the igGridSummaries widget object. */ igGridSummaries(optionLiteral: 'option', optionName: "dropDownOKClicked"): DropDownOKClickedEvent; /** * Event is fired when OK button is clicked in drop down - * Function takes arguments evt and ui. - * Use ui.columnKey to get column key for which OK button is clicked. - * Use ui.eventData to get data about which summary methods are(not) selected. Format of event data is {type: "min", active: false}; - * Use ui.owner in order to access the igGridSummaries widget object. * * @optionValue Define event handler function. */ @@ -49804,17 +55110,11 @@ interface JQuery { /** * Event is fired when Cancel button is clicked in drop down. - * Function takes arguments evt and ui. - * Use ui.columnKey to get column key for which Cancel button is clicked. - * Use ui.owner in order to access the igGridSummaries widget object. */ igGridSummaries(optionLiteral: 'option', optionName: "dropDownCancelClicked"): DropDownCancelClickedEvent; /** * Event is fired when Cancel button is clicked in drop down. - * Function takes arguments evt and ui. - * Use ui.columnKey to get column key for which Cancel button is clicked. - * Use ui.owner in order to access the igGridSummaries widget object. * * @optionValue Define event handler function. */ @@ -49923,49 +55223,21 @@ interface IgGridTooltips { /** * Event fired when the mouse has hovered on an element long enough to display a tooltip - * use args.owner to get a reference to the widget - * use args.tooltip to get or set the string to be displayed - * use args.value to get the value of the cell the tooltip is displayed for - * use args.element to get a reference to the cell the tooltip is displayed for - * use args.index to get the row index of the cell the tooltip is displayed for - * use args.columnKey to get the column key of the cell the tooltip is displayed for - * use args.columnIndex to get the column index of the cell the tooltip is displayed for */ tooltipShowing?: TooltipShowingEvent; /** * Event fired after a tooltip is shown - * use args.owner to get a reference to the widget - * use args.tooltip to get the string displayed in the tooltip - * use args.value to get the value of the cell the tooltip is displayed for - * use args.element to get a reference to the cell the tooltip is displayed for - * use args.index to get the row index of the cell the tooltip is displayed for - * use args.columnKey to get the column key of the cell the tooltip is displayed for - * use args.columnIndex to get the column index of the cell the tooltip is displayed for */ tooltipShown?: TooltipShownEvent; /** * Event fired when the mouse has left an element and the tooltip is about to hide - * use args.owner to get a reference to the widget - * use args.tooltip to get the string displayed in the tooltip - * use args.value to get the value of the cell the tooltip is displayed for - * use args.element to get a reference to the cell the tooltip is displayed for - * use args.index to get the row index of the cell the tooltip is displayed for - * use args.columnKey to get the column key of the cell the tooltip is displayed for - * use args.columnIndex to get the column index of the cell the tooltip is displayed for */ tooltipHiding?: TooltipHidingEvent; /** * Event fired after a tooltip is hidden - * use args.owner to get a reference to the widget - * use args.tooltip to get the string displayed in the tooltip - * use args.value to get the value of the cell the tooltip was displayed for - * use args.element to get a reference to the cell the tooltip was displayed for - * use args.index to get the row index of the cell the tooltip was displayed for - * use args.columnKey to get the column key of the cell the tooltip was displayed for - * use args.columnIndex to get the column index of the cell the tooltip was displayed for */ tooltipHidden?: TooltipHiddenEvent; @@ -50123,25 +55395,11 @@ interface JQuery { /** * Event fired when the mouse has hovered on an element long enough to display a tooltip - * use args.owner to get a reference to the widget - * use args.tooltip to get or set the string to be displayed - * use args.value to get the value of the cell the tooltip is displayed for - * use args.element to get a reference to the cell the tooltip is displayed for - * use args.index to get the row index of the cell the tooltip is displayed for - * use args.columnKey to get the column key of the cell the tooltip is displayed for - * use args.columnIndex to get the column index of the cell the tooltip is displayed for */ igGridTooltips(optionLiteral: 'option', optionName: "tooltipShowing"): TooltipShowingEvent; /** * Event fired when the mouse has hovered on an element long enough to display a tooltip - * use args.owner to get a reference to the widget - * use args.tooltip to get or set the string to be displayed - * use args.value to get the value of the cell the tooltip is displayed for - * use args.element to get a reference to the cell the tooltip is displayed for - * use args.index to get the row index of the cell the tooltip is displayed for - * use args.columnKey to get the column key of the cell the tooltip is displayed for - * use args.columnIndex to get the column index of the cell the tooltip is displayed for * * @optionValue Define event handler function. */ @@ -50149,25 +55407,11 @@ interface JQuery { /** * Event fired after a tooltip is shown - * use args.owner to get a reference to the widget - * use args.tooltip to get the string displayed in the tooltip - * use args.value to get the value of the cell the tooltip is displayed for - * use args.element to get a reference to the cell the tooltip is displayed for - * use args.index to get the row index of the cell the tooltip is displayed for - * use args.columnKey to get the column key of the cell the tooltip is displayed for - * use args.columnIndex to get the column index of the cell the tooltip is displayed for */ igGridTooltips(optionLiteral: 'option', optionName: "tooltipShown"): TooltipShownEvent; /** * Event fired after a tooltip is shown - * use args.owner to get a reference to the widget - * use args.tooltip to get the string displayed in the tooltip - * use args.value to get the value of the cell the tooltip is displayed for - * use args.element to get a reference to the cell the tooltip is displayed for - * use args.index to get the row index of the cell the tooltip is displayed for - * use args.columnKey to get the column key of the cell the tooltip is displayed for - * use args.columnIndex to get the column index of the cell the tooltip is displayed for * * @optionValue Define event handler function. */ @@ -50175,25 +55419,11 @@ interface JQuery { /** * Event fired when the mouse has left an element and the tooltip is about to hide - * use args.owner to get a reference to the widget - * use args.tooltip to get the string displayed in the tooltip - * use args.value to get the value of the cell the tooltip is displayed for - * use args.element to get a reference to the cell the tooltip is displayed for - * use args.index to get the row index of the cell the tooltip is displayed for - * use args.columnKey to get the column key of the cell the tooltip is displayed for - * use args.columnIndex to get the column index of the cell the tooltip is displayed for */ igGridTooltips(optionLiteral: 'option', optionName: "tooltipHiding"): TooltipHidingEvent; /** * Event fired when the mouse has left an element and the tooltip is about to hide - * use args.owner to get a reference to the widget - * use args.tooltip to get the string displayed in the tooltip - * use args.value to get the value of the cell the tooltip is displayed for - * use args.element to get a reference to the cell the tooltip is displayed for - * use args.index to get the row index of the cell the tooltip is displayed for - * use args.columnKey to get the column key of the cell the tooltip is displayed for - * use args.columnIndex to get the column index of the cell the tooltip is displayed for * * @optionValue Define event handler function. */ @@ -50201,25 +55431,11 @@ interface JQuery { /** * Event fired after a tooltip is hidden - * use args.owner to get a reference to the widget - * use args.tooltip to get the string displayed in the tooltip - * use args.value to get the value of the cell the tooltip was displayed for - * use args.element to get a reference to the cell the tooltip was displayed for - * use args.index to get the row index of the cell the tooltip was displayed for - * use args.columnKey to get the column key of the cell the tooltip was displayed for - * use args.columnIndex to get the column index of the cell the tooltip was displayed for */ igGridTooltips(optionLiteral: 'option', optionName: "tooltipHidden"): TooltipHiddenEvent; /** * Event fired after a tooltip is hidden - * use args.owner to get a reference to the widget - * use args.tooltip to get the string displayed in the tooltip - * use args.value to get the value of the cell the tooltip was displayed for - * use args.element to get a reference to the cell the tooltip was displayed for - * use args.index to get the row index of the cell the tooltip was displayed for - * use args.columnKey to get the column key of the cell the tooltip was displayed for - * use args.columnIndex to get the column index of the cell the tooltip was displayed for * * @optionValue Define event handler function. */ @@ -50436,20 +55652,6 @@ interface EditRowStartingEvent { } interface EditRowStartingEventUIParam { - /** - * Used to get a reference to GridUpdating. - */ - owner?: any; - - /** - * Used to get the row's PK value. - */ - rowID?: any; - - /** - * Used to check if the edit mode is for adding a new row. - */ - rowAdding?: any; } interface EditRowStartedEvent { @@ -50457,20 +55659,6 @@ interface EditRowStartedEvent { } interface EditRowStartedEventUIParam { - /** - * Used to get a reference to GridUpdating. - */ - owner?: any; - - /** - * Used to get the row's PK value. - */ - rowID?: any; - - /** - * Used to check if the edit mode is for adding a new row. - */ - rowAdding?: any; } interface EditRowEndingEvent { @@ -50478,35 +55666,6 @@ interface EditRowEndingEvent { } interface EditRowEndingEventUIParam { - /** - * Used to get a reference to GridUpdating. - */ - owner?: any; - - /** - * Used to get the row's PK value. - */ - rowID?: any; - - /** - * Used to check if any of the values is changed which will cause update in the data source. Can be manually set to false to prevent this update. - */ - update?: any; - - /** - * Used to check if the edit mode is for adding a new row. - */ - rowAdding?: any; - - /** - * Used to get or set the new value for the column with the specified key. - */ - values?: any; - - /** - * Used to get the old value for the column with the specified key. - */ - oldValues?: any; } interface EditRowEndedEvent { @@ -50514,35 +55673,6 @@ interface EditRowEndedEvent { } interface EditRowEndedEventUIParam { - /** - * Used to get a reference to GridUpdating. - */ - owner?: any; - - /** - * Used to get the row's PK value. - */ - rowID?: any; - - /** - * Used to check if any of the values is changed which will cause update in the data source. - */ - update?: any; - - /** - * Used to check if the edit mode is for adding a new row. - */ - rowAdding?: any; - - /** - * Used to get the new value for the column with the specified key. - */ - values?: any; - - /** - * Used to get the old value for the column with the specified key. - */ - oldValues?: any; } interface EditCellStartingEvent { @@ -50550,40 +55680,6 @@ interface EditCellStartingEvent { } interface EditCellStartingEventUIParam { - /** - * Used to get a reference to GridUpdating. - */ - owner?: any; - - /** - * Used to get the row's PK value. - */ - rowID?: any; - - /** - * Used to get the index of the column. - */ - columnIndex?: any; - - /** - * Used to get the key of the column. - */ - columnKey?: any; - - /** - * Used tor to get a reference to the editor used for editing the column. - */ - editor?: any; - - /** - * Used to get or set the value of the editor. - */ - value?: any; - - /** - * Used to check if the edit mode is for adding a new row. - */ - rowAdding?: any; } interface EditCellStartedEvent { @@ -50591,40 +55687,6 @@ interface EditCellStartedEvent { } interface EditCellStartedEventUIParam { - /** - * Used to get a reference to GridUpdating. - */ - owner?: any; - - /** - * Used to get the row's PK value. - */ - rowID?: any; - - /** - * Used to get the index of the column. - */ - columnIndex?: any; - - /** - * Used to get the key of the column. - */ - columnKey?: any; - - /** - * Used tor to get a reference to the editor used for editing the column. - */ - editor?: any; - - /** - * Used to get the value of the editor. - */ - value?: any; - - /** - * Used to check if the edit mode is for adding a new row. - */ - rowAdding?: any; } interface EditCellEndingEvent { @@ -50632,50 +55694,6 @@ interface EditCellEndingEvent { } interface EditCellEndingEventUIParam { - /** - * Used to get a reference to GridUpdating. - */ - owner?: any; - - /** - * Used to get the row's PK value. - */ - rowID?: any; - - /** - * Used to get the index of the column. - */ - columnIndex?: any; - - /** - * Used to get the key of the column. - */ - columnKey?: any; - - /** - * Used tor to get a reference to the editor used for editing the column. - */ - editor?: any; - - /** - * Used to get or set the value to be used when updating the data source. - */ - value?: any; - - /** - * Used to get the old value. - */ - oldValue?: any; - - /** - * Used to check if the value is changed which will cause update in the data source. Can be manually set to false to prevent this update. - */ - update?: any; - - /** - * Used to check if the edit mode is for adding a new row. - */ - rowAdding?: any; } interface EditCellEndedEvent { @@ -50683,50 +55701,6 @@ interface EditCellEndedEvent { } interface EditCellEndedEventUIParam { - /** - * Used to get a reference to GridUpdating. - */ - owner?: any; - - /** - * Used to get the row's PK value. - */ - rowID?: any; - - /** - * Used to get the index of the column. - */ - columnIndex?: any; - - /** - * Used to get the key of the column. - */ - columnKey?: any; - - /** - * Used tor to get a reference to the editor used for editing the column. - */ - editor?: any; - - /** - * Used to get the new value. - */ - value?: any; - - /** - * Used to get the old value. - */ - oldValue?: any; - - /** - * Used to check if the value is changed which will cause update in the data source. - */ - update?: any; - - /** - * Used to check if the edit mode is for adding a new row. - */ - rowAdding?: any; } interface RowAddingEvent { @@ -50734,20 +55708,6 @@ interface RowAddingEvent { } interface RowAddingEventUIParam { - /** - * Used to get a reference to GridUpdating. - */ - owner?: any; - - /** - * Used to get the value for the column with the specified key. - */ - values?: any; - - /** - * Used to get the default value (before editing) for the column with the specified key. - */ - oldValues?: any; } interface RowAddedEvent { @@ -50755,20 +55715,6 @@ interface RowAddedEvent { } interface RowAddedEventUIParam { - /** - * Used to get a reference to GridUpdating. - */ - owner?: any; - - /** - * Used to get the value for the column with the specified key. - */ - values?: any; - - /** - * Used to get the default value (before editing) for the column with the specified key. - */ - oldValues?: any; } interface RowDeletingEvent { @@ -50776,20 +55722,6 @@ interface RowDeletingEvent { } interface RowDeletingEventUIParam { - /** - * Used to get a reference to GridUpdating. - */ - owner?: any; - - /** - * Used to get a jQuery object containing the TR element of the row to delete. - */ - element?: any; - - /** - * Used to get the row's PK value. - */ - rowID?: any; } interface RowDeletedEvent { @@ -50797,20 +55729,6 @@ interface RowDeletedEvent { } interface RowDeletedEventUIParam { - /** - * Used to get a reference to GridUpdating. - */ - owner?: any; - - /** - * Used to get a jQuery object containing the TR element of the deleted row. - */ - element?: any; - - /** - * Used to get the row's PK value. - */ - rowID?: any; } interface DataDirtyEvent { @@ -50818,10 +55736,6 @@ interface DataDirtyEvent { } interface DataDirtyEventUIParam { - /** - * Used to get a reference to GridUpdating. - */ - owner?: any; } interface GeneratePrimaryKeyValueEvent { @@ -50829,15 +55743,6 @@ interface GeneratePrimaryKeyValueEvent { } interface GeneratePrimaryKeyValueEventUIParam { - /** - * Used to get a reference to GridUpdating. - */ - owner?: any; - - /** - * Used to get the auto-generated primary key (the number of records in the data source + 1) or set a custom unique primary key for the new row. - */ - value?: any; } interface RowEditDialogBeforeOpenEvent { @@ -50845,15 +55750,6 @@ interface RowEditDialogBeforeOpenEvent { } interface RowEditDialogBeforeOpenEventUIParam { - /** - * Used to get a reference to GridUpdating. - */ - owner?: any; - - /** - * Used to get reference to row edit dialog DOM element. - */ - dialogElement?: any; } interface RowEditDialogAfterOpenEvent { @@ -50861,15 +55757,6 @@ interface RowEditDialogAfterOpenEvent { } interface RowEditDialogAfterOpenEventUIParam { - /** - * Used to get a reference to GridUpdating. - */ - owner?: any; - - /** - * Used to get reference to row edit dialog DOM element. - */ - dialogElement?: any; } interface RowEditDialogBeforeCloseEvent { @@ -50877,15 +55764,6 @@ interface RowEditDialogBeforeCloseEvent { } interface RowEditDialogBeforeCloseEventUIParam { - /** - * Used to get a reference to GridUpdating. - */ - owner?: any; - - /** - * Used to get reference to row edit dialog DOM element. - */ - dialogElement?: any; } interface RowEditDialogAfterCloseEvent { @@ -50893,15 +55771,6 @@ interface RowEditDialogAfterCloseEvent { } interface RowEditDialogAfterCloseEventUIParam { - /** - * Used to get a reference to GridUpdating. - */ - owner?: any; - - /** - * Used to get reference to row edit dialog DOM element. - */ - dialogElement?: any; } interface RowEditDialogContentsRenderedEvent { @@ -50909,15 +55778,6 @@ interface RowEditDialogContentsRenderedEvent { } interface RowEditDialogContentsRenderedEventUIParam { - /** - * Used to get a reference to GridUpdating. - */ - owner?: any; - - /** - * Used to get reference to row edit dialog DOM element. - */ - dialogElement?: any; } interface IgGridUpdating { @@ -51018,7 +55878,7 @@ interface IgGridUpdating { enableDataDirtyException?: boolean; /** - * Specifies how end-users are able to start edit mode. Possible values: "click", "dblclick", "F2", "enter" and their combinations separated by comma 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. + * Specifies 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. * */ startEditTriggers?: string|Array; @@ -51079,215 +55939,102 @@ interface IgGridUpdating { /** * Event fired before row editing begins. * Return false in order to cancel editing. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.rowAdding to check if the edit mode is for adding a new row. */ editRowStarting?: EditRowStartingEvent; /** * Event fired after row editing begins. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.rowAdding to check if the edit mode is for adding a new row. */ editRowStarted?: EditRowStartedEvent; /** * Event fired before row editing ends. * Return false in order to prevent the grid from exiting edit mode. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.update to check if any of the values is changed which will cause update in the data source. Can be manually set to false to prevent this update. - * Use ui.rowAdding to check if the edit mode is for adding a new row. - * Use ui.values[key] to get or set the new value for the column with the specified key. - * Use ui.oldValues[key] to get the old value for the column with the specified key. */ editRowEnding?: EditRowEndingEvent; /** * Event fired after row editing ends. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.update to check if any of the values is changed which will cause update in the data source. - * Use ui.rowAdding to check if the edit mode is for adding a new row. - * Use ui.values[key] to get the new value for the column with the specified key. - * Use ui.oldValues[key] to get the old value for the column with the specified key. */ editRowEnded?: EditRowEndedEvent; /** * Event fired before cell editing begins (including when row editing opens editing for a cell). * Return false in order to cancel editing. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.columnIndex to get the index of the column. - * Use ui.columnKey to get the key of the column. - * Use ui.editor to get a reference to the editor used for editing the column. - * Use ui.value to get or set the value of the editor. - * Use ui.rowAdding to check if the edit mode is for adding a new row. */ editCellStarting?: EditCellStartingEvent; /** * Event fired after cell editing begins (including when row editing opens editing for a cell). - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.columnIndex to get the index of the column. - * Use ui.columnKey to get the key of the column. - * Use ui.editor to get a reference to the editor used for editing the column. - * Use ui.value to get the value of the editor. - * Use ui.rowAdding to check if the edit mode is for adding a new row. */ editCellStarted?: EditCellStartedEvent; /** * Event fired before cell editing ends (including when row editing closes editing for a cell). * Return false in order to prevent the grid from exiting edit mode (only functions if [editMode](ui.iggridupdating#options:editMode) is 'cell'). - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.columnIndex to get the index of the column. - * Use ui.columnKey to get the key of the column. - * Use ui.editor to get a reference to the editor used for editing the column. - * Use ui.value to get or set the value to be used when updating the data source. - * Use ui.oldValue to get the old value. - * Use ui.update to check if the value is changed which will cause update in the data source. Can be manually set to false to prevent this update. - * Use ui.rowAdding to check if the edit mode is for adding a new row. */ editCellEnding?: EditCellEndingEvent; /** * Event fired after cell editing ends (including when row editing closes editing for a cell). - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.columnIndex to get the index of the column. - * Use ui.columnKey to get the key of the column. - * Use ui.editor to get a reference to the editor used for editing the column. - * Use ui.value to get the new value. - * Use ui.oldValue to get the old value. - * Use ui.update to check if the value is changed which will cause update in the data source. - * Use ui.rowAdding to check if the edit mode is for adding a new row. */ editCellEnded?: EditCellEndedEvent; /** * Event fired before adding a new row. * Return false in order to cancel the adding of the new row to the data source. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.values[key] to get the value for the column with the specified key. - * Use ui.oldValues[key] to get the default value (before editing) for the column with the specified key. */ rowAdding?: RowAddingEvent; /** * Event fired after adding a new row. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.values[key] to get the value for the column with the specified key. - * Use ui.oldValues[key] to get the default value (before editing) for the column with the specified key. */ rowAdded?: RowAddedEvent; /** * Event fired before deleting a row. * Return false in order to cancel the row's deletion. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.element to get a jQuery object containing the TR element of the row to delete. - * Use ui.rowID to get the row's PK value. */ rowDeleting?: RowDeletingEvent; /** * Event fired after a row is deleted. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.element to get a jQuery object containing the TR element of the deleted row. - * Use ui.rowID to get the row's PK value. */ rowDeleted?: RowDeletedEvent; /** * Event fired before the dataDirtyException is thrown. This can be controlled by the [enableDataDirtyException](ui.iggridupdating#options:enableDataDirtyException) property. Any pending changes may be committed in the handler of this event in order to prevent dataDirtyException from being thrown. * Return false in order to prevent the exception. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. */ dataDirty?: DataDirtyEvent; /** * Event fired before editing starts for adding a new row, when Updating generates an automatic primary key for it. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.value to get the auto-generated primary key (the number of records in the data source + 1) or set a custom unique primary key for the new row. */ generatePrimaryKeyValue?: GeneratePrimaryKeyValueEvent; /** * Event fired before the row edit dialog is opened. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.dialogElement to get reference to row edit dialog DOM element. */ rowEditDialogBeforeOpen?: RowEditDialogBeforeOpenEvent; /** * Event fired after the row edit dialog is opened. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.dialogElement to get reference to row edit dialog DOM element. */ rowEditDialogAfterOpen?: RowEditDialogAfterOpenEvent; /** * Event fired before the row edit dialog is closed. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.dialogElement to get reference to row edit dialog DOM element. */ rowEditDialogBeforeClose?: RowEditDialogBeforeCloseEvent; /** * Event fired after the row edit dialog is closed. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.dialogElement to get reference to row edit dialog DOM element. */ rowEditDialogAfterClose?: RowEditDialogAfterCloseEvent; /** * Event fired after the row edit dialog is rendered. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.dialogElement to get reference to row edit dialog DOM element. */ rowEditDialogContentsRendered?: RowEditDialogContentsRenderedEvent; @@ -51627,13 +56374,13 @@ interface JQuery { igGridUpdating(optionLiteral: 'option', optionName: "enableDataDirtyException", optionValue: boolean): void; /** - * Gets how end-users are able to start edit mode. Possible values: "click", "dblclick", "F2", "enter" and their combinations separated by comma 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. + * 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; /** - * Sets how end-users are able to start edit mode. Possible values: "click", "dblclick", "F2", "enter" and their combinations separated by comma 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. + * Sets 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. * * * @optionValue New value to be set. @@ -51767,22 +56514,12 @@ interface JQuery { /** * Event fired before row editing begins. * Return false in order to cancel editing. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.rowAdding to check if the edit mode is for adding a new row. */ igGridUpdating(optionLiteral: 'option', optionName: "editRowStarting"): EditRowStartingEvent; /** * Event fired before row editing begins. * Return false in order to cancel editing. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.rowAdding to check if the edit mode is for adding a new row. * * @optionValue Define event handler function. */ @@ -51790,21 +56527,11 @@ interface JQuery { /** * Event fired after row editing begins. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.rowAdding to check if the edit mode is for adding a new row. */ igGridUpdating(optionLiteral: 'option', optionName: "editRowStarted"): EditRowStartedEvent; /** * Event fired after row editing begins. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.rowAdding to check if the edit mode is for adding a new row. * * @optionValue Define event handler function. */ @@ -51813,28 +56540,12 @@ interface JQuery { /** * Event fired before row editing ends. * Return false in order to prevent the grid from exiting edit mode. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.update to check if any of the values is changed which will cause update in the data source. Can be manually set to false to prevent this update. - * Use ui.rowAdding to check if the edit mode is for adding a new row. - * Use ui.values[key] to get or set the new value for the column with the specified key. - * Use ui.oldValues[key] to get the old value for the column with the specified key. */ igGridUpdating(optionLiteral: 'option', optionName: "editRowEnding"): EditRowEndingEvent; /** * Event fired before row editing ends. * Return false in order to prevent the grid from exiting edit mode. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.update to check if any of the values is changed which will cause update in the data source. Can be manually set to false to prevent this update. - * Use ui.rowAdding to check if the edit mode is for adding a new row. - * Use ui.values[key] to get or set the new value for the column with the specified key. - * Use ui.oldValues[key] to get the old value for the column with the specified key. * * @optionValue Define event handler function. */ @@ -51842,27 +56553,11 @@ interface JQuery { /** * Event fired after row editing ends. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.update to check if any of the values is changed which will cause update in the data source. - * Use ui.rowAdding to check if the edit mode is for adding a new row. - * Use ui.values[key] to get the new value for the column with the specified key. - * Use ui.oldValues[key] to get the old value for the column with the specified key. */ igGridUpdating(optionLiteral: 'option', optionName: "editRowEnded"): EditRowEndedEvent; /** * Event fired after row editing ends. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.update to check if any of the values is changed which will cause update in the data source. - * Use ui.rowAdding to check if the edit mode is for adding a new row. - * Use ui.values[key] to get the new value for the column with the specified key. - * Use ui.oldValues[key] to get the old value for the column with the specified key. * * @optionValue Define event handler function. */ @@ -51871,30 +56566,12 @@ interface JQuery { /** * Event fired before cell editing begins (including when row editing opens editing for a cell). * Return false in order to cancel editing. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.columnIndex to get the index of the column. - * Use ui.columnKey to get the key of the column. - * Use ui.editor to get a reference to the editor used for editing the column. - * Use ui.value to get or set the value of the editor. - * Use ui.rowAdding to check if the edit mode is for adding a new row. */ igGridUpdating(optionLiteral: 'option', optionName: "editCellStarting"): EditCellStartingEvent; /** * Event fired before cell editing begins (including when row editing opens editing for a cell). * Return false in order to cancel editing. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.columnIndex to get the index of the column. - * Use ui.columnKey to get the key of the column. - * Use ui.editor to get a reference to the editor used for editing the column. - * Use ui.value to get or set the value of the editor. - * Use ui.rowAdding to check if the edit mode is for adding a new row. * * @optionValue Define event handler function. */ @@ -51902,29 +56579,11 @@ interface JQuery { /** * Event fired after cell editing begins (including when row editing opens editing for a cell). - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.columnIndex to get the index of the column. - * Use ui.columnKey to get the key of the column. - * Use ui.editor to get a reference to the editor used for editing the column. - * Use ui.value to get the value of the editor. - * Use ui.rowAdding to check if the edit mode is for adding a new row. */ igGridUpdating(optionLiteral: 'option', optionName: "editCellStarted"): EditCellStartedEvent; /** * Event fired after cell editing begins (including when row editing opens editing for a cell). - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.columnIndex to get the index of the column. - * Use ui.columnKey to get the key of the column. - * Use ui.editor to get a reference to the editor used for editing the column. - * Use ui.value to get the value of the editor. - * Use ui.rowAdding to check if the edit mode is for adding a new row. * * @optionValue Define event handler function. */ @@ -51933,34 +56592,12 @@ interface JQuery { /** * Event fired before cell editing ends (including when row editing closes editing for a cell). * Return false in order to prevent the grid from exiting edit mode (only functions if [editMode](ui.iggridupdating#options:editMode) is 'cell'). - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.columnIndex to get the index of the column. - * Use ui.columnKey to get the key of the column. - * Use ui.editor to get a reference to the editor used for editing the column. - * Use ui.value to get or set the value to be used when updating the data source. - * Use ui.oldValue to get the old value. - * Use ui.update to check if the value is changed which will cause update in the data source. Can be manually set to false to prevent this update. - * Use ui.rowAdding to check if the edit mode is for adding a new row. */ igGridUpdating(optionLiteral: 'option', optionName: "editCellEnding"): EditCellEndingEvent; /** * Event fired before cell editing ends (including when row editing closes editing for a cell). * Return false in order to prevent the grid from exiting edit mode (only functions if [editMode](ui.iggridupdating#options:editMode) is 'cell'). - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.columnIndex to get the index of the column. - * Use ui.columnKey to get the key of the column. - * Use ui.editor to get a reference to the editor used for editing the column. - * Use ui.value to get or set the value to be used when updating the data source. - * Use ui.oldValue to get the old value. - * Use ui.update to check if the value is changed which will cause update in the data source. Can be manually set to false to prevent this update. - * Use ui.rowAdding to check if the edit mode is for adding a new row. * * @optionValue Define event handler function. */ @@ -51968,33 +56605,11 @@ interface JQuery { /** * Event fired after cell editing ends (including when row editing closes editing for a cell). - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.columnIndex to get the index of the column. - * Use ui.columnKey to get the key of the column. - * Use ui.editor to get a reference to the editor used for editing the column. - * Use ui.value to get the new value. - * Use ui.oldValue to get the old value. - * Use ui.update to check if the value is changed which will cause update in the data source. - * Use ui.rowAdding to check if the edit mode is for adding a new row. */ igGridUpdating(optionLiteral: 'option', optionName: "editCellEnded"): EditCellEndedEvent; /** * Event fired after cell editing ends (including when row editing closes editing for a cell). - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.columnIndex to get the index of the column. - * Use ui.columnKey to get the key of the column. - * Use ui.editor to get a reference to the editor used for editing the column. - * Use ui.value to get the new value. - * Use ui.oldValue to get the old value. - * Use ui.update to check if the value is changed which will cause update in the data source. - * Use ui.rowAdding to check if the edit mode is for adding a new row. * * @optionValue Define event handler function. */ @@ -52003,22 +56618,12 @@ interface JQuery { /** * Event fired before adding a new row. * Return false in order to cancel the adding of the new row to the data source. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.values[key] to get the value for the column with the specified key. - * Use ui.oldValues[key] to get the default value (before editing) for the column with the specified key. */ igGridUpdating(optionLiteral: 'option', optionName: "rowAdding"): RowAddingEvent; /** * Event fired before adding a new row. * Return false in order to cancel the adding of the new row to the data source. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.values[key] to get the value for the column with the specified key. - * Use ui.oldValues[key] to get the default value (before editing) for the column with the specified key. * * @optionValue Define event handler function. */ @@ -52026,21 +56631,11 @@ interface JQuery { /** * Event fired after adding a new row. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.values[key] to get the value for the column with the specified key. - * Use ui.oldValues[key] to get the default value (before editing) for the column with the specified key. */ igGridUpdating(optionLiteral: 'option', optionName: "rowAdded"): RowAddedEvent; /** * Event fired after adding a new row. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.values[key] to get the value for the column with the specified key. - * Use ui.oldValues[key] to get the default value (before editing) for the column with the specified key. * * @optionValue Define event handler function. */ @@ -52049,22 +56644,12 @@ interface JQuery { /** * Event fired before deleting a row. * Return false in order to cancel the row's deletion. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.element to get a jQuery object containing the TR element of the row to delete. - * Use ui.rowID to get the row's PK value. */ igGridUpdating(optionLiteral: 'option', optionName: "rowDeleting"): RowDeletingEvent; /** * Event fired before deleting a row. * Return false in order to cancel the row's deletion. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.element to get a jQuery object containing the TR element of the row to delete. - * Use ui.rowID to get the row's PK value. * * @optionValue Define event handler function. */ @@ -52072,21 +56657,11 @@ interface JQuery { /** * Event fired after a row is deleted. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.element to get a jQuery object containing the TR element of the deleted row. - * Use ui.rowID to get the row's PK value. */ igGridUpdating(optionLiteral: 'option', optionName: "rowDeleted"): RowDeletedEvent; /** * Event fired after a row is deleted. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.element to get a jQuery object containing the TR element of the deleted row. - * Use ui.rowID to get the row's PK value. * * @optionValue Define event handler function. */ @@ -52095,18 +56670,12 @@ interface JQuery { /** * Event fired before the dataDirtyException is thrown. This can be controlled by the [enableDataDirtyException](ui.iggridupdating#options:enableDataDirtyException) property. Any pending changes may be committed in the handler of this event in order to prevent dataDirtyException from being thrown. * Return false in order to prevent the exception. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. */ igGridUpdating(optionLiteral: 'option', optionName: "dataDirty"): DataDirtyEvent; /** * Event fired before the dataDirtyException is thrown. This can be controlled by the [enableDataDirtyException](ui.iggridupdating#options:enableDataDirtyException) property. Any pending changes may be committed in the handler of this event in order to prevent dataDirtyException from being thrown. * Return false in order to prevent the exception. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. * * @optionValue Define event handler function. */ @@ -52114,19 +56683,11 @@ interface JQuery { /** * Event fired before editing starts for adding a new row, when Updating generates an automatic primary key for it. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.value to get the auto-generated primary key (the number of records in the data source + 1) or set a custom unique primary key for the new row. */ igGridUpdating(optionLiteral: 'option', optionName: "generatePrimaryKeyValue"): GeneratePrimaryKeyValueEvent; /** * Event fired before editing starts for adding a new row, when Updating generates an automatic primary key for it. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.value to get the auto-generated primary key (the number of records in the data source + 1) or set a custom unique primary key for the new row. * * @optionValue Define event handler function. */ @@ -52134,19 +56695,11 @@ interface JQuery { /** * Event fired before the row edit dialog is opened. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.dialogElement to get reference to row edit dialog DOM element. */ igGridUpdating(optionLiteral: 'option', optionName: "rowEditDialogBeforeOpen"): RowEditDialogBeforeOpenEvent; /** * Event fired before the row edit dialog is opened. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.dialogElement to get reference to row edit dialog DOM element. * * @optionValue Define event handler function. */ @@ -52154,19 +56707,11 @@ interface JQuery { /** * Event fired after the row edit dialog is opened. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.dialogElement to get reference to row edit dialog DOM element. */ igGridUpdating(optionLiteral: 'option', optionName: "rowEditDialogAfterOpen"): RowEditDialogAfterOpenEvent; /** * Event fired after the row edit dialog is opened. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.dialogElement to get reference to row edit dialog DOM element. * * @optionValue Define event handler function. */ @@ -52174,19 +56719,11 @@ interface JQuery { /** * Event fired before the row edit dialog is closed. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.dialogElement to get reference to row edit dialog DOM element. */ igGridUpdating(optionLiteral: 'option', optionName: "rowEditDialogBeforeClose"): RowEditDialogBeforeCloseEvent; /** * Event fired before the row edit dialog is closed. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.dialogElement to get reference to row edit dialog DOM element. * * @optionValue Define event handler function. */ @@ -52194,19 +56731,11 @@ interface JQuery { /** * Event fired after the row edit dialog is closed. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.dialogElement to get reference to row edit dialog DOM element. */ igGridUpdating(optionLiteral: 'option', optionName: "rowEditDialogAfterClose"): RowEditDialogAfterCloseEvent; /** * Event fired after the row edit dialog is closed. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.dialogElement to get reference to row edit dialog DOM element. * * @optionValue Define event handler function. */ @@ -52214,19 +56743,11 @@ interface JQuery { /** * Event fired after the row edit dialog is rendered. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.dialogElement to get reference to row edit dialog DOM element. */ igGridUpdating(optionLiteral: 'option', optionName: "rowEditDialogContentsRendered"): RowEditDialogContentsRenderedEvent; /** * Event fired after the row edit dialog is rendered. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.dialogElement to get reference to row edit dialog DOM element. * * @optionValue Define event handler function. */ @@ -52663,26 +57184,26 @@ interface JQuery { } declare namespace Infragistics { - class SelectionWrapper { - constructor(NODE: any); - getSelectedItem(): void; - getSelectionAsText(): void; - select(element: Object): void; - insertElement(element: Object): void; - execCommand(name: Object, args: Object): void; - replaceNode(newNode: Object): void; - insertTable(table: Object): void; - focus(): void; - } +class SelectionWrapper { + constructor(NODE: any); + getSelectedItem(): void; + getSelectionAsText(): void; + select(element: Object): void; + insertElement(element: Object): void; + execCommand(name: Object, args: Object): void; + replaceNode(newNode: Object): void; + insertTable(table: Object): void; + focus(): void; +} } interface IgniteUIStatic { - SelectionWrapper: typeof Infragistics.SelectionWrapper; +SelectionWrapper: typeof Infragistics.SelectionWrapper; } declare namespace Infragistics { - class ToolbarHelper { - analyse(el: Object): void; - } +class ToolbarHelper { + analyse(el: Object): void; +} } interface JQuery { @@ -53375,7 +57896,7 @@ interface IgLayoutManagerGridLayout { /** * Specified whether the items should rearrange to fit in the container when it is resized. - * Have effect only when fixed columnWidth option is set. + * Have effect only when fixed columnWidth option is set. * */ rearrangeItems?: boolean; @@ -53407,7 +57928,7 @@ interface IgLayoutManagerItem { /** * Gets/Sets individual item height, either in px or percentage - * string The default height can be set in pixels (px), %, em and other units. + * string The default height can be set in pixels (px), %, em and other units. * */ height?: string; @@ -53426,7 +57947,7 @@ interface IgLayoutManagerItem { /** * Gets/Sets individual item width, either in px or percentage - * string The default width can be set in pixels (px), %, em and other units. + * string The default width can be set in pixels (px), %, em and other units. * */ width?: number; @@ -53538,23 +58059,23 @@ interface IgLayoutManager { /** * An array of item descriptions - * this assumes the container is empty, and every item - * is described by rowspan, colspan, etc. - otherwise values of - * 1 are assumed - * items can have various properties some of which may not be applicable - * depending on the layoutMode. - * for example rowSpan/colSpan/colIndex/rowIndex are only applicable to gridlayout + * this assumes the container is empty, and every item + * is described by rowspan, colspan, etc. - otherwise values of + * 1 are assumed + * items can have various properties some of which may not be applicable + * depending on the layoutMode. + * for example rowSpan/colSpan/colIndex/rowIndex are only applicable to gridlayout * */ items?: IgLayoutManagerItem[]; /** * Defines the layout type - * grid Column type can be set with grid layout - * border Column type can be set with border layout - * flow Column type can be set with flow layout - * column Column type can be set with column layout - * vertical Column type can be set with vertical layout + * grid Column type can be set with grid layout + * border Column type can be set with border layout + * flow Column type can be set with flow layout + * column Column type can be set with column layout + * vertical Column type can be set with vertical layout * * * Valid values: @@ -53574,40 +58095,40 @@ interface IgLayoutManager { /** * Event fired after items are resized. - * Use ui.owner to get a reference to the layout manager performing resizing. + * Use ui.owner to get a reference to the layout manager performing resizing. */ internalResized?: InternalResizedEvent; /** * Event fired before items are resized. - * Use ui.owner to get a reference to the layout manager performing resizing. + * Use ui.owner to get a reference to the layout manager performing resizing. */ internalResizing?: InternalResizingEvent; /** * Event fired after an item has been rendered in the container. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to the igLayoutManager. - * Use ui.itemData to get a reference of item's settings, such as colspan ,rowspan, etc. - * Use ui.index to get a reference of the item's index, if the layout is flow or vertical - * Use ui.item to get a reference to the rendered item + * Function takes arguments evt and ui. + * Use ui.owner to get reference to the igLayoutManager. + * Use ui.itemData to get a reference of item's settings, such as colspan ,rowspan, etc. + * Use ui.index to get a reference of the item's index, if the layout is flow or vertical + * Use ui.item to get a reference to the rendered item */ itemRendered?: ItemRenderedEvent; /** * Event fired before an item is rendered in the container. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to the igLayoutManager. - * Use ui.itemData to get a reference of item's settings, such as colspan ,rowspan, etc. - * Use ui.index to get a reference of the item's index, if the layout is flow or vertical - * Use ui.item to get a reference to the rendered item + * Function takes arguments evt and ui. + * Use ui.owner to get reference to the igLayoutManager. + * Use ui.itemData to get a reference of item's settings, such as colspan ,rowspan, etc. + * Use ui.index to get a reference of the item's index, if the layout is flow or vertical + * Use ui.item to get a reference to the rendered item */ itemRendering?: ItemRenderingEvent; /** * Event fired after all items are rendered. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to the igLayoutManager. + * Function takes arguments evt and ui. + * Use ui.owner to get reference to the igLayoutManager. */ rendered?: RenderedEvent; @@ -53619,7 +58140,7 @@ interface IgLayoutManager { interface IgLayoutManagerMethods { /** * Triggers recalculation of the layout dimensions. Layouts may not need to be reflowed manually, if their sizes are in percentages (i.e. they are responsive by default) - * this can be particularly useful with a grid layout, when the container has percentage sizes, but items are calculated in pixels and positioned absolutely in the container. + * this can be particularly useful with a grid layout, when the container has percentage sizes, but items are calculated in pixels and positioned absolutely in the container. * * @param forceReflow Indicates whether the reflow should be forced. Useful in cases where the items size and position was changed manually. * @param animationDuration The animation duration to be used for this reflow only. Supported only for Grid Layout mode. @@ -53629,9 +58150,9 @@ interface IgLayoutManagerMethods { /** * Destroy is part of the jQuery UI widget API and does the following: - * 1. Remove custom CSS classes that were added. - * 2. Remove any elements that were added at widget's initialization and after that, which didn't below to the original markup - * 3. Unbind all events that were bound. + * 1. Remove custom CSS classes that were added. + * 2. Remove any elements that were added at widget's initialization and after that, which didn't below to the original markup + * 3. Unbind all events that were bound. */ destroy(): void; } @@ -53701,24 +58222,24 @@ interface JQuery { /** * An array of item descriptions - * this assumes the container is empty, and every item - * is described by rowspan, colspan, etc. - otherwise values of - * 1 are assumed - * items can have various properties some of which may not be applicable - * depending on the layoutMode. - * for example rowSpan/colSpan/colIndex/rowIndex are only applicable to gridlayout + * this assumes the container is empty, and every item + * is described by rowspan, colspan, etc. - otherwise values of + * 1 are assumed + * items can have various properties some of which may not be applicable + * depending on the layoutMode. + * for example rowSpan/colSpan/colIndex/rowIndex are only applicable to gridlayout * */ igLayoutManager(optionLiteral: 'option', optionName: "items"): IgLayoutManagerItem[]; /** * An array of item descriptions - * this assumes the container is empty, and every item - * is described by rowspan, colspan, etc. - otherwise values of - * 1 are assumed - * items can have various properties some of which may not be applicable - * depending on the layoutMode. - * for example rowSpan/colSpan/colIndex/rowIndex are only applicable to gridlayout + * this assumes the container is empty, and every item + * is described by rowspan, colspan, etc. - otherwise values of + * 1 are assumed + * items can have various properties some of which may not be applicable + * depending on the layoutMode. + * for example rowSpan/colSpan/colIndex/rowIndex are only applicable to gridlayout * * * @optionValue New value to be set. @@ -53727,22 +58248,22 @@ interface JQuery { /** * Defines the layout type - * grid Column type can be set with grid layout - * border Column type can be set with border layout - * flow Column type can be set with flow layout - * column Column type can be set with column layout - * vertical Column type can be set with vertical layout + * grid Column type can be set with grid layout + * border Column type can be set with border layout + * flow Column type can be set with flow layout + * column Column type can be set with column layout + * vertical Column type can be set with vertical layout * */ igLayoutManager(optionLiteral: 'option', optionName: "layoutMode"): any; /** * Defines the layout type - * grid Column type can be set with grid layout - * border Column type can be set with border layout - * flow Column type can be set with flow layout - * column Column type can be set with column layout - * vertical Column type can be set with vertical layout + * grid Column type can be set with grid layout + * border Column type can be set with border layout + * flow Column type can be set with flow layout + * column Column type can be set with column layout + * vertical Column type can be set with vertical layout * * * @optionValue New value to be set. @@ -53765,13 +58286,13 @@ interface JQuery { /** * Event fired after items are resized. - * Use ui.owner to get a reference to the layout manager performing resizing. + * Use ui.owner to get a reference to the layout manager performing resizing. */ igLayoutManager(optionLiteral: 'option', optionName: "internalResized"): InternalResizedEvent; /** * Event fired after items are resized. - * Use ui.owner to get a reference to the layout manager performing resizing. + * Use ui.owner to get a reference to the layout manager performing resizing. * * @optionValue Define event handler function. */ @@ -53779,7 +58300,7 @@ interface JQuery { /** * Event fired before items are resized. - * Use ui.owner to get a reference to the layout manager performing resizing. + * Use ui.owner to get a reference to the layout manager performing resizing. */ igLayoutManager(optionLiteral: 'option', optionName: "internalResizing"): InternalResizingEvent; @@ -53947,8 +58468,8 @@ interface IgLinearGauge { * Gets or sets the orientation of the scale. * * Valid values: - * "horizontal" - * "vertical" + * "horizontal" The scale has a horizontal orientation. + * "vertical" The scale has a vertical orientation. */ orientation?: string; @@ -53983,11 +58504,11 @@ interface IgLinearGauge { * Gets or sets the shape to use when rendering the needle from a number of options. * * Valid values: - * "custom" - * "rectangle" - * "triangle" - * "needle" - * "trapezoid" + * "custom" A custom user defined needle shape. + * "rectangle" A needle shaped like a rectangle. + * "triangle" A needle shaped like a triangle. + * "needle" A needle shaped like a needle. + * "trapezoid" A needle shaped like a trapezoid. */ needleShape?: string; @@ -54256,10 +58777,36 @@ interface IgLinearGauge { font?: string; /** - * Gets or sets the pixel scaling ratio for the gauge. + * 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; + + /** + * Event which is raised when a label of the the gauge is formatted. + * Function takes first argument evt and second argument ui. + * Use ui.owner to obtain reference to the gauge widget. + * Use ui.actualMinimumValue to obtain the minimum value of the gauge scale. + * Use ui.actualMaximumValue to obtain the maximum value of the gauge scale. + * Use ui.value to obtain the value on the the gauge scale associated with the label. + * Use ui.label to obtain the string value of the label. + */ formatLabel?: FormatLabelEvent; + + /** + * Event which is raised when a label of the linear gauge is aligned along the scale. + * Function takes first argument evt and second argument ui. + * Use ui.owner to obtain reference to the gauge widget. + * Use ui.actualMinimumValue to obtain the minimum value of the gauge scale. + * Use ui.actualMaximumValue to obtain the maximum value of the gauge scale. + * Use ui.value to obtain the value on the gauge scale associated with the label. + * Use ui.label to obtain the string value of the label. + * Use ui.width to obtain the width of the label. + * Use ui.height to obtain the height of the label. + * Use ui.offsetX to obtain the X offset of the label on the gauge scale. + * Use ui.offsetY to obtain the Y offset of the label on the gauge scale. + */ alignLabel?: AlignLabelEvent; /** @@ -55128,30 +59675,74 @@ interface JQuery { igLinearGauge(optionLiteral: 'option', optionName: "font", optionValue: string): void; /** - * Gets the pixel scaling ratio for the gauge. + * 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. */ igLinearGauge(optionLiteral: 'option', optionName: "pixelScalingRatio"): number; /** - * Sets the pixel scaling ratio for the gauge. + * 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. */ igLinearGauge(optionLiteral: 'option', optionName: "pixelScalingRatio", optionValue: number): void; /** + * Event which is raised when a label of the the gauge is formatted. + * Function takes first argument evt and second argument ui. + * Use ui.owner to obtain reference to the gauge widget. + * Use ui.actualMinimumValue to obtain the minimum value of the gauge scale. + * Use ui.actualMaximumValue to obtain the maximum value of the gauge scale. + * Use ui.value to obtain the value on the the gauge scale associated with the label. + * Use ui.label to obtain the string value of the label. */ igLinearGauge(optionLiteral: 'option', optionName: "formatLabel"): FormatLabelEvent; /** + * Event which is raised when a label of the the gauge is formatted. + * Function takes first argument evt and second argument ui. + * Use ui.owner to obtain reference to the gauge widget. + * Use ui.actualMinimumValue to obtain the minimum value of the gauge scale. + * Use ui.actualMaximumValue to obtain the maximum value of the gauge scale. + * Use ui.value to obtain the value on the the gauge scale associated with the label. + * Use ui.label to obtain the string value of the label. + * + * @optionValue Define event handler function. */ igLinearGauge(optionLiteral: 'option', optionName: "formatLabel", optionValue: FormatLabelEvent): void; /** + * Event which is raised when a label of the linear gauge is aligned along the scale. + * Function takes first argument evt and second argument ui. + * Use ui.owner to obtain reference to the gauge widget. + * Use ui.actualMinimumValue to obtain the minimum value of the gauge scale. + * Use ui.actualMaximumValue to obtain the maximum value of the gauge scale. + * Use ui.value to obtain the value on the gauge scale associated with the label. + * Use ui.label to obtain the string value of the label. + * Use ui.width to obtain the width of the label. + * Use ui.height to obtain the height of the label. + * Use ui.offsetX to obtain the X offset of the label on the gauge scale. + * Use ui.offsetY to obtain the Y offset of the label on the gauge scale. */ igLinearGauge(optionLiteral: 'option', optionName: "alignLabel"): AlignLabelEvent; /** + * Event which is raised when a label of the linear gauge is aligned along the scale. + * Function takes first argument evt and second argument ui. + * Use ui.owner to obtain reference to the gauge widget. + * Use ui.actualMinimumValue to obtain the minimum value of the gauge scale. + * Use ui.actualMaximumValue to obtain the maximum value of the gauge scale. + * Use ui.value to obtain the value on the gauge scale associated with the label. + * Use ui.label to obtain the string value of the label. + * Use ui.width to obtain the width of the label. + * Use ui.height to obtain the height of the label. + * Use ui.offsetX to obtain the X offset of the label on the gauge scale. + * Use ui.offsetY to obtain the Y offset of the label on the gauge scale. + * + * @optionValue Define event handler function. */ igLinearGauge(optionLiteral: 'option', optionName: "alignLabel", optionValue: AlignLabelEvent): void; @@ -55211,7 +59802,9 @@ interface IgMapBackgroundContent { parameter?: string; /** - * Gets or sets the map tile image uri. This is a bing maps specific option + * Gets or sets the map tile image uri. + * For Bing Maps this is populated by bing imagery. + * For Open Street Map this option can accept custom URL for the tiles. Default is: 'tile.openstreetmap.org/{Z}/{X}/{Y}.png'. No protocol set means that 'http://' or 'https://' will be prepended automatically depending on the hosting site protocol. {Z} - denotes tile zoom, {X} - denotes tile horizontal position, {Y} - denotes tile vertical position. */ tilePath?: string; @@ -56301,7 +60894,7 @@ interface IgMapMethods { /** * Either xAxis or yAxis (longitude or latitude) that it should scale the requested value into map space from axis space. - * For example you can use this method if you want to find where longitude 50 stands scaled to map's width. + * For example you can use this method if you want to find where longitude 50 stands scaled to map's width. * * @param targetName Either xAxis or yAxis to notify. * @param unscaledValue The value in axis space to translate into map space. @@ -56310,7 +60903,7 @@ interface IgMapMethods { /** * Either xAxis or yAxis (longitude or latitude) that it should unscale the requested value into axis space from map space. - * For example you can use this method if you want to find what is the longitude unscaled from 0 width of the map. + * For example you can use this method if you want to find what is the longitude unscaled from 0 width of the map. * * @param targetName Either xAxis or yAxis to notify. * @param scaledValue The value in map space to translate into axis space. @@ -56456,27 +61049,27 @@ interface ShapeDataSourceSettings { } declare namespace Infragistics { - class ShapeDataSource { - constructor(settings: ShapeDataSourceSettings); +class ShapeDataSource { + constructor(settings: ShapeDataSourceSettings); - /** - * Loads to the current data source - */ - dataBind(): void; + /** + * Loads to the current data source + */ + dataBind(): void; - /** - * Returns true if data is loaded - */ - isBound(): boolean; + /** + * Returns true if data is loaded + */ + isBound(): boolean; - /** - * Returns the current converter instance - */ - converter(): Object; - } + /** + * Returns the current converter instance + */ + converter(): Object; +} } interface IgniteUIStatic { - ShapeDataSource: typeof Infragistics.ShapeDataSource; +ShapeDataSource: typeof Infragistics.ShapeDataSource; } interface TriangulationDataSourceSettings { @@ -56512,27 +61105,27 @@ interface TriangulationDataSourceSettings { } declare namespace Infragistics { - class TriangulationDataSource { - constructor(settings: TriangulationDataSourceSettings); +class TriangulationDataSource { + constructor(settings: TriangulationDataSourceSettings); - /** - * Loads to the current data source - */ - dataBind(): void; + /** + * Loads to the current data source + */ + dataBind(): void; - /** - * Returns true if data is loaded - */ - isBound(): boolean; + /** + * Returns true if data is loaded + */ + isBound(): boolean; - /** - * Returns the current converter instance - */ - converter(): Object; - } + /** + * Returns the current converter instance + */ + converter(): Object; +} } interface IgniteUIStatic { - TriangulationDataSource: typeof Infragistics.TriangulationDataSource; +TriangulationDataSource: typeof Infragistics.TriangulationDataSource; } interface JQuery { @@ -57661,7 +62254,7 @@ interface IgNotifier { * controls the direction in which the control shows relative to the target element * * Valid values: - * "auto" lets the control show on the side where enough space is available with the following priority top > bottom > right > left + * "auto" lets the control show on the side where enough space is available with the priority specified by the [directionPriority](ui.igpopover#options:directionPriority) property * "left" shows popover on the left side of the target element * "right" shows popover on the right side of the target element * "top" shows popover on the top of the target element @@ -57669,6 +62262,12 @@ interface IgNotifier { */ direction?: string; + /** + * Controls the priority in which the control searches for space to show relative to the target element. + * This property has effect only if the [direction](ui.igpopover#options:direction) property value is "auto" or unset. + */ + directionPriority?: any[]; + /** * 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 * @@ -57712,41 +62311,21 @@ interface IgNotifier { /** * Event fired before popover is shown. - * Function takes arguments evt and ui. - * Use ui.element to get the element the popover will show for. - * Use ui.content to get or set the content to be shown as a string. - * Use ui.popover to get the popover element showing. - * Use ui.owner to get reference to the igPopover widget */ showing?: ShowingEvent; /** * Event fired after popover is shown. - * Function takes arguments evt and ui. - * Use ui.element to get the element the popover showed for. - * Use ui.content to get the content that was shown as a string. - * Use ui.popover to get the popover element shown. - * Use ui.owner to get reference to the igPopover widget */ shown?: ShownEvent; /** * Event fired before popover is hidden. - * Function takes arguments evt and ui. - * Use ui.element to get the element the popover will hide for. - * Use ui.content to get the current content displayed in the popover as a string. - * Use ui.popover to get the popover element hiding. - * Use ui.owner to get reference to the igPopover widget */ hiding?: HidingEvent; /** * Event fired after popover is hidden. - * Function takes arguments evt and ui. - * Use ui.element to get the element the popover is hidden for. - * Use ui.content to get the content displayed in the popover as a string. - * Use ui.popover to get the popover element hidden. - * Use ui.owner to get reference to the igPopover widget */ hidden?: HiddenEvent; @@ -58052,6 +62631,20 @@ interface JQuery { */ igNotifier(optionLiteral: 'option', optionName: "direction", optionValue: string): void; + /** + * Controls the priority in which the control searches for space to show relative to the target element. + * This property has effect only if the [direction](ui.igpopover#options:direction) property value is "auto" or unset. + */ + igNotifier(optionLiteral: 'option', optionName: "directionPriority"): any[]; + + /** + * Controls the priority in which the control searches for space to show relative to the target element. + * This property has effect only if the [direction](ui.igpopover#options:direction) property value is "auto" or unset. + * + * @optionValue New value to be set. + */ + igNotifier(optionLiteral: 'option', optionName: "directionPriority", optionValue: any[]): void; + /** * 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 */ @@ -58138,21 +62731,11 @@ interface JQuery { /** * Event fired before popover is shown. - * Function takes arguments evt and ui. - * Use ui.element to get the element the popover will show for. - * Use ui.content to get or set the content to be shown as a string. - * Use ui.popover to get the popover element showing. - * Use ui.owner to get reference to the igPopover widget */ igNotifier(optionLiteral: 'option', optionName: "showing"): ShowingEvent; /** * Event fired before popover is shown. - * Function takes arguments evt and ui. - * Use ui.element to get the element the popover will show for. - * Use ui.content to get or set the content to be shown as a string. - * Use ui.popover to get the popover element showing. - * Use ui.owner to get reference to the igPopover widget * * @optionValue Define event handler function. */ @@ -58160,21 +62743,11 @@ interface JQuery { /** * Event fired after popover is shown. - * Function takes arguments evt and ui. - * Use ui.element to get the element the popover showed for. - * Use ui.content to get the content that was shown as a string. - * Use ui.popover to get the popover element shown. - * Use ui.owner to get reference to the igPopover widget */ igNotifier(optionLiteral: 'option', optionName: "shown"): ShownEvent; /** * Event fired after popover is shown. - * Function takes arguments evt and ui. - * Use ui.element to get the element the popover showed for. - * Use ui.content to get the content that was shown as a string. - * Use ui.popover to get the popover element shown. - * Use ui.owner to get reference to the igPopover widget * * @optionValue Define event handler function. */ @@ -58182,21 +62755,11 @@ interface JQuery { /** * Event fired before popover is hidden. - * Function takes arguments evt and ui. - * Use ui.element to get the element the popover will hide for. - * Use ui.content to get the current content displayed in the popover as a string. - * Use ui.popover to get the popover element hiding. - * Use ui.owner to get reference to the igPopover widget */ igNotifier(optionLiteral: 'option', optionName: "hiding"): HidingEvent; /** * Event fired before popover is hidden. - * Function takes arguments evt and ui. - * Use ui.element to get the element the popover will hide for. - * Use ui.content to get the current content displayed in the popover as a string. - * Use ui.popover to get the popover element hiding. - * Use ui.owner to get reference to the igPopover widget * * @optionValue Define event handler function. */ @@ -58204,21 +62767,11 @@ interface JQuery { /** * Event fired after popover is hidden. - * Function takes arguments evt and ui. - * Use ui.element to get the element the popover is hidden for. - * Use ui.content to get the content displayed in the popover as a string. - * Use ui.popover to get the popover element hidden. - * Use ui.owner to get reference to the igPopover widget */ igNotifier(optionLiteral: 'option', optionName: "hidden"): HiddenEvent; /** * Event fired after popover is hidden. - * Function takes arguments evt and ui. - * Use ui.element to get the element the popover is hidden for. - * Use ui.content to get the content displayed in the popover as a string. - * Use ui.popover to get the popover element hidden. - * Use ui.owner to get reference to the igPopover widget * * @optionValue Define event handler function. */ @@ -60121,7 +64674,7 @@ interface IgPivotGridDragAndDropSettings { appendTo?: any; /** - * Specifies the containment for the drag helper. The area inside of which the helper is contained would be scrollable while dragging. + * Specifies the containment for the drag helper. The area inside of which the helper is contained would be scrollable while dragging. * */ containment?: boolean|string|Array; @@ -62555,9 +67108,9 @@ interface IgPivotViewMethods { /** * Destroy is part of the jQuery UI widget API and does the following: - * 1. Remove custom CSS classes that were added. - * 2. Unwrap any wrapping elements such as scrolling divs and other containers. - * 3. Unbind all events that were bound. + * 1. Remove custom CSS classes that were added. + * 2. Unwrap any wrapping elements such as scrolling divs and other containers. + * 3. Unbind all events that were bound. */ destroy(): void; } @@ -62676,7 +67229,7 @@ interface IgPopover { * controls the direction in which the control shows relative to the target element * * Valid values: - * "auto" lets the control show on the side where enough space is available with the following priority top > bottom > right > left + * "auto" lets the control show on the side where enough space is available with the priority specified by the [directionPriority](ui.igpopover#options:directionPriority) property * "left" shows popover on the left side of the target element * "right" shows popover on the right side of the target element * "top" shows popover on the top of the target element @@ -62684,6 +67237,12 @@ interface IgPopover { */ direction?: string; + /** + * Controls the priority in which the control searches for space to show relative to the target element. + * This property has effect only if the [direction](ui.igpopover#options:direction) property value is "auto" or unset. + */ + directionPriority?: any[]; + /** * 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 * @@ -62771,41 +67330,21 @@ interface IgPopover { /** * Event fired before popover is shown. - * Function takes arguments evt and ui. - * Use ui.element to get the element the popover will show for. - * Use ui.content to get or set the content to be shown as a string. - * Use ui.popover to get the popover element showing. - * Use ui.owner to get reference to the igPopover widget */ showing?: ShowingEvent; /** * Event fired after popover is shown. - * Function takes arguments evt and ui. - * Use ui.element to get the element the popover showed for. - * Use ui.content to get the content that was shown as a string. - * Use ui.popover to get the popover element shown. - * Use ui.owner to get reference to the igPopover widget */ shown?: ShownEvent; /** * Event fired before popover is hidden. - * Function takes arguments evt and ui. - * Use ui.element to get the element the popover will hide for. - * Use ui.content to get the current content displayed in the popover as a string. - * Use ui.popover to get the popover element hiding. - * Use ui.owner to get reference to the igPopover widget */ hiding?: HidingEvent; /** * Event fired after popover is hidden. - * Function takes arguments evt and ui. - * Use ui.element to get the element the popover is hidden for. - * Use ui.content to get the content displayed in the popover as a string. - * Use ui.popover to get the popover element hidden. - * Use ui.owner to get reference to the igPopover widget */ hidden?: HiddenEvent; @@ -62912,6 +67451,20 @@ interface JQuery { */ igPopover(optionLiteral: 'option', optionName: "direction", optionValue: string): void; + /** + * Controls the priority in which the control searches for space to show relative to the target element. + * This property has effect only if the [direction](ui.igpopover#options:direction) property value is "auto" or unset. + */ + igPopover(optionLiteral: 'option', optionName: "directionPriority"): any[]; + + /** + * Controls the priority in which the control searches for space to show relative to the target element. + * This property has effect only if the [direction](ui.igpopover#options:direction) property value is "auto" or unset. + * + * @optionValue New value to be set. + */ + igPopover(optionLiteral: 'option', optionName: "directionPriority", optionValue: any[]): void; + /** * 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 */ @@ -63072,21 +67625,11 @@ interface JQuery { /** * Event fired before popover is shown. - * Function takes arguments evt and ui. - * Use ui.element to get the element the popover will show for. - * Use ui.content to get or set the content to be shown as a string. - * Use ui.popover to get the popover element showing. - * Use ui.owner to get reference to the igPopover widget */ igPopover(optionLiteral: 'option', optionName: "showing"): ShowingEvent; /** * Event fired before popover is shown. - * Function takes arguments evt and ui. - * Use ui.element to get the element the popover will show for. - * Use ui.content to get or set the content to be shown as a string. - * Use ui.popover to get the popover element showing. - * Use ui.owner to get reference to the igPopover widget * * @optionValue Define event handler function. */ @@ -63094,21 +67637,11 @@ interface JQuery { /** * Event fired after popover is shown. - * Function takes arguments evt and ui. - * Use ui.element to get the element the popover showed for. - * Use ui.content to get the content that was shown as a string. - * Use ui.popover to get the popover element shown. - * Use ui.owner to get reference to the igPopover widget */ igPopover(optionLiteral: 'option', optionName: "shown"): ShownEvent; /** * Event fired after popover is shown. - * Function takes arguments evt and ui. - * Use ui.element to get the element the popover showed for. - * Use ui.content to get the content that was shown as a string. - * Use ui.popover to get the popover element shown. - * Use ui.owner to get reference to the igPopover widget * * @optionValue Define event handler function. */ @@ -63116,21 +67649,11 @@ interface JQuery { /** * Event fired before popover is hidden. - * Function takes arguments evt and ui. - * Use ui.element to get the element the popover will hide for. - * Use ui.content to get the current content displayed in the popover as a string. - * Use ui.popover to get the popover element hiding. - * Use ui.owner to get reference to the igPopover widget */ igPopover(optionLiteral: 'option', optionName: "hiding"): HidingEvent; /** * Event fired before popover is hidden. - * Function takes arguments evt and ui. - * Use ui.element to get the element the popover will hide for. - * Use ui.content to get the current content displayed in the popover as a string. - * Use ui.popover to get the popover element hiding. - * Use ui.owner to get reference to the igPopover widget * * @optionValue Define event handler function. */ @@ -63138,21 +67661,11 @@ interface JQuery { /** * Event fired after popover is hidden. - * Function takes arguments evt and ui. - * Use ui.element to get the element the popover is hidden for. - * Use ui.content to get the content displayed in the popover as a string. - * Use ui.popover to get the popover element hidden. - * Use ui.owner to get reference to the igPopover widget */ igPopover(optionLiteral: 'option', optionName: "hidden"): HiddenEvent; /** * Event fired after popover is hidden. - * Function takes arguments evt and ui. - * Use ui.element to get the element the popover is hidden for. - * Use ui.content to get the content displayed in the popover as a string. - * Use ui.popover to get the popover element hidden. - * Use ui.owner to get reference to the igPopover widget * * @optionValue Define event handler function. */ @@ -63297,8 +67810,8 @@ interface IgRadialGauge { * Gets or sets the direction in which the scale sweeps around the center from the start angle to end angle. * * Valid values: - * "counterclockwise" - * "clockwise" + * "counterclockwise" In a direction opposite the typical forward movement of the hands of a clock. + * "clockwise" In a direction corresponding to the typical forward movement of the hands of a clock. */ scaleSweepDirection?: string; @@ -63338,15 +67851,15 @@ interface IgRadialGauge { * Gets or sets the shape to use when rendering the needle from a number of options. * * Valid values: - * "none" - * "rectangle" - * "triangle" - * "needle" - * "trapezoid" - * "rectangleWithBulb" - * "triangleWithBulb" - * "needleWithBulb" - * "trapezoidWithBulb" + * "none" No shape. + * "rectangle" A rectangle shape. + * "triangle" A triangle shape. + * "needle" A needle shape. + * "trapezoid" A trapezoid shape. + * "rectangleWithBulb" A rectangle shape with a bulb at the end. + * "triangleWithBulb" A triangle shape with a bulb at the end. + * "needleWithBulb" A needle shape with a bulb at the end. + * "trapezoidWithBulb" A trapezoid shape with a bulb at the end. */ needleShape?: string; @@ -63363,13 +67876,13 @@ interface IgRadialGauge { needleEndWidthRatio?: number; /** - * Gets or sets the width of the needle at its feature which is closest to the base (e.g. a bulb) with a value from 0 to 1. Note: Only some needle shapes respect this property. + * Gets or sets the width of the needle at its feature which is closest to the base (e.g. a bulb) with a value from 0 to 1. Note: Only some needle shapes respect this property, namely: NeedleWithBulb, RectangleWithBulb, TrapezoidWithBulb, and TriangleWithBulb. * Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. */ needleBaseFeatureWidthRatio?: number; /** - * Gets or sets the extent of the feature which is closest to the base (e.g. a bulb) with a value from -1 to 1. Note: Only some needle shapes respect this property. + * Gets or sets the extent of the feature which is closest to the base (e.g. a bulb) with a value from -1 to 1. Note: Only some needle shapes respect this property, namely: NeedleWithBulb, RectangleWithBulb, TrapezoidWithBulb, and TriangleWithBulb. * Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. */ needleBaseFeatureExtent?: number; @@ -63401,13 +67914,13 @@ interface IgRadialGauge { * Gets or sets the shape to use for the needle cap. * * Valid values: - * "none" - * "circle" - * "circleWithHole" - * "circleOverlay" - * "circleOverlayWithHole" - * "circleUnderlay" - * "circleUnderlayWithHole" + * "none" No pivot shape. + * "circle" A circle shaped pivot. + * "circleWithHole" A circle pivot with a hole in it. + * "circleOverlay" A circle pivot overlayed on top of the needle. + * "circleOverlayWithHole" A circle pivot with a hole in it overlayed on top of the needle. + * "circleUnderlay" A circle pivot rendered underneath the needle. + * "circleUnderlayWithHole" A circle pivot with a hold in it rendered underneath the needle. */ needlePivotShape?: string; @@ -63544,12 +68057,12 @@ interface IgRadialGauge { scaleOversweep?: number; /** - * Gets or sets the over or shape to use for the excess fill area for the scale. + * Gets or sets the oversweep shape to use for the excess fill area for the scale. * * Valid values: - * "auto" - * "circular" - * "fitted" + * "auto" A default oversweep shape. + * "circular" A circular oversweep shape. + * "fitted" A fitted oversweep shape. */ scaleOversweepShape?: string; @@ -63567,8 +68080,8 @@ interface IgRadialGauge { * Gets or sets the type of shape to use for the backing of the gauge. * * Valid values: - * "circular" - * "fitted" + * "circular" A circular backing shape. + * "fitted" A fitted backing shape. */ backingShape?: string; @@ -63583,10 +68096,10 @@ interface IgRadialGauge { * Gets or sets the strategy to use for omitting labels if the first and last label have the same value. * * Valid values: - * "omitLast" - * "omitFirst" - * "omitNeither" - * "omitBoth" + * "omitLast" Omit the last label. + * "omitFirst" Omit the first label. + * "omitNeither" Omit no labels. + * "omitBoth" Omit both labels. */ duplicateLabelOmissionStrategy?: string; @@ -63611,10 +68124,42 @@ interface IgRadialGauge { transitionProgress?: number; /** - * Gets or sets the scaling value used by the main canvas rendering context to apply a scale transform to it. + * 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; + + /** + * Event which is raised when a label of the gauge is formatted. + * Function takes first argument null and second argument ui. + * Use ui.owner to obtain reference to gauge widget. + * Use ui.actualMinimumValue to obtain the minimum value of gauge scale. + * Use ui.actualMaximumValue to obtain the maximum value of gauge scale. + * Use ui.startAngle to obtain the starting angle of gauge scale. + * Use ui.endAngle to obtain the ending angle of gauge scale. + * Use ui.angle to obtain the angle on the gauge scale at which the label will be located. + * Use ui.value to obtain the value on the gauge scale associated with the label. + * Use ui.label to obtain the string value of the label. + */ formatLabel?: FormatLabelEvent; + + /** + * Event which is raised when a label of the gauge is aligned along the scale. + * Function takes first argument null and second argument ui. + * Use ui.owner to obtain reference to gauge widget. + * Use ui.actualMinimumValue to obtain the minimum value of gauge scale. + * Use ui.actualMaximumValue to obtain the maximum value of gauge scale. + * Use ui.startAngle to obtain the starting angle of gauge scale. + * Use ui.endAngle to obtain the ending angle of gauge scale. + * Use ui.angle to obtain the angle on the gauge scale at which the label will be located. + * Use ui.value to obtain the value on the gauge scale associated with the label. + * Use ui.label to obtain the string value of the label. + * Use ui.width to obtain the width of the label. + * Use ui.height to obtain the height of the label. + * Use ui.offsetX to obtain the X offset of the label on the gauge scale. + * Use ui.offsetY to obtain the Y offset of the label on the gauge scale. + */ alignLabel?: AlignLabelEvent; /** @@ -64026,13 +68571,13 @@ interface JQuery { igRadialGauge(optionLiteral: 'option', optionName: "needleEndWidthRatio", optionValue: number): void; /** - * Gets the width of the needle at its feature which is closest to the base (e.g. a bulb) with a value from 0 to 1. Note: Only some needle shapes respect this property. + * Gets the width of the needle at its feature which is closest to the base (e.g. a bulb) with a value from 0 to 1. Note: Only some needle shapes respect this property, namely: NeedleWithBulb, RectangleWithBulb, TrapezoidWithBulb, and TriangleWithBulb. * Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. */ igRadialGauge(optionLiteral: 'option', optionName: "needleBaseFeatureWidthRatio"): number; /** - * Sets the width of the needle at its feature which is closest to the base (e.g. a bulb) with a value from 0 to 1. Note: Only some needle shapes respect this property. + * Sets the width of the needle at its feature which is closest to the base (e.g. a bulb) with a value from 0 to 1. Note: Only some needle shapes respect this property, namely: NeedleWithBulb, RectangleWithBulb, TrapezoidWithBulb, and TriangleWithBulb. * Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. * * @optionValue New value to be set. @@ -64040,13 +68585,13 @@ interface JQuery { igRadialGauge(optionLiteral: 'option', optionName: "needleBaseFeatureWidthRatio", optionValue: number): void; /** - * Gets the extent of the feature which is closest to the base (e.g. a bulb) with a value from -1 to 1. Note: Only some needle shapes respect this property. + * Gets the extent of the feature which is closest to the base (e.g. a bulb) with a value from -1 to 1. Note: Only some needle shapes respect this property, namely: NeedleWithBulb, RectangleWithBulb, TrapezoidWithBulb, and TriangleWithBulb. * Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. */ igRadialGauge(optionLiteral: 'option', optionName: "needleBaseFeatureExtent"): number; /** - * Sets the extent of the feature which is closest to the base (e.g. a bulb) with a value from -1 to 1. Note: Only some needle shapes respect this property. + * Sets the extent of the feature which is closest to the base (e.g. a bulb) with a value from -1 to 1. Note: Only some needle shapes respect this property, namely: NeedleWithBulb, RectangleWithBulb, TrapezoidWithBulb, and TriangleWithBulb. * Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. * * @optionValue New value to be set. @@ -64434,12 +68979,12 @@ interface JQuery { igRadialGauge(optionLiteral: 'option', optionName: "scaleOversweep", optionValue: number): void; /** - * Gets the over or shape to use for the excess fill area for the scale. + * Gets the oversweep shape to use for the excess fill area for the scale. */ igRadialGauge(optionLiteral: 'option', optionName: "scaleOversweepShape"): string; /** - * Sets the over or shape to use for the excess fill area for the scale. + * Sets the oversweep shape to use for the excess fill area for the scale. * * @optionValue New value to be set. */ @@ -64558,30 +69103,86 @@ interface JQuery { igRadialGauge(optionLiteral: 'option', optionName: "transitionProgress", optionValue: number): void; /** - * Gets the scaling value used by the main canvas rendering context to apply a scale transform to it. + * 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. */ igRadialGauge(optionLiteral: 'option', optionName: "pixelScalingRatio"): number; /** - * Sets the scaling value used by the main canvas rendering context to apply a scale transform to it. + * 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. */ igRadialGauge(optionLiteral: 'option', optionName: "pixelScalingRatio", optionValue: number): void; /** + * Event which is raised when a label of the gauge is formatted. + * Function takes first argument null and second argument ui. + * Use ui.owner to obtain reference to gauge widget. + * Use ui.actualMinimumValue to obtain the minimum value of gauge scale. + * Use ui.actualMaximumValue to obtain the maximum value of gauge scale. + * Use ui.startAngle to obtain the starting angle of gauge scale. + * Use ui.endAngle to obtain the ending angle of gauge scale. + * Use ui.angle to obtain the angle on the gauge scale at which the label will be located. + * Use ui.value to obtain the value on the gauge scale associated with the label. + * Use ui.label to obtain the string value of the label. */ igRadialGauge(optionLiteral: 'option', optionName: "formatLabel"): FormatLabelEvent; /** + * Event which is raised when a label of the gauge is formatted. + * Function takes first argument null and second argument ui. + * Use ui.owner to obtain reference to gauge widget. + * Use ui.actualMinimumValue to obtain the minimum value of gauge scale. + * Use ui.actualMaximumValue to obtain the maximum value of gauge scale. + * Use ui.startAngle to obtain the starting angle of gauge scale. + * Use ui.endAngle to obtain the ending angle of gauge scale. + * Use ui.angle to obtain the angle on the gauge scale at which the label will be located. + * Use ui.value to obtain the value on the gauge scale associated with the label. + * Use ui.label to obtain the string value of the label. + * + * @optionValue Define event handler function. */ igRadialGauge(optionLiteral: 'option', optionName: "formatLabel", optionValue: FormatLabelEvent): void; /** + * Event which is raised when a label of the gauge is aligned along the scale. + * Function takes first argument null and second argument ui. + * Use ui.owner to obtain reference to gauge widget. + * Use ui.actualMinimumValue to obtain the minimum value of gauge scale. + * Use ui.actualMaximumValue to obtain the maximum value of gauge scale. + * Use ui.startAngle to obtain the starting angle of gauge scale. + * Use ui.endAngle to obtain the ending angle of gauge scale. + * Use ui.angle to obtain the angle on the gauge scale at which the label will be located. + * Use ui.value to obtain the value on the gauge scale associated with the label. + * Use ui.label to obtain the string value of the label. + * Use ui.width to obtain the width of the label. + * Use ui.height to obtain the height of the label. + * Use ui.offsetX to obtain the X offset of the label on the gauge scale. + * Use ui.offsetY to obtain the Y offset of the label on the gauge scale. */ igRadialGauge(optionLiteral: 'option', optionName: "alignLabel"): AlignLabelEvent; /** + * Event which is raised when a label of the gauge is aligned along the scale. + * Function takes first argument null and second argument ui. + * Use ui.owner to obtain reference to gauge widget. + * Use ui.actualMinimumValue to obtain the minimum value of gauge scale. + * Use ui.actualMaximumValue to obtain the maximum value of gauge scale. + * Use ui.startAngle to obtain the starting angle of gauge scale. + * Use ui.endAngle to obtain the ending angle of gauge scale. + * Use ui.angle to obtain the angle on the gauge scale at which the label will be located. + * Use ui.value to obtain the value on the gauge scale associated with the label. + * Use ui.label to obtain the string value of the label. + * Use ui.width to obtain the width of the label. + * Use ui.height to obtain the height of the label. + * Use ui.offsetX to obtain the X offset of the label on the gauge scale. + * Use ui.offsetY to obtain the Y offset of the label on the gauge scale. + * + * @optionValue Define event handler function. */ igRadialGauge(optionLiteral: 'option', optionName: "alignLabel", optionValue: AlignLabelEvent): void; @@ -66042,40 +70643,798 @@ interface JQuery { igRating(optionLiteral: 'option', optionName: string, optionValue: any): JQuery; igRating(methodName: string, ...methodParams: any[]): any; } +interface IgSchedulerAgendaViewSettings { + /** + * Gets/Sets the number of days shown in AgendaView mode. + * + */ + dateRangeInterval?: number; + + /** + * Option for IgSchedulerAgendaViewSettings + */ + [optionName: string]: any; +} + +interface IgSchedulerMonthViewSettings { + /** + * Gets/Sets the type of content displayed in a MonthView day. + * + * auto Depending on the screen size, indicates square indicator mode for the appointment in the Month View, if scheduler size is larger than 768px, otherwise identifies horizontal one. + * indicator Indicates that a square indicator should be displayed. + * detailed Indicates that the subject should be displayed. + */ + appointmentMode?: string; + + /** + * Gets/Sets the visibility of an AgendaView in a MonthView. When true, the MonthView will display an AgendaView showing the Appointments for the currently selected day at the top of its list of Appointments. + * + */ + isAgendaVisible?: boolean; + + /** + * Gets/Sets the scope of appointments that are displayed in a MonthView's AgendaView. + * + * allAppointments Indicates that appointments for all days should be displayed in an AgendaView when it is a secondary view within a MonthView. + * onlyAppointmentsForSelectedMonthViewDay Indicates that only appointments for the day that is current selected in the associated MonthView should be displayed in an AgendaView that is associated with a MonthView as a secondary view. + */ + agendaVisibilityType?: string; + + /** + * Gets/Sets the orientation, which determines whether the MonthView and AgendaView views are split vertically or horizontally. This option can be used when the AgendaView is displayed in the MonthView. + * + * auto Depending on the screen size, identifies vertical split if scheduler size is larger than 768px, otherwise identifies horizontal one. + * vertical Identifies a vertical split between the Scheduler's views. + * horizontal Identifies a horizontal split between the Scheduler's views. + */ + viewSplitOrientation?: string; + + /** + * Gets/sets the visibility of the horizontal separators between weeks in the MonthView. + * + */ + isHorizontalSeparatorVisibile?: boolean; + + /** + * Gets/sets the visibility of the vertical separators between days of the week in a MonthView. + * + */ + isVerticalSeparatorVisibile?: boolean; + + /** + * Gets/sets the visibility of the weekday names in MonthView. + * + */ + isWeekdayVisible?: boolean; + + /** + * Gets/sets the visibility of the week numbers in a MonthView. + * + */ + isWeekNumberVisible?: boolean; + + /** + * Gets/sets the visibility of the days from the previous month that occur in the first week of a given month. + * + */ + isPreviousMonthShown?: boolean; + + /** + * Gets/sets the visibility of the days from the next month that occur in the last week of a given month. + * + */ + isNextMonthShown?: boolean; + + /** + * Option for IgSchedulerMonthViewSettings + */ + [optionName: string]: any; +} + +interface AgendaRangeChangingEvent { + (event: Event, ui: AgendaRangeChangingEventUIParam): void; +} + +interface AgendaRangeChangingEventUIParam { +} + +interface AgendaRangeChangedEvent { + (event: Event, ui: AgendaRangeChangedEventUIParam): void; +} + +interface AgendaRangeChangedEventUIParam { +} + +interface DaySelectedEvent { + (event: Event, ui: DaySelectedEventUIParam): void; +} + +interface DaySelectedEventUIParam { +} + +interface MonthChangingEvent { + (event: Event, ui: MonthChangingEventUIParam): void; +} + +interface MonthChangingEventUIParam { +} + +interface MonthChangedEvent { + (event: Event, ui: MonthChangedEventUIParam): void; +} + +interface MonthChangedEventUIParam { +} + +interface ViewChangingEvent { + (event: Event, ui: ViewChangingEventUIParam): void; +} + +interface ViewChangingEventUIParam { +} + +interface ViewChangedEvent { + (event: Event, ui: ViewChangedEventUIParam): void; +} + +interface ViewChangedEventUIParam { +} + +interface AppointmentDialogOpeningEvent { + (event: Event, ui: AppointmentDialogOpeningEventUIParam): void; +} + +interface AppointmentDialogOpeningEventUIParam { +} + +interface AppointmentDialogOpenedEvent { + (event: Event, ui: AppointmentDialogOpenedEventUIParam): void; +} + +interface AppointmentDialogOpenedEventUIParam { +} + +interface AppointmentDialogClosingEvent { + (event: Event, ui: AppointmentDialogClosingEventUIParam): void; +} + +interface AppointmentDialogClosingEventUIParam { +} + +interface AppointmentDialogClosedEvent { + (event: Event, ui: AppointmentDialogClosedEventUIParam): void; +} + +interface AppointmentDialogClosedEventUIParam { +} + +interface AppointmentCreatingEvent { + (event: Event, ui: AppointmentCreatingEventUIParam): void; +} + +interface AppointmentCreatingEventUIParam { +} + +interface AppointmentCreatedEvent { + (event: Event, ui: AppointmentCreatedEventUIParam): void; +} + +interface AppointmentCreatedEventUIParam { +} + +interface AppointmentDeletingEvent { + (event: Event, ui: AppointmentDeletingEventUIParam): void; +} + +interface AppointmentDeletingEventUIParam { +} + +interface AppointmentDeletedEvent { + (event: Event, ui: AppointmentDeletedEventUIParam): void; +} + +interface AppointmentDeletedEventUIParam { +} + +interface AppointmentEditingEvent { + (event: Event, ui: AppointmentEditingEventUIParam): void; +} + +interface AppointmentEditingEventUIParam { +} + +interface AppointmentEditedEvent { + (event: Event, ui: AppointmentEditedEventUIParam): void; +} + +interface AppointmentEditedEventUIParam { +} + +interface IgScheduler { + /** + * Lists of all the views, rendered in the Scheduler. + * + */ + views?: any[]; + + /** + * 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. + * + * + * Valid values: + * "monthView" Enables MonthView in the Scheduler. + * "agendaView" Enables AgendaView in the Scheduler. + */ + viewMode?: string; + + /** + * Enables/Disables today button. + * + */ + selectedDate?: boolean; + + /** + * Gets/Sets the width of the control. + * + * + * Valid values: + * "null" will stretch to fit data, if no other widths are defined. + */ + width?: string|number; + + /** + * Gets/Sets the height of the control. + * + * + * Valid values: + * "null" will fit the editor inside its parent container, if no other heights are defined. + */ + height?: string|number; + + /** + * Gets/Sets AgendaView settings. + * + */ + agendaViewSettings?: IgSchedulerAgendaViewSettings; + + /** + * Gets/Sets MonthView settings. + * + */ + monthViewSettings?: IgSchedulerMonthViewSettings; + + /** + * Gets/Sets whether the appointment dialog and the related day and appointment popups should be shown. + * + */ + appointmentDialogSuppress?: boolean; + + /** + * Fired before agenda view range is changed when using previous and next buttons (fired only in Agenda View) + */ + agendaRangeChanging?: AgendaRangeChangingEvent; + + /** + * Fired after agenda view range is changed when using previous and next buttons (fired only in Agenda View) + */ + agendaRangeChanged?: AgendaRangeChangedEvent; + + /** + * Fired when a day is selected from the datepicker calendar. + */ + daySelected?: DaySelectedEvent; + + /** + * Fired before changing the month begins, when using previous and next buttons (fired only in Month View) + */ + monthChanging?: MonthChangingEvent; + + /** + * Fired after month is changed when using previous and next buttons (fired only in Month View) + */ + monthChanged?: MonthChangedEvent; + + /** + * Fired before rendering of the scheduler begins. + */ + rendering?: RenderingEvent; + + /** + * Fired after rendering of the scheduler has finished. + */ + rendered?: RenderedEvent; + + /** + * Fired before the view is changed, when using the menu buttons. + */ + viewChanging?: ViewChangingEvent; + + /** + * Fired after the view is changed, when using the menu buttons. + */ + viewChanged?: ViewChangedEvent; + + /** + * Fired before opening the dialog for creating/editing appointment. + */ + appointmentDialogOpening?: AppointmentDialogOpeningEvent; + + /** + * Fired after opening the dialog for creating/editing appointment. + */ + appointmentDialogOpened?: AppointmentDialogOpenedEvent; + + /** + * Fired before closing the dialog for adding/editing appointment. + */ + appointmentDialogClosing?: AppointmentDialogClosingEvent; + + /** + * Fired after closing the dialog window for adding/editing appointment. + */ + appointmentDialogClosed?: AppointmentDialogClosedEvent; + + /** + * Fired before an appointment is created. + */ + appointmentCreating?: AppointmentCreatingEvent; + + /** + * Fired after an appointment is created. + */ + appointmentCreated?: AppointmentCreatedEvent; + + /** + * Fired before an appointment is deleted. + */ + appointmentDeleting?: AppointmentDeletingEvent; + + /** + * Fired after an appointment is deleted. + */ + appointmentDeleted?: AppointmentDeletedEvent; + + /** + * Fired before an appointment is edited. + */ + appointmentEditing?: AppointmentEditingEvent; + + /** + * Fired after an appointment is edited. + */ + appointmentEdited?: AppointmentEditedEvent; + + /** + * Option for igScheduler + */ + [optionName: string]: any; +} +interface IgSchedulerMethods { + /** + * Gets reference to appointment by id + * + * @param id + */ + getAppointmentById(id: Object): Object; + + /** + * Creates a new appointment and renders it to the scheduler + * + * @param appointment + */ + createAppointment(appointment: Object): Object; + + /** + * Deletes appointment from the appointment collection + * + * @param appointment appointment + */ + deleteAppointment(appointment: Object): Object; + + /** + * Deletes appointment from the appointment collection + * + * @param appointment appointment + * @param updateAppoinment updateAppoinment + */ + editAppointment(appointment: Object, updateAppoinment: Object): Object; + + /** + * Destroys the widget + */ + destroy(): void; + + /** + * Gets reference to the today UI button. + */ + todayButton(): string; + + /** + * Gets reference to the previous UI button. + */ + previousButton(): string; + + /** + * Gets reference to the date range UI button. + */ + dateRangeButton(): string; + + /** + * Gets reference to the next UI button. + */ + nextButton(): string; + + /** + * Gets reference to the jQuery calendar UI control. + */ + getCalendar(): string; +} +interface JQuery { + data(propertyName: "igScheduler"): IgSchedulerMethods; +} + +interface JQuery { + igScheduler(methodName: "getAppointmentById", id: Object): Object; + igScheduler(methodName: "createAppointment", appointment: Object): Object; + igScheduler(methodName: "deleteAppointment", appointment: Object): Object; + igScheduler(methodName: "editAppointment", appointment: Object, updateAppoinment: Object): Object; + igScheduler(methodName: "destroy"): void; + igScheduler(methodName: "todayButton"): string; + igScheduler(methodName: "previousButton"): string; + igScheduler(methodName: "dateRangeButton"): string; + igScheduler(methodName: "nextButton"): string; + igScheduler(methodName: "getCalendar"): string; + + /** + * Lists of all the views, rendered in the Scheduler. + * + */ + igScheduler(optionLiteral: 'option', optionName: "views"): any[]; + + /** + * Lists of all the views, rendered in the Scheduler. + * + * + * @optionValue New value to be set. + */ + igScheduler(optionLiteral: 'option', optionName: "views", optionValue: any[]): void; + + /** + * 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; + + /** + * /Sets current view mode in the Scheduler. If this options is not defined, then the first defined view in the views property is taken. + * + * + * @optionValue New value to be set. + */ + igScheduler(optionLiteral: 'option', optionName: "viewMode", optionValue: string): void; + + /** + * Enables/Disables today button. + * + */ + igScheduler(optionLiteral: 'option', optionName: "selectedDate"): boolean; + + /** + * Enables/Disables today button. + * + * + * @optionValue New value to be set. + */ + igScheduler(optionLiteral: 'option', optionName: "selectedDate", optionValue: boolean): void; + + /** + * Gets/Sets the width of the control. + * + */ + igScheduler(optionLiteral: 'option', optionName: "width"): string|number; + + /** + * /Sets the width of the control. + * + * + * @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; + + /** + * /Sets the height of the control. + * + * + * @optionValue New value to be set. + */ + igScheduler(optionLiteral: 'option', optionName: "height", optionValue: string|number): void; + + /** + * Gets/Sets AgendaView settings. + * + */ + igScheduler(optionLiteral: 'option', optionName: "agendaViewSettings"): IgSchedulerAgendaViewSettings; + + /** + * /Sets AgendaView settings. + * + * + * @optionValue New value to be set. + */ + igScheduler(optionLiteral: 'option', optionName: "agendaViewSettings", optionValue: IgSchedulerAgendaViewSettings): void; + + /** + * Gets/Sets MonthView settings. + * + */ + igScheduler(optionLiteral: 'option', optionName: "monthViewSettings"): IgSchedulerMonthViewSettings; + + /** + * /Sets MonthView settings. + * + * + * @optionValue New value to be set. + */ + igScheduler(optionLiteral: 'option', optionName: "monthViewSettings", optionValue: IgSchedulerMonthViewSettings): void; + + /** + * Gets/Sets whether the appointment dialog and the related day and appointment popups should be shown. + * + */ + igScheduler(optionLiteral: 'option', optionName: "appointmentDialogSuppress"): boolean; + + /** + * /Sets whether the appointment dialog and the related day and appointment popups should be shown. + * + * + * @optionValue New value to be set. + */ + igScheduler(optionLiteral: 'option', optionName: "appointmentDialogSuppress", optionValue: boolean): void; + + /** + * Fired before agenda view range is changed when using previous and next buttons (fired only in Agenda View) + */ + igScheduler(optionLiteral: 'option', optionName: "agendaRangeChanging"): AgendaRangeChangingEvent; + + /** + * Fired before agenda view range is changed when using previous and next buttons (fired only in Agenda View) + * + * @optionValue New value to be set. + */ + igScheduler(optionLiteral: 'option', optionName: "agendaRangeChanging", optionValue: AgendaRangeChangingEvent): void; + + /** + * Fired after agenda view range is changed when using previous and next buttons (fired only in Agenda View) + */ + igScheduler(optionLiteral: 'option', optionName: "agendaRangeChanged"): AgendaRangeChangedEvent; + + /** + * Fired after agenda view range is changed when using previous and next buttons (fired only in Agenda View) + * + * @optionValue New value to be set. + */ + igScheduler(optionLiteral: 'option', optionName: "agendaRangeChanged", optionValue: AgendaRangeChangedEvent): void; + + /** + * Fired when a day is selected from the datepicker calendar. + */ + igScheduler(optionLiteral: 'option', optionName: "daySelected"): DaySelectedEvent; + + /** + * Fired when a day is selected from the datepicker calendar. + * + * @optionValue New value to be set. + */ + igScheduler(optionLiteral: 'option', optionName: "daySelected", optionValue: DaySelectedEvent): void; + + /** + * Fired before changing the month begins, when using previous and next buttons (fired only in Month View) + */ + igScheduler(optionLiteral: 'option', optionName: "monthChanging"): MonthChangingEvent; + + /** + * Fired before changing the month begins, when using previous and next buttons (fired only in Month View) + * + * @optionValue New value to be set. + */ + igScheduler(optionLiteral: 'option', optionName: "monthChanging", optionValue: MonthChangingEvent): void; + + /** + * Fired after month is changed when using previous and next buttons (fired only in Month View) + */ + igScheduler(optionLiteral: 'option', optionName: "monthChanged"): MonthChangedEvent; + + /** + * Fired after month is changed when using previous and next buttons (fired only in Month View) + * + * @optionValue New value to be set. + */ + igScheduler(optionLiteral: 'option', optionName: "monthChanged", optionValue: MonthChangedEvent): void; + + /** + * Fired before rendering of the scheduler begins. + */ + igScheduler(optionLiteral: 'option', optionName: "rendering"): RenderingEvent; + + /** + * Fired before rendering of the scheduler begins. + * + * @optionValue New value to be set. + */ + igScheduler(optionLiteral: 'option', optionName: "rendering", optionValue: RenderingEvent): void; + + /** + * Fired after rendering of the scheduler has finished. + */ + igScheduler(optionLiteral: 'option', optionName: "rendered"): RenderedEvent; + + /** + * Fired after rendering of the scheduler has finished. + * + * @optionValue New value to be set. + */ + igScheduler(optionLiteral: 'option', optionName: "rendered", optionValue: RenderedEvent): void; + + /** + * Fired before the view is changed, when using the menu buttons. + */ + igScheduler(optionLiteral: 'option', optionName: "viewChanging"): ViewChangingEvent; + + /** + * Fired before the view is changed, when using the menu buttons. + * + * @optionValue New value to be set. + */ + igScheduler(optionLiteral: 'option', optionName: "viewChanging", optionValue: ViewChangingEvent): void; + + /** + * Fired after the view is changed, when using the menu buttons. + */ + igScheduler(optionLiteral: 'option', optionName: "viewChanged"): ViewChangedEvent; + + /** + * Fired after the view is changed, when using the menu buttons. + * + * @optionValue New value to be set. + */ + igScheduler(optionLiteral: 'option', optionName: "viewChanged", optionValue: ViewChangedEvent): void; + + /** + * Fired before opening the dialog for creating/editing appointment. + */ + igScheduler(optionLiteral: 'option', optionName: "appointmentDialogOpening"): AppointmentDialogOpeningEvent; + + /** + * Fired before opening the dialog for creating/editing appointment. + * + * @optionValue New value to be set. + */ + igScheduler(optionLiteral: 'option', optionName: "appointmentDialogOpening", optionValue: AppointmentDialogOpeningEvent): void; + + /** + * Fired after opening the dialog for creating/editing appointment. + */ + igScheduler(optionLiteral: 'option', optionName: "appointmentDialogOpened"): AppointmentDialogOpenedEvent; + + /** + * Fired after opening the dialog for creating/editing appointment. + * + * @optionValue New value to be set. + */ + igScheduler(optionLiteral: 'option', optionName: "appointmentDialogOpened", optionValue: AppointmentDialogOpenedEvent): void; + + /** + * Fired before closing the dialog for adding/editing appointment. + */ + igScheduler(optionLiteral: 'option', optionName: "appointmentDialogClosing"): AppointmentDialogClosingEvent; + + /** + * Fired before closing the dialog for adding/editing appointment. + * + * @optionValue New value to be set. + */ + igScheduler(optionLiteral: 'option', optionName: "appointmentDialogClosing", optionValue: AppointmentDialogClosingEvent): void; + + /** + * Fired after closing the dialog window for adding/editing appointment. + */ + igScheduler(optionLiteral: 'option', optionName: "appointmentDialogClosed"): AppointmentDialogClosedEvent; + + /** + * Fired after closing the dialog window for adding/editing appointment. + * + * @optionValue New value to be set. + */ + igScheduler(optionLiteral: 'option', optionName: "appointmentDialogClosed", optionValue: AppointmentDialogClosedEvent): void; + + /** + * Fired before an appointment is created. + */ + igScheduler(optionLiteral: 'option', optionName: "appointmentCreating"): AppointmentCreatingEvent; + + /** + * Fired before an appointment is created. + * + * @optionValue New value to be set. + */ + igScheduler(optionLiteral: 'option', optionName: "appointmentCreating", optionValue: AppointmentCreatingEvent): void; + + /** + * Fired after an appointment is created. + */ + igScheduler(optionLiteral: 'option', optionName: "appointmentCreated"): AppointmentCreatedEvent; + + /** + * Fired after an appointment is created. + * + * @optionValue New value to be set. + */ + igScheduler(optionLiteral: 'option', optionName: "appointmentCreated", optionValue: AppointmentCreatedEvent): void; + + /** + * Fired before an appointment is deleted. + */ + igScheduler(optionLiteral: 'option', optionName: "appointmentDeleting"): AppointmentDeletingEvent; + + /** + * Fired before an appointment is deleted. + * + * @optionValue New value to be set. + */ + igScheduler(optionLiteral: 'option', optionName: "appointmentDeleting", optionValue: AppointmentDeletingEvent): void; + + /** + * Fired after an appointment is deleted. + */ + igScheduler(optionLiteral: 'option', optionName: "appointmentDeleted"): AppointmentDeletedEvent; + + /** + * Fired after an appointment is deleted. + * + * @optionValue New value to be set. + */ + igScheduler(optionLiteral: 'option', optionName: "appointmentDeleted", optionValue: AppointmentDeletedEvent): void; + + /** + * Fired before an appointment is edited. + */ + igScheduler(optionLiteral: 'option', optionName: "appointmentEditing"): AppointmentEditingEvent; + + /** + * Fired before an appointment is edited. + * + * @optionValue New value to be set. + */ + igScheduler(optionLiteral: 'option', optionName: "appointmentEditing", optionValue: AppointmentEditingEvent): void; + + /** + * Fired after an appointment is edited. + */ + igScheduler(optionLiteral: 'option', optionName: "appointmentEdited"): AppointmentEditedEvent; + + /** + * Fired after an appointment is edited. + * + * @optionValue New value to be set. + */ + igScheduler(optionLiteral: 'option', optionName: "appointmentEdited", optionValue: AppointmentEditedEvent): void; + igScheduler(options: IgScheduler): JQuery; + igScheduler(optionLiteral: 'option', optionName: string): any; + igScheduler(optionLiteral: 'option', options: IgScheduler): JQuery; + igScheduler(optionLiteral: 'option', optionName: string, optionValue: any): JQuery; + igScheduler(methodName: string, ...methodParams: any[]): any; +} interface ScrollingEvent { (event: Event, ui: ScrollingEventUIParam): void; } interface ScrollingEventUIParam { - /** - * Used to obtain reference to igScroll. - */ - owner?: any; - - /** - * Used to obtain if the content is scrolled by the arrows. 0 - none used, -1 - Arrow Up/Left, 1 - Arrow Down/Right. - */ - smallIncrement?: any; - - /** - * Used to obtain if the content is scrolled by the scrollbar track areas. 0 - none used, -1 - Scrolled Up/Left, 1 - Scrolled Down/Right. - */ - bigIncrement?: any; - - /** - * Used to obtain which axis is being used to scroll - horizontal(true) or vertical(false). - */ - horizontal?: any; - - /** - * Used to obtain how much the content will be scrolled horizontally - */ - stepX?: any; - - /** - * Used to obtain how much the content will be scrolled vertically - */ - stepY?: any; } interface ScrolledEvent { @@ -66083,25 +71442,6 @@ interface ScrolledEvent { } interface ScrolledEventUIParam { - /** - * Used to obtain reference to igScroll. - */ - owner?: any; - - /** - * Used to obtain if the content is scrolled by the arrows. 0 - none used, -1 - Arrow Up/Left, 1 - Arrow Down/Right. - */ - smallIncrement?: any; - - /** - * Used to obtain if the content is scrolled by the scrollbar track areas. 0 - none used, -1 - Scrolled Up/Left, 1 - Scrolled Down/Right. - */ - bigIncrement?: any; - - /** - * Used to obtain which axis is being used to scroll - horizontal(true) or vertical(false). - */ - horizontal?: any; } interface ThumbDragStartEvent { @@ -66109,15 +71449,6 @@ interface ThumbDragStartEvent { } interface ThumbDragStartEventUIParam { - /** - * Used to obtain reference to igScroll. - */ - owner?: any; - - /** - * Used to obtain which scrollbar thumb is being used - horizontal(true) or vertical(false). - */ - horizontal?: any; } interface ThumbDragMoveEvent { @@ -66125,25 +71456,6 @@ interface ThumbDragMoveEvent { } interface ThumbDragMoveEventUIParam { - /** - * Used to obtain reference to igScroll. - */ - owner?: any; - - /** - * Used to obtain which scrollbar thumb is being used - horizontal(true) or vertical(false). - */ - horizontal?: any; - - /** - * Used to obtain how much the content will be scrolled horizontally - */ - stepX?: any; - - /** - * Used to obtain how much the content will be scrolled vertically - */ - stepY?: any; } interface ThumbDragEndEvent { @@ -66151,15 +71463,28 @@ interface ThumbDragEndEvent { } interface ThumbDragEndEventUIParam { +} + +interface ResizingEvent { + (event: Event, ui: ResizingEventUIParam): void; +} + +interface ResizingEventUIParam { /** * Used to obtain reference to igScroll. */ owner?: any; +} +interface ResizedEvent { + (event: Event, ui: ResizedEventUIParam): void; +} + +interface ResizedEventUIParam { /** - * Used to obtain which scrollbar thumb is being used - horizontal(true) or vertical(false). + * Used to obtain reference to igScroll. */ - horizontal?: any; + owner?: any; } interface IgScroll { @@ -66326,66 +71651,50 @@ interface IgScroll { /** * Event which is raised after the scroller has been rendered fully - * Function takes arguments evt and args. - * Use evt.originalEvent (with validation for not null of evt) to obtain reference to event of browser. - * Use args.owner to obtain reference to igScroll. */ rendered?: RenderedEvent; /** * Event which is raised before scrolling or before each step when having inertia. * Return false in order to cancel action. - * Function takes arguments evt and args. - * Use evt.originalEvent (with validation for not null of evt) to obtain reference to event of browser. - * Use args.owner to obtain reference to igScroll. - * Use args.smallIncrement to obtain if the content is scrolled by the arrows. 0 - none used, -1 - Arrow Up/Left, 1 - Arrow Down/Right. - * Use args.bigIncrement to obtain if the content is scrolled by the scrollbar track areas. 0 - none used, -1 - Scrolled Up/Left, 1 - Scrolled Down/Right. - * Use args.horizontal to obtain which axis is being used to scroll - horizontal(true) or vertical(false). - * Use args.stepX to obtain how much the content will be scrolled horizontally - * Use args.stepY to obtain how much the content will be scrolled vertically */ scrolling?: ScrollingEvent; /** * Event which is raised after scrolling has stopped. - * Function takes arguments evt and args. - * Use evt.originalEvent (with validation for not null of evt) to obtain reference to event of browser. - * Use args.owner to obtain reference to igScroll. - * Use args.smallIncrement to obtain if the content is scrolled by the arrows. 0 - none used, -1 - Arrow Up/Left, 1 - Arrow Down/Right. - * Use args.bigIncrement to obtain if the content is scrolled by the scrollbar track areas. 0 - none used, -1 - Scrolled Up/Left, 1 - Scrolled Down/Right. - * Use args.horizontal to obtain which axis is being used to scroll - horizontal(true) or vertical(false). */ scrolled?: ScrolledEvent; /** * Event which is raised when there is mouse click on the scrollbar's thumb drag. - * Function takes arguments evt and args. - * Use evt.originalEvent (with validation for not null of evt) to obtain reference to event of browser. - * Use args.owner to obtain reference to igScroll. - * Use args.horizontal to obtain which scrollbar thumb is being used - horizontal(true) or vertical(false). */ thumbDragStart?: ThumbDragStartEvent; /** * Event which is raised when the thumb drag is being moved. - * Return false in order to cancel action. - * Function takes arguments evt and args. - * Use evt.originalEvent (with validation for not null of evt) to obtain reference to event of browser. - * Use args.owner to obtain reference to igScroll. - * Use args.horizontal to obtain which scrollbar thumb is being used - horizontal(true) or vertical(false). - * Use args.stepX to obtain how much the content will be scrolled horizontally - * Use args.stepY to obtain how much the content will be scrolled vertically */ thumbDragMove?: ThumbDragMoveEvent; /** * Event which is raised on mouse up from the scrollbar's thumb drag. + */ + thumbDragEnd?: ThumbDragEndEvent; + + /** + * Event which is raised when the igScroll detects that the element is reizing. * Function takes arguments evt and args. * Use evt.originalEvent (with validation for not null of evt) to obtain reference to event of browser. * Use args.owner to obtain reference to igScroll. - * Use args.horizontal to obtain which scrollbar thumb is being used - horizontal(true) or vertical(false). */ - thumbDragEnd?: ThumbDragEndEvent; + resizing?: ResizingEvent; + + /** + * Event which is raised after the igScroll has finished resizing. + * Function takes arguments evt and args. + * Use evt.originalEvent (with validation for not null of evt) to obtain reference to event of browser. + * Use args.owner to obtain reference to igScroll. + */ + resized?: ResizedEvent; /** * Option for igScroll @@ -66772,17 +72081,11 @@ interface JQuery { /** * Event which is raised after the scroller has been rendered fully - * Function takes arguments evt and args. - * Use evt.originalEvent (with validation for not null of evt) to obtain reference to event of browser. - * Use args.owner to obtain reference to igScroll. */ igScroll(optionLiteral: 'option', optionName: "rendered"): RenderedEvent; /** * Event which is raised after the scroller has been rendered fully - * Function takes arguments evt and args. - * Use evt.originalEvent (with validation for not null of evt) to obtain reference to event of browser. - * Use args.owner to obtain reference to igScroll. * * @optionValue Define event handler function. */ @@ -66791,28 +72094,12 @@ interface JQuery { /** * Event which is raised before scrolling or before each step when having inertia. * Return false in order to cancel action. - * Function takes arguments evt and args. - * Use evt.originalEvent (with validation for not null of evt) to obtain reference to event of browser. - * Use args.owner to obtain reference to igScroll. - * Use args.smallIncrement to obtain if the content is scrolled by the arrows. 0 - none used, -1 - Arrow Up/Left, 1 - Arrow Down/Right. - * Use args.bigIncrement to obtain if the content is scrolled by the scrollbar track areas. 0 - none used, -1 - Scrolled Up/Left, 1 - Scrolled Down/Right. - * Use args.horizontal to obtain which axis is being used to scroll - horizontal(true) or vertical(false). - * Use args.stepX to obtain how much the content will be scrolled horizontally - * Use args.stepY to obtain how much the content will be scrolled vertically */ igScroll(optionLiteral: 'option', optionName: "scrolling"): ScrollingEvent; /** * Event which is raised before scrolling or before each step when having inertia. * Return false in order to cancel action. - * Function takes arguments evt and args. - * Use evt.originalEvent (with validation for not null of evt) to obtain reference to event of browser. - * Use args.owner to obtain reference to igScroll. - * Use args.smallIncrement to obtain if the content is scrolled by the arrows. 0 - none used, -1 - Arrow Up/Left, 1 - Arrow Down/Right. - * Use args.bigIncrement to obtain if the content is scrolled by the scrollbar track areas. 0 - none used, -1 - Scrolled Up/Left, 1 - Scrolled Down/Right. - * Use args.horizontal to obtain which axis is being used to scroll - horizontal(true) or vertical(false). - * Use args.stepX to obtain how much the content will be scrolled horizontally - * Use args.stepY to obtain how much the content will be scrolled vertically * * @optionValue Define event handler function. */ @@ -66820,23 +72107,11 @@ interface JQuery { /** * Event which is raised after scrolling has stopped. - * Function takes arguments evt and args. - * Use evt.originalEvent (with validation for not null of evt) to obtain reference to event of browser. - * Use args.owner to obtain reference to igScroll. - * Use args.smallIncrement to obtain if the content is scrolled by the arrows. 0 - none used, -1 - Arrow Up/Left, 1 - Arrow Down/Right. - * Use args.bigIncrement to obtain if the content is scrolled by the scrollbar track areas. 0 - none used, -1 - Scrolled Up/Left, 1 - Scrolled Down/Right. - * Use args.horizontal to obtain which axis is being used to scroll - horizontal(true) or vertical(false). */ igScroll(optionLiteral: 'option', optionName: "scrolled"): ScrolledEvent; /** * Event which is raised after scrolling has stopped. - * Function takes arguments evt and args. - * Use evt.originalEvent (with validation for not null of evt) to obtain reference to event of browser. - * Use args.owner to obtain reference to igScroll. - * Use args.smallIncrement to obtain if the content is scrolled by the arrows. 0 - none used, -1 - Arrow Up/Left, 1 - Arrow Down/Right. - * Use args.bigIncrement to obtain if the content is scrolled by the scrollbar track areas. 0 - none used, -1 - Scrolled Up/Left, 1 - Scrolled Down/Right. - * Use args.horizontal to obtain which axis is being used to scroll - horizontal(true) or vertical(false). * * @optionValue Define event handler function. */ @@ -66844,19 +72119,11 @@ interface JQuery { /** * Event which is raised when there is mouse click on the scrollbar's thumb drag. - * Function takes arguments evt and args. - * Use evt.originalEvent (with validation for not null of evt) to obtain reference to event of browser. - * Use args.owner to obtain reference to igScroll. - * Use args.horizontal to obtain which scrollbar thumb is being used - horizontal(true) or vertical(false). */ igScroll(optionLiteral: 'option', optionName: "thumbDragStart"): ThumbDragStartEvent; /** * Event which is raised when there is mouse click on the scrollbar's thumb drag. - * Function takes arguments evt and args. - * Use evt.originalEvent (with validation for not null of evt) to obtain reference to event of browser. - * Use args.owner to obtain reference to igScroll. - * Use args.horizontal to obtain which scrollbar thumb is being used - horizontal(true) or vertical(false). * * @optionValue Define event handler function. */ @@ -66864,25 +72131,11 @@ interface JQuery { /** * Event which is raised when the thumb drag is being moved. - * Return false in order to cancel action. - * Function takes arguments evt and args. - * Use evt.originalEvent (with validation for not null of evt) to obtain reference to event of browser. - * Use args.owner to obtain reference to igScroll. - * Use args.horizontal to obtain which scrollbar thumb is being used - horizontal(true) or vertical(false). - * Use args.stepX to obtain how much the content will be scrolled horizontally - * Use args.stepY to obtain how much the content will be scrolled vertically */ igScroll(optionLiteral: 'option', optionName: "thumbDragMove"): ThumbDragMoveEvent; /** * Event which is raised when the thumb drag is being moved. - * Return false in order to cancel action. - * Function takes arguments evt and args. - * Use evt.originalEvent (with validation for not null of evt) to obtain reference to event of browser. - * Use args.owner to obtain reference to igScroll. - * Use args.horizontal to obtain which scrollbar thumb is being used - horizontal(true) or vertical(false). - * Use args.stepX to obtain how much the content will be scrolled horizontally - * Use args.stepY to obtain how much the content will be scrolled vertically * * @optionValue Define event handler function. */ @@ -66890,23 +72143,51 @@ interface JQuery { /** * Event which is raised on mouse up from the scrollbar's thumb drag. - * Function takes arguments evt and args. - * Use evt.originalEvent (with validation for not null of evt) to obtain reference to event of browser. - * Use args.owner to obtain reference to igScroll. - * Use args.horizontal to obtain which scrollbar thumb is being used - horizontal(true) or vertical(false). */ igScroll(optionLiteral: 'option', optionName: "thumbDragEnd"): ThumbDragEndEvent; /** * Event which is raised on mouse up from the scrollbar's thumb drag. - * Function takes arguments evt and args. - * Use evt.originalEvent (with validation for not null of evt) to obtain reference to event of browser. - * Use args.owner to obtain reference to igScroll. - * Use args.horizontal to obtain which scrollbar thumb is being used - horizontal(true) or vertical(false). * * @optionValue Define event handler function. */ igScroll(optionLiteral: 'option', optionName: "thumbDragEnd", optionValue: ThumbDragEndEvent): void; + + /** + * Event which is raised when the igScroll detects that the element is reizing. + * Function takes arguments evt and args. + * Use evt.originalEvent (with validation for not null of evt) to obtain reference to event of browser. + * Use args.owner to obtain reference to igScroll. + */ + igScroll(optionLiteral: 'option', optionName: "resizing"): ResizingEvent; + + /** + * Event which is raised when the igScroll detects that the element is reizing. + * Function takes arguments evt and args. + * Use evt.originalEvent (with validation for not null of evt) to obtain reference to event of browser. + * Use args.owner to obtain reference to igScroll. + * + * @optionValue Define event handler function. + */ + igScroll(optionLiteral: 'option', optionName: "resizing", optionValue: ResizingEvent): void; + + /** + * Event which is raised after the igScroll has finished resizing. + * Function takes arguments evt and args. + * Use evt.originalEvent (with validation for not null of evt) to obtain reference to event of browser. + * Use args.owner to obtain reference to igScroll. + */ + igScroll(optionLiteral: 'option', optionName: "resized"): ResizedEvent; + + /** + * Event which is raised after the igScroll has finished resizing. + * Function takes arguments evt and args. + * Use evt.originalEvent (with validation for not null of evt) to obtain reference to event of browser. + * Use args.owner to obtain reference to igScroll. + * + * @optionValue Define event handler function. + */ + igScroll(optionLiteral: 'option', optionName: "resized", optionValue: ResizedEvent): void; igScroll(options: IgScroll): JQuery; igScroll(optionLiteral: 'option', optionName: string): any; igScroll(optionLiteral: 'option', options: IgScroll): JQuery; @@ -67863,8 +73144,8 @@ interface IgSparkline { * Gets or sets the display state of the horizontal axis. * * Valid values: - * "visible" - * "collapsed" + * "visible" Display the element. + * "collapsed" Do not display the element. */ horizontalAxisVisibility?: string; @@ -67872,8 +73153,8 @@ interface IgSparkline { * Gets or sets the display state of the vertical axis. * * Valid values: - * "visible" - * "collapsed" + * "visible" Display the element. + * "collapsed" Do not display the element. */ verticalAxisVisibility?: string; @@ -67881,8 +73162,8 @@ interface IgSparkline { * Gets or sets the marker visibility of the sparkline. * * Valid values: - * "visible" - * "collapsed" + * "visible" Display the element. + * "collapsed" Do not display the element. */ markerVisibility?: string; @@ -67890,8 +73171,8 @@ interface IgSparkline { * Gets or sets the negative marker visibility of the sparkline. * * Valid values: - * "visible" - * "collapsed" + * "visible" Display the element. + * "collapsed" Do not display the element. */ negativeMarkerVisibility?: string; @@ -67899,8 +73180,8 @@ interface IgSparkline { * Gets or sets the first marker visibility of the sparkline. * * Valid values: - * "visible" - * "collapsed" + * "visible" Display the element. + * "collapsed" Do not display the element. */ firstMarkerVisibility?: string; @@ -67908,8 +73189,8 @@ interface IgSparkline { * Gets or sets the last marker visibility of the sparkline. * * Valid values: - * "visible" - * "collapsed" + * "visible" Display the element. + * "collapsed" Do not display the element. */ lastMarkerVisibility?: string; @@ -67917,8 +73198,8 @@ interface IgSparkline { * Gets or sets the low marker visibility of the sparkline. * * Valid values: - * "visible" - * "collapsed" + * "visible" Display the element. + * "collapsed" Do not display the element. */ lowMarkerVisibility?: string; @@ -67926,8 +73207,8 @@ interface IgSparkline { * Gets or sets the high marker visibility of the sparkline. * * Valid values: - * "visible" - * "collapsed" + * "visible" Display the element. + * "collapsed" Do not display the element. */ highMarkerVisibility?: string; @@ -67935,8 +73216,8 @@ interface IgSparkline { * Gets or sets the normal range visibility of the sparkline. * * Valid values: - * "visible" - * "collapsed" + * "visible" Display the element. + * "collapsed" Do not display the element. */ normalRangeVisibility?: string; @@ -67994,20 +73275,20 @@ interface IgSparkline { * Gets or sets the type of trendline used by the sparkline. * * Valid values: - * "none" - * "linearFit" - * "quadraticFit" - * "cubicFit" - * "quarticFit" - * "quinticFit" - * "logarithmicFit" - * "exponentialFit" - * "powerLawFit" - * "simpleAverage" - * "exponentialAverage" - * "modifiedAverage" - * "cumulativeAverage" - * "weightedAverage" + * "none" No trend line will be displayed. + * "linearFit" Linear fit. + * "quadraticFit" Quadratic polynomial fit. + * "cubicFit" Cubic polynomial fit. + * "quarticFit" Quartic polynomial fit. + * "quinticFit" Quintic polynomial fit. + * "logarithmicFit" Logarithmic fit. + * "exponentialFit" Exponential fit. + * "powerLawFit" Powerlaw fit. + * "simpleAverage" Simple moving average. + * "exponentialAverage" Exponential moving average. + * "modifiedAverage" Modified moving average. + * "cumulativeAverage" Cumulative moving average. + * "weightedAverage" Weighted moving average. */ trendLineType?: string; @@ -68046,8 +73327,8 @@ interface IgSparkline { * Gets or sets the way null values are interpreted. * * Valid values: - * "linearInterpolate" - * "dontPlot" + * "linearInterpolate" Plot the unknown value as the midpoint between surrounding known values using linear interpolation. + * "dontPlot" Do not plot the unknown value on the chart. */ unknownValuePlotting?: string; @@ -68067,6 +73348,12 @@ interface IgSparkline { * Sets or gets a function which takes an object that produces a formatted label for displaying in the chart. */ formatLabel?: any; + + /** + * 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; /** @@ -68216,7 +73503,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. + * 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. */ @@ -68224,7 +73511,7 @@ 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. + * 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. @@ -68234,7 +73521,7 @@ 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. + * 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. @@ -68251,6 +73538,11 @@ interface IgSparklineMethods { * Binds data to the chart */ dataBind(): void; + + /** + * Forces any pending deferred work to render on the chart before continuing + */ + flush(): void; } interface JQuery { data(propertyName: "igSparkline"): IgSparklineMethods; @@ -68271,6 +73563,7 @@ interface JQuery { igSparkline(methodName: "notifyRemoveItem", dataSource: Object, index: number, oldItem: Object): Object; igSparkline(methodName: "chart"): Object; igSparkline(methodName: "dataBind"): void; + igSparkline(methodName: "flush"): void; /** * The width of the sparkline. It can be set as a number in pixels, string (px) or percentage (%). @@ -68793,10 +74086,18 @@ interface JQuery { igSparkline(optionLiteral: 'option', optionName: "formatLabel", optionValue: any): 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. */ igSparkline(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. */ igSparkline(optionLiteral: 'option', optionName: "pixelScalingRatio", optionValue: number): void; @@ -69307,17 +74608,6 @@ interface ResizeStartedEventUIParam { owner?: any; } -interface ResizingEvent { - (event: Event, ui: ResizingEventUIParam): void; -} - -interface ResizingEventUIParam { - /** - * Used to get a reference to the splitter instance. - */ - owner?: any; -} - interface ResizeEndedEvent { (event: Event, ui: ResizeEndedEventUIParam): void; } @@ -69749,6 +75039,762 @@ interface JQuery { igSplitter(optionLiteral: 'option', optionName: string, optionValue: any): JQuery; igSplitter(methodName: string, ...methodParams: any[]): any; } +interface ActivePaneChangedEvent { + (event: Event, ui: ActivePaneChangedEventUIParam): void; +} + +interface ActivePaneChangedEventUIParam { +} + +interface ActiveWorksheetChangedEvent { + (event: Event, ui: ActiveWorksheetChangedEventUIParam): void; +} + +interface ActiveWorksheetChangedEventUIParam { +} + +interface EditRangePasswordNeededEvent { + (event: Event, ui: EditRangePasswordNeededEventUIParam): void; +} + +interface EditRangePasswordNeededEventUIParam { +} + +interface HyperlinkExecutingEvent { + (event: Event, ui: HyperlinkExecutingEventUIParam): void; +} + +interface HyperlinkExecutingEventUIParam { +} + +interface UserPromptDisplayingEvent { + (event: Event, ui: UserPromptDisplayingEventUIParam): void; +} + +interface UserPromptDisplayingEventUIParam { +} + +interface WorkbookDirtiedEvent { + (event: Event, ui: WorkbookDirtiedEventUIParam): void; +} + +interface WorkbookDirtiedEventUIParam { +} + +interface IgSpreadsheet { + /** + * The width of the spreadsheet. It can be set as a number in pixels, string (px) or percentage (%). + * + * + * Valid values: + * "string" The widget width can be set in pixels (px) and percentage (%). + * "number" The widget width can be set as a number + */ + width?: string|number; + + /** + * The height of the spreadsheet. It can be set as a number in pixels, string (px) or percentage (%). + * + * + * Valid values: + * "string" The widget height can be set in pixels (px) and percentage (%). + * "number" The widget height can be set as a number + */ + height?: string|number; + + /** + * Returns or sets the A1 format address of the current active cell within the selected worksheet. + * + */ + activeCell?: string; + + /** + * Returns or sets a boolean indicating whether the scroll lock key is toggled. + * This property is used when certain keys are pressed while the control has focus. For example + * if an arrow key is pressed while the scroll lock is enabled the cell area will be scrolled rather than changing + * the active cell. Note: This property is not maintained/changed by the control. It is just queried when + * performing actions that consider whether the scroll lock is enabled. + * + */ + isScrollLocked?: boolean; + + /** + * Returns or sets the Worksheet from the workbook whose content should be displayed within the control. + * + */ + activeWorksheet?: any; + + /** + * Returns or sets a boolean indicating whether the spreadsheet allows adding worksheets. + * + */ + allowAddWorksheet?: boolean; + + /** + * Returns or sets a boolean indicating whether the spreadsheet allows deleting worksheets. + * + */ + allowDeleteWorksheet?: boolean; + + /** + * Returns or sets a boolean indicating if the grid lines are displayed in the selected worksheets. + * + */ + areGridlinesVisible?: boolean; + + /** + * Returns or sets a boolean indicating if the row and column headers are displayed for the selected worksheets. + * + */ + areHeadersVisible?: boolean; + + /** + * Returns or sets 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. + * + * + * + * Valid values: + * "down" The cell below should be activated. + * "right" The cell to the right should be activated + * "up" The cell above should be activated. + * "left" The cell to the left should be activated + */ + enterKeyNavigationDirection?: string; + + /** + * 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 if the formula bar is displayed within the Spreadsheet. + * + */ + isFormulaBarVisible?: boolean; + + /** + * Returns or sets a boolean indicating whether the control is in "End mode". + * End mode is a mode that affects certain keyboard navigation such as navigating with the arrow keys. For example when in + * end mode and one presses the right arrow, the activeCell will be changed to be the first cell to the right of the current ActiveCell + * that has a value (even if the value is ""). If there were no cells to the right with a value then it would activate the right most cell in that row. End + * mode will end automatically such as when one presses an arrow key. + * + */ + isInEndMode?: boolean; + + /** + * Returns or sets a boolean indicating whether undo is enabled for the control. + * + */ + isUndoEnabled?: boolean; + + /** + * Returns or sets the width of the name box within the formula bar. + * + */ + nameBoxWidth?: number; + + /** + * Returns or sets a value indicating how the selection is updated when interacting with the cells via the mouse or keyboard. + * + * + * Valid values: + * "normal" The selection is replaced when dragging the mouse to select a cell or range of cells. Similarly when navigating via the keyboard a new selection is created. One may add a new range by holding the Ctrl key and using the mouse and one may alter the selection range containing the active cell by holding the Shift key down while clicking with the mouse or navigating with the keyboard such as with the arrow keys. + * "extendSelection" The selection range in the cellRanges representing the active cell is updated as one uses the mouse to select a cell or navigating via the keyboard. + * "addToSelection" New cell ranges are added to the cellRanges without needing to hold down the ctrl key when dragging via the mouse and a range is added with the first arrow key navigation after entering the mode. One can enter the mode by pressing Shift+F8. + */ + selectionMode?: string; + + /** + * Type="ig.excel.Worksheet[]" Returns or sets an array of the Worksheets whose tabs are selected. + * + */ + selectedWorksheets?: any; + + /** + * Returns or sets the position of the screen tip used to display the input message for the data validation rule associated with the active cell. + * + * The provided object should have numeric properties called x and y. + */ + validationInputMessagePosition?: any; + + /** + * Returns or sets the workbook whose information is displayed in the control. + * + */ + workbook?: any; + + /** + * Returns or sets the magnification of the selected worksheets. + * + */ + zoomLevel?: number; + + /** + * Invoked when an action is executed on the Spreadsheet. + */ + actionExecuted?: ActionExecutedEvent; + + /** + * Invoked when an action is about to be executed by the Spreadsheet. + */ + actionExecuting?: ActionExecutingEvent; + + /** + * Invoked when the activeCell of the Spreadsheet has changed. + */ + activeCellChanged?: ActiveCellChangedEvent; + + /** + * Invoked when the activePane of the Spreadsheet has changed. + */ + activePaneChanged?: ActivePaneChangedEvent; + + /** + * Invoked when the activeWorksheet of the Spreadsheet has changed. + */ + activeWorksheetChanged?: ActiveWorksheetChangedEvent; + + /** + * 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. + */ + editRangePasswordNeeded?: EditRangePasswordNeededEvent; + + /** + * Invoked when a hyperlink is being followed in the Spreadsheet. + */ + hyperlinkExecuting?: HyperlinkExecutingEvent; + + /** + * Invoked when the selection for a ig.spreadsheet.SpreadsheetPane of the Spreadsheet is changed. + */ + selectionChanged?: SelectionChangedEvent; + + /** + * Invoked when the user will be prompted with a message regarding an operation that is being performed. + */ + userPromptDisplaying?: UserPromptDisplayingEvent; + + /** + * Invoked when a change has been made to the workbook that might require a save. + * Note: This event is invoked asynchronously with regards to the change(s) that + * have occurred. Also some changes alone are not considered to dirty the Workbook even though it + * does change state on the Workbook or one of its subobjects. An example of that would be a zoom + * type operation (e.g. changing the magnificationInNormalView). + */ + workbookDirtied?: WorkbookDirtiedEvent; + + /** + * Option for igSpreadsheet + */ + [optionName: string]: any; +} +interface IgSpreadsheetMethods { + /** + * Returns an object that represents the pane with the focus. + */ + getActivePane(): Object; + + /** + * Returns an object that represents the current selection of the active pane. + */ + getActiveSelection(): Object; + + /** + * 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. + */ + getActiveSelectionCellRangeFormat(): Object; + + /** + * Returns a boolean indicating if the user is currently editing the name of the active worksheet. + */ + getIsRenamingWorksheet(): boolean; + + /** + * Returns an array of the panes for the activeWorksheet. + * + * returnType="ig.spreadsheet.SpreadsheetPane[]" + */ + getPanes(): void; + + /** + * Executes the action associated with the specified id. + * + * @param action An [enumeration](ig.spreadsheet.SpreadsheetAction) or string that identifies the action to execute. + */ + executeAction(action: Object): boolean; + + /** + * Forces any pending deferred work to render on the spreadsheet before continuing + */ + flush(): void; + + /** + * Destroys the widget. + */ + destroy(): void; + + /** + * Notify the spreadsheet that style information used for rendering the spreadsheet may have been updated. + */ + styleUpdated(): void; +} +interface JQuery { + data(propertyName: "igSpreadsheet"): IgSpreadsheetMethods; +} + +interface JQuery { + igSpreadsheet(methodName: "getActivePane"): Object; + igSpreadsheet(methodName: "getActiveSelection"): Object; + igSpreadsheet(methodName: "getActiveSelectionCellRangeFormat"): Object; + igSpreadsheet(methodName: "getIsRenamingWorksheet"): boolean; + igSpreadsheet(methodName: "getPanes"): void; + igSpreadsheet(methodName: "executeAction", action: Object): boolean; + igSpreadsheet(methodName: "flush"): void; + igSpreadsheet(methodName: "destroy"): void; + igSpreadsheet(methodName: "styleUpdated"): void; + + /** + * 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; + + /** + * The width of the spreadsheet. It can be set as a number in pixels, string (px) or percentage (%). + * + * + * @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; + + /** + * The height of the spreadsheet. It can be set as a number in pixels, string (px) or percentage (%). + * + * + * @optionValue New value to be set. + */ + igSpreadsheet(optionLiteral: 'option', optionName: "height", optionValue: string|number): void; + + /** + * Returns the A1 format address of the current active cell within the selected worksheet. + * + */ + igSpreadsheet(optionLiteral: 'option', optionName: "activeCell"): string; + + /** + * Returns or sets the A1 format address of the current active cell within the selected worksheet. + * + * + * @optionValue New value to be set. + */ + igSpreadsheet(optionLiteral: 'option', optionName: "activeCell", optionValue: string): void; + + /** + * Returns a boolean indicating whether the scroll lock key is toggled. + * This property is used when certain keys are pressed while the control has focus. For example + * if an arrow key is pressed while the scroll lock is enabled the cell area will be scrolled rather than changing + * the active cell. Note: This property is not maintained/changed by the control. It is just queried when + * performing actions that consider whether the scroll lock is enabled. + * + */ + igSpreadsheet(optionLiteral: 'option', optionName: "isScrollLocked"): boolean; + + /** + * Returns or sets a boolean indicating whether the scroll lock key is toggled. + * This property is used when certain keys are pressed while the control has focus. For example + * if an arrow key is pressed while the scroll lock is enabled the cell area will be scrolled rather than changing + * the active cell. Note: This property is not maintained/changed by the control. It is just queried when + * performing actions that consider whether the scroll lock is enabled. + * + * + * @optionValue New value to be set. + */ + igSpreadsheet(optionLiteral: 'option', optionName: "isScrollLocked", optionValue: boolean): void; + + /** + * Returns the Worksheet from the workbook whose content should be displayed within the control. + * + */ + igSpreadsheet(optionLiteral: 'option', optionName: "activeWorksheet"): any; + + /** + * Returns or sets the Worksheet from the workbook whose content should be displayed within the control. + * + * + * @optionValue New value to be set. + */ + igSpreadsheet(optionLiteral: 'option', optionName: "activeWorksheet", optionValue: any): void; + + /** + * Returns a boolean indicating whether the spreadsheet allows adding worksheets. + * + */ + igSpreadsheet(optionLiteral: 'option', optionName: "allowAddWorksheet"): boolean; + + /** + * Returns or sets a boolean indicating whether the spreadsheet allows adding worksheets. + * + * + * @optionValue New value to be set. + */ + igSpreadsheet(optionLiteral: 'option', optionName: "allowAddWorksheet", optionValue: boolean): void; + + /** + * Returns a boolean indicating whether the spreadsheet allows deleting worksheets. + * + */ + igSpreadsheet(optionLiteral: 'option', optionName: "allowDeleteWorksheet"): boolean; + + /** + * Returns or sets a boolean indicating whether the spreadsheet allows deleting worksheets. + * + * + * @optionValue New value to be set. + */ + igSpreadsheet(optionLiteral: 'option', optionName: "allowDeleteWorksheet", optionValue: boolean): void; + + /** + * Returns a boolean indicating if the grid lines are displayed in the selected worksheets. + * + */ + igSpreadsheet(optionLiteral: 'option', optionName: "areGridlinesVisible"): boolean; + + /** + * Returns or sets a boolean indicating if the grid lines are displayed in the selected worksheets. + * + * + * @optionValue New value to be set. + */ + igSpreadsheet(optionLiteral: 'option', optionName: "areGridlinesVisible", optionValue: boolean): void; + + /** + * Returns a boolean indicating if the row and column headers are displayed for the selected worksheets. + * + */ + igSpreadsheet(optionLiteral: 'option', optionName: "areHeadersVisible"): boolean; + + /** + * Returns or sets a boolean indicating if the row and column headers are displayed for the selected worksheets. + * + * + * @optionValue New value to be set. + */ + igSpreadsheet(optionLiteral: 'option', optionName: "areHeadersVisible", optionValue: boolean): void; + + /** + * 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; + + /** + * Returns or sets 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. + * + * + * + * @optionValue New value to be set. + */ + igSpreadsheet(optionLiteral: 'option', optionName: "enterKeyNavigationDirection", optionValue: string): void; + + /** + * Returns a boolean indicating whether the adjacent cell indicated by the enterKeyNavigationDirection should be navigated to when the enter key is pressed. + * + */ + igSpreadsheet(optionLiteral: 'option', optionName: "isEnterKeyNavigationEnabled"): boolean; + + /** + * Returns or sets a boolean indicating whether the adjacent cell indicated by the enterKeyNavigationDirection should be navigated to when the enter key is pressed. + * + * + * @optionValue New value to be set. + */ + igSpreadsheet(optionLiteral: 'option', optionName: "isEnterKeyNavigationEnabled", optionValue: boolean): void; + + /** + * Returns a boolean indicating if the formula bar is displayed within the Spreadsheet. + * + */ + igSpreadsheet(optionLiteral: 'option', optionName: "isFormulaBarVisible"): boolean; + + /** + * Returns or sets a boolean indicating if the formula bar is displayed within the Spreadsheet. + * + * + * @optionValue New value to be set. + */ + igSpreadsheet(optionLiteral: 'option', optionName: "isFormulaBarVisible", optionValue: boolean): void; + + /** + * Returns a boolean indicating whether the control is in "End mode". + * End mode is a mode that affects certain keyboard navigation such as navigating with the arrow keys. For example when in + * end mode and one presses the right arrow, the activeCell will be changed to be the first cell to the right of the current ActiveCell + * that has a value (even if the value is ""). If there were no cells to the right with a value then it would activate the right most cell in that row. End + * mode will end automatically such as when one presses an arrow key. + * + */ + igSpreadsheet(optionLiteral: 'option', optionName: "isInEndMode"): boolean; + + /** + * Returns or sets a boolean indicating whether the control is in "End mode". + * End mode is a mode that affects certain keyboard navigation such as navigating with the arrow keys. For example when in + * end mode and one presses the right arrow, the activeCell will be changed to be the first cell to the right of the current ActiveCell + * that has a value (even if the value is ""). If there were no cells to the right with a value then it would activate the right most cell in that row. End + * mode will end automatically such as when one presses an arrow key. + * + * + * @optionValue New value to be set. + */ + igSpreadsheet(optionLiteral: 'option', optionName: "isInEndMode", optionValue: boolean): void; + + /** + * Returns a boolean indicating whether undo is enabled for the control. + * + */ + igSpreadsheet(optionLiteral: 'option', optionName: "isUndoEnabled"): boolean; + + /** + * Returns or sets a boolean indicating whether undo is enabled for the control. + * + * + * @optionValue New value to be set. + */ + igSpreadsheet(optionLiteral: 'option', optionName: "isUndoEnabled", optionValue: boolean): void; + + /** + * Returns the width of the name box within the formula bar. + * + */ + igSpreadsheet(optionLiteral: 'option', optionName: "nameBoxWidth"): number; + + /** + * Returns or sets the width of the name box within the formula bar. + * + * + * @optionValue New value to be set. + */ + igSpreadsheet(optionLiteral: 'option', optionName: "nameBoxWidth", optionValue: number): void; + + /** + * 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; + + /** + * Returns or sets a value indicating how the selection is updated when interacting with the cells via the mouse or keyboard. + * + * + * @optionValue New value to be set. + */ + igSpreadsheet(optionLiteral: 'option', optionName: "selectionMode", optionValue: string): void; + + /** + * Type="ig.excel.Worksheet[]" Returns an array of the Worksheets whose tabs are selected. + * + */ + igSpreadsheet(optionLiteral: 'option', optionName: "selectedWorksheets"): any; + + /** + * Type="ig.excel.Worksheet[]" Returns or sets an array of the Worksheets whose tabs are selected. + * + * + * @optionValue New value to be set. + */ + igSpreadsheet(optionLiteral: 'option', optionName: "selectedWorksheets", optionValue: any): void; + + /** + * Returns the position of the screen tip used to display the input message for the data validation rule associated with the active cell. + * + * The provided object should have numeric properties called x and y. + */ + igSpreadsheet(optionLiteral: 'option', optionName: "validationInputMessagePosition"): any; + + /** + * Returns or sets the position of the screen tip used to display the input message for the data validation rule associated with the active cell. + * + * The provided object should have numeric properties called x and y. + * + * @optionValue New value to be set. + */ + igSpreadsheet(optionLiteral: 'option', optionName: "validationInputMessagePosition", optionValue: any): void; + + /** + * Returns the workbook whose information is displayed in the control. + * + */ + igSpreadsheet(optionLiteral: 'option', optionName: "workbook"): any; + + /** + * Returns or sets the workbook whose information is displayed in the control. + * + * + * @optionValue New value to be set. + */ + igSpreadsheet(optionLiteral: 'option', optionName: "workbook", optionValue: any): void; + + /** + * Returns the magnification of the selected worksheets. + * + */ + igSpreadsheet(optionLiteral: 'option', optionName: "zoomLevel"): number; + + /** + * Returns or sets the magnification of the selected worksheets. + * + * + * @optionValue New value to be set. + */ + igSpreadsheet(optionLiteral: 'option', optionName: "zoomLevel", optionValue: number): void; + + /** + * Invoked when an action is executed on the Spreadsheet. + */ + igSpreadsheet(optionLiteral: 'option', optionName: "actionExecuted"): ActionExecutedEvent; + + /** + * Invoked when an action is executed on the Spreadsheet. + * + * @optionValue New value to be set. + */ + igSpreadsheet(optionLiteral: 'option', optionName: "actionExecuted", optionValue: ActionExecutedEvent): void; + + /** + * Invoked when an action is about to be executed by the Spreadsheet. + */ + igSpreadsheet(optionLiteral: 'option', optionName: "actionExecuting"): ActionExecutingEvent; + + /** + * Invoked when an action is about to be executed by the Spreadsheet. + * + * @optionValue New value to be set. + */ + igSpreadsheet(optionLiteral: 'option', optionName: "actionExecuting", optionValue: ActionExecutingEvent): void; + + /** + * Invoked when the activeCell of the Spreadsheet has changed. + */ + igSpreadsheet(optionLiteral: 'option', optionName: "activeCellChanged"): ActiveCellChangedEvent; + + /** + * Invoked when the activeCell of the Spreadsheet has changed. + * + * @optionValue New value to be set. + */ + igSpreadsheet(optionLiteral: 'option', optionName: "activeCellChanged", optionValue: ActiveCellChangedEvent): void; + + /** + * Invoked when the activePane of the Spreadsheet has changed. + */ + igSpreadsheet(optionLiteral: 'option', optionName: "activePaneChanged"): ActivePaneChangedEvent; + + /** + * Invoked when the activePane of the Spreadsheet has changed. + * + * @optionValue New value to be set. + */ + igSpreadsheet(optionLiteral: 'option', optionName: "activePaneChanged", optionValue: ActivePaneChangedEvent): void; + + /** + * Invoked when the activeWorksheet of the Spreadsheet has changed. + */ + igSpreadsheet(optionLiteral: 'option', optionName: "activeWorksheetChanged"): ActiveWorksheetChangedEvent; + + /** + * Invoked when the activeWorksheet of the Spreadsheet has changed. + * + * @optionValue New value to be set. + */ + igSpreadsheet(optionLiteral: 'option', optionName: "activeWorksheetChanged", optionValue: ActiveWorksheetChangedEvent): 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. + */ + igSpreadsheet(optionLiteral: 'option', optionName: "editRangePasswordNeeded"): EditRangePasswordNeededEvent; + + /** + * 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. + * + * @optionValue New value to be set. + */ + igSpreadsheet(optionLiteral: 'option', optionName: "editRangePasswordNeeded", optionValue: EditRangePasswordNeededEvent): void; + + /** + * Invoked when a hyperlink is being followed in the Spreadsheet. + */ + igSpreadsheet(optionLiteral: 'option', optionName: "hyperlinkExecuting"): HyperlinkExecutingEvent; + + /** + * Invoked when a hyperlink is being followed in the Spreadsheet. + * + * @optionValue New value to be set. + */ + igSpreadsheet(optionLiteral: 'option', optionName: "hyperlinkExecuting", optionValue: HyperlinkExecutingEvent): void; + + /** + * Invoked when the selection for a ig.spreadsheet.SpreadsheetPane of the Spreadsheet is changed. + */ + igSpreadsheet(optionLiteral: 'option', optionName: "selectionChanged"): SelectionChangedEvent; + + /** + * Invoked when the selection for a ig.spreadsheet.SpreadsheetPane of the Spreadsheet is changed. + * + * @optionValue New value to be set. + */ + igSpreadsheet(optionLiteral: 'option', optionName: "selectionChanged", optionValue: SelectionChangedEvent): void; + + /** + * Invoked when the user will be prompted with a message regarding an operation that is being performed. + */ + igSpreadsheet(optionLiteral: 'option', optionName: "userPromptDisplaying"): UserPromptDisplayingEvent; + + /** + * Invoked when the user will be prompted with a message regarding an operation that is being performed. + * + * @optionValue New value to be set. + */ + igSpreadsheet(optionLiteral: 'option', optionName: "userPromptDisplaying", optionValue: UserPromptDisplayingEvent): void; + + /** + * Invoked when a change has been made to the workbook that might require a save. + * Note: This event is invoked asynchronously with regards to the change(s) that + * have occurred. Also some changes alone are not considered to dirty the Workbook even though it + * does change state on the Workbook or one of its subobjects. An example of that would be a zoom + * type operation (e.g. changing the magnificationInNormalView). + */ + igSpreadsheet(optionLiteral: 'option', optionName: "workbookDirtied"): WorkbookDirtiedEvent; + + /** + * Invoked when a change has been made to the workbook that might require a save. + * Note: This event is invoked asynchronously with regards to the change(s) that + * have occurred. Also some changes alone are not considered to dirty the Workbook even though it + * does change state on the Workbook or one of its subobjects. An example of that would be a zoom + * type operation (e.g. changing the magnificationInNormalView). + * + * @optionValue New value to be set. + */ + igSpreadsheet(optionLiteral: 'option', optionName: "workbookDirtied", optionValue: WorkbookDirtiedEvent): void; + igSpreadsheet(options: IgSpreadsheet): JQuery; + igSpreadsheet(optionLiteral: 'option', optionName: string): any; + igSpreadsheet(optionLiteral: 'option', options: IgSpreadsheet): JQuery; + igSpreadsheet(optionLiteral: 'option', optionName: string, optionValue: any): JQuery; + igSpreadsheet(methodName: string, ...methodParams: any[]): any; +} interface IgTileManagerSplitterOptionsEvents { /** * Event fired after collapsing is performed. Not cancellable. @@ -71682,7 +77728,1701 @@ interface JQuery { igToolbarButton(optionLiteral: 'option', optionName: string, optionValue: any): JQuery; igToolbarButton(methodName: string, ...methodParams: any[]): any; } +interface IgTreeBindingsBindings { + /** + * Option for IgTreeBindingsBindings + */ + [optionName: string]: any; +} + +interface IgTreeBindings { + /** + * Gets the name of the data source property the value of which would be the node text. + * + */ + textKey?: string; + + /** + * Gets the XPath to the text attribute/node. Used in client-only binding directly to XML. + * + */ + textXPath?: string; + + /** + * Gets the name of the data source property the value of which would be the node value. + * + */ + valueKey?: string; + + /** + * Gets the XPath to the value attribute/node. Used in client-only binding directly to XML. + * + */ + valueXPath?: string; + + /** + * Gets the name of the data source property the value of which would be used as a URL for the node image. + * + */ + imageUrlKey?: string; + + /** + * Gets the XPath to the image URL attribute/node. Used in client-only binding directly to XML. + * + */ + imageUrlXPath?: string; + + /** + * Gets the name of the data source property the value of which would be used as an href attribute for the node anchor. + * + */ + navigateUrlKey?: string; + + /** + * Gets the XPath to the navigate URL attribute/node. Used in client-only binding directly to XML. + * + */ + navigateUrlXPath?: string; + + /** + * Gets the name of the data source property the value of which would be used as a target + * attribute for the node anchor. + * + */ + targetKey?: string; + + /** + * Gets the name of the data source property the value of which would indicate that the + * node is expanded on initial load. + * + */ + expandedKey?: string; + + /** + * Gets the name of the data source property the value of which is the primary key attribute + * for the data. This property is used when load on demand is enabled and if specified the node paths + * would be generated using primary keys instead of indices. + * + */ + primaryKey?: string; + + /** + * Gets the node content template for the current layer of bindings. The igTree utilizes igTemplating + * for generating node content templates. A good example of how to setup templating can be found here http://www.infragistics.com/community/blogs/marina_stoyanova/archive/2014/06/17/how-to-use-templates-to-style-the-different-nodes-of-the-ignite-ui-tree-control.aspx + * + */ + nodeContentTemplate?: string; + + /** + * Gets the name of the data source property that holds the child data of the current layer node. + * + */ + childDataProperty?: string; + + /** + * Gets the XPath to the child data node. Used in client-only binding directly to XML. + * + */ + childDataXPath?: string; + + /** + * Gets the XPath to the root data node. Used in client-only binding directly to XML. + * + */ + searchFieldXPath?: string; + + /** + * Gets the next layer of bindings in a recursive fashion. + * + */ + bindings?: IgTreeBindingsBindings; + + /** + * Option for IgTreeBindings + */ + [optionName: string]: any; +} + +interface IgTreeDragAndDropSettings { + /** + * Gets whether the widget will accept drag and drop from other controls. + * + */ + allowDrop?: boolean; + + /** + * Gets the drag and drop mode. + * + * + * Valid values: + * "default" Performs "copy" when holding the Ctrl key, otherwise "move" is performed. + * "copy" Makes a copy of the dragged node at the drop location. + * "move" Moves the dragged node at the drop location. + */ + dragAndDropMode?: string; + + /** + * Gets the opacity of the drag helper: 0 is fully transparent while 1 is fully opaque. + * + */ + dragOpacity?: number; + + /** + * Gets whether the helper would revert to its original position upon an invalid drop. + * + */ + revert?: boolean; + + /** + * Gets the duration of the revert animation. + * + */ + revertDuration?: number; + + /** + * Gets the z-index that would be set for the drag helper. + * + */ + zIndex?: number; + + /** + * Gets the delay between mousedown and the start of the actual drag. Smaller values make the nodes + * more sensitive to drag and may interfere with selection. + * + */ + dragStartDelay?: number; + + /** + * Gets whether when dragging over a collapsed node with children will trigger the node to expand. + * + */ + expandOnDragOver?: boolean; + + /** + * Gets the delay after hovering a parent node before expanding that node during drag when [expandOnDragOver](ui.igtree#options:dragAndDropSettings.expandOnDragOver) is set to true. + * + */ + expandDelay?: number; + + /** + * Gets the type of helper to be rendered for the drag operation. + * + * + * Valid values: + * "function" A function that will return a DOMElement to use while dragging. + * "default" would render the default igTree helper. + */ + helper?: Function|string; + + /** + * Gets the method for custom drop point validation. Returning true from this function would render the drop point valid, while false would make it invalid. The function has one parameter which is the current drop point and the context (this) of the function is the drag element. + * + * + * Valid values: + * "function" A function that will be used for validating drop points. + * "null" Only built-in validation is applied. + */ + customDropValidation?: Function; + + /** + * 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. + * "element" The draggable element will be contained to the bounding box of this element. + * "string" Possible values: "parent", "document", "window". + * "array" An array defining a bounding box in the form [ x1, y1, x2, y2 ]. + */ + containment?: boolean|string|Object|Array; + + /** + * Gets the HTML markup for the invalid helper. + * + */ + invalidMoveToMarkup?: string; + + /** + * Gets the HTML markup for the "move to" helper. + * + */ + moveToMarkup?: string; + + /** + * Gets the HTML markup for the "move between" helper. + * + */ + moveBetweenMarkup?: string; + + /** + * Gets the HTML markup for the "move after" helper. + * + */ + moveAfterMarkup?: string; + + /** + * Gets the HTML markup for the "move before" helper. + * + */ + moveBeforeMarkup?: string; + + /** + * Gets the HTML markup for the "copy to" helper. + * + */ + copyToMarkup?: string; + + /** + * Gets the HTML markup for the "copy between" helper. + * + */ + copyBetweenMarkup?: string; + + /** + * Gets the HTML markup for the "copy after" helper. + * + */ + copyAfterMarkup?: string; + + /** + * Gets the HTML markup for the "copy before" helper. + * + */ + copyBeforeMarkup?: string; + + /** + * Option for IgTreeDragAndDropSettings + */ + [optionName: string]: any; +} + +interface NodeCheckstateChangingEvent { + (event: Event, ui: NodeCheckstateChangingEventUIParam): void; +} + +interface NodeCheckstateChangingEventUIParam { +} + +interface NodeCheckstateChangedEvent { + (event: Event, ui: NodeCheckstateChangedEventUIParam): void; +} + +interface NodeCheckstateChangedEventUIParam { +} + +interface NodePopulatingEvent { + (event: Event, ui: NodePopulatingEventUIParam): void; +} + +interface NodePopulatingEventUIParam { +} + +interface NodePopulatedEvent { + (event: Event, ui: NodePopulatedEventUIParam): void; +} + +interface NodePopulatedEventUIParam { +} + +interface NodeCollapsingEvent { + (event: Event, ui: NodeCollapsingEventUIParam): void; +} + +interface NodeCollapsingEventUIParam { +} + +interface NodeCollapsedEvent { + (event: Event, ui: NodeCollapsedEventUIParam): void; +} + +interface NodeCollapsedEventUIParam { +} + +interface NodeExpandingEvent { + (event: Event, ui: NodeExpandingEventUIParam): void; +} + +interface NodeExpandingEventUIParam { +} + +interface NodeExpandedEvent { + (event: Event, ui: NodeExpandedEventUIParam): void; +} + +interface NodeExpandedEventUIParam { +} + +interface NodeClickEvent { + (event: Event, ui: NodeClickEventUIParam): void; +} + +interface NodeClickEventUIParam { +} + +interface NodeDoubleClickEvent { + (event: Event, ui: NodeDoubleClickEventUIParam): void; +} + +interface NodeDoubleClickEventUIParam { +} + +interface NodeDroppingEvent { + (event: Event, ui: NodeDroppingEventUIParam): void; +} + +interface NodeDroppingEventUIParam { +} + +interface NodeDroppedEvent { + (event: Event, ui: NodeDroppedEventUIParam): void; +} + +interface NodeDroppedEventUIParam { +} + +interface IgTree { + /** + * Gets/Sets the width of the control container. + * + * + * Valid values: + * "string" The widget width can be set in pixels (px) and percentage (%). + * "number" The widget width can be set as a number in pixels. + * "null" No width will be applied to the container and it will be rendered by default for the browser rendering engine. + */ + width?: string|number; + + /** + * Gets/Sets how the height of of the control container. + * + * + * Valid values: + * "string" The widget height can be set in pixels (px) and percentage (%). + * "number" The widget height can be set as a number in pixels. + * "null" No height will be applied to the container and it will be rendered default for the browser rendering engine. + */ + height?: string|number; + + /** + * Gets the behavior and type of the checkboxes rendered for the tree nodes. Can be set only at initialization. + * + * + * Valid values: + * "off" Checkboxes are turned off and are not rendered for the tree. + * "biState" Checkboxes are rendered and support two states (checked and unchecked). Checkboxes do not cascade down or up in this mode. + * "triState" Checkboxes are rendered and support three states (checked, partial and unchecked). Checkboxes cascade up and down in this mode. + */ + checkboxMode?: string; + + /** + * Gets/Sets one or more branches to be expanded at a time. If set to true then only one branch at each level of the tree can be expanded at a time. Otherwise multiple branches can be expanded at a time. + * + */ + singleBranchExpand?: boolean; + + /** + * Gets/Sets whether nodes are hoverable. Setting this option to false would make the tree to not apply hover styles on the nodes when they are hovered. + * + */ + hotTracking?: boolean; + + /** + * Gets/Sets the image url applied to all parent nodes. + * + * + * Valid values: + * "string" Image with the specified URL will be rendered for each node that has children (If you define both parentNodeImageUrl and parentNodeImageClass the parentNodeImageUrl would take priority). + * "null" Option is ignored + */ + parentNodeImageUrl?: string; + + /** + * Gets/Sets the CSS class applied to all parent nodes. + * + * + * Valid values: + * "string" Specified class with a CSS sprite that would be rendered for each node that has children (If you define both parentNodeImageUrl and parentNodeImageClass the parentNodeImageUrl would take priority). + * "null" Option is ignored + */ + parentNodeImageClass?: string; + + /** + * Gets/Sets the tooltip applied to all parent node images. + * + * + * Valid values: + * "string" Specified a tooltip that would be rendered for each node that has children. + * "null" Option is ignored + */ + parentNodeImageTooltip?: string; + + /** + * Gets/Sets the image url applied to all leaf nodes. + * + * + * Valid values: + * "string" Image with the specified URL will be rendered for each node that has no children (If you define both leafNodeImageUrl and leafNodeImageClass the leafNodeImageUrl would take priority). + * "null" Option is ignored + */ + leafNodeImageUrl?: string; + + /** + * Gets/Sets the CSS class applied to all leaf nodes. + * + * + * Valid values: + * "string" Specified class with a CSS sprite that would be rendered for each node that has no children (If you define both leafNodeImageUrl and leafNodeImageClass the leafNodeImageUrl would take priority). + * "null" Option is ignored + */ + leafNodeImageClass?: string; + + /** + * Gets/Sets the tooltip applied to all leaf node images. + * + * + * Valid values: + * "string" Specified a tooltip that would be rendered for each node that has no children. + * "null" Option is ignored + */ + leafNodeImageTooltip?: string; + + /** + * Gets/Sets the duration of each animation such as the expand/collapse. + * + */ + animationDuration?: number; + + /** + * Gets the node data-path attribute separator character. + * + */ + pathSeparator?: string; + + /** + * Gets/Sets the igTree data source. Accepts any valid data source accepted by $.ig.DataSource, or an instance of an $.ig.DataSource itself. + * Once the data source is initialized, this option becomes an instance of the $.ig.HierarchicalDataSource. + * + */ + dataSource?: any; + + /** + * Gets/Sets a remote URL accepted by [$.ig.DataSource](ig.datasource) in order to request data from it. + * + * + * Valid values: + * "string" Specifies the remote url. + * "null" Option is ignored. + */ + dataSourceUrl?: string; + + /** + * 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. + * + * + * Valid values: + * "string" Specifies the data source type implicitly. + * "null" Type is inferred. + */ + dataSourceType?: string; + + /** + * 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. + * + * + * Valid values: + * "string" Specifies the name of the property in which data records are held if the response is wrapped. + * "null" Option is ignored. + */ + responseDataKey?: string; + + /** + * 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. + * + * + * Valid values: + * "string" Response type when a URL is set as the data source. See http://api.jquery.com/jQuery.ajax/ => dataType. + * "null" Type is inferred. + */ + responseDataType?: string; + + /** + * Gets the HTTP verb used for remote requests. Specifies the HTTP verb to be used to issue the requests to the [dataSourceUrl](ui.igtree#options:dataSourceUrl). + * + */ + requestType?: string; + + /** + * Gets the type of the content in a remote data source response. Content type of the response from the [dataSourceUrl](ui.igtree#options:dataSourceUrl). See http://api.jquery.com/jQuery.ajax/ => contentType + * + */ + responseContentType?: string; + + /** + * Gets the initial depth the igTree is going to be expanded to upon initial render. + * + */ + initialExpandDepth?: number; + + /** + * Gets whether all the data would be bound initially or each child collection would be bound upon expand. + * + */ + loadOnDemand?: boolean; + + /** + * Gets the data binding properties and keys. The igTree uses these to extract the corresponding data from the dataSource. + * + */ + bindings?: IgTreeBindings; + + /** + * Gets the default target attribute value for the node anchors. + * + */ + defaultNodeTarget?: string; + + /** + * Gets/Sets whether drag and drop functionality is enabled. + * + */ + dragAndDrop?: boolean; + + /** + * Gets the URL to which updating requests will be made. + * + */ + updateUrl?: string; + + /** + * Gets/Sets specific settings for the drag and drop functionality. + * + */ + dragAndDropSettings?: IgTreeDragAndDropSettings; + + /** + * Fired before databinding is performed. + */ + dataBinding?: DataBindingEvent; + + /** + * Fired after databinding is finished. + */ + dataBound?: DataBoundEvent; + + /** + * Fired before rendering of the tree begins. + */ + rendering?: RenderingEvent; + + /** + * Fired after rendering of the tree has finished. + */ + rendered?: RenderedEvent; + + /** + * Fired before a new node is selected. + */ + selectionChanging?: SelectionChangingEvent; + + /** + * Fired after a new node is selected. + */ + selectionChanged?: SelectionChangedEvent; + + /** + * Fired before the checkbox state of a node is changed. + */ + nodeCheckstateChanging?: NodeCheckstateChangingEvent; + + /** + * Fired after the checkstate of a node is changed. + */ + nodeCheckstateChanged?: NodeCheckstateChangedEvent; + + /** + * Fired before the children of a node are populated in the case of load on demand. + */ + nodePopulating?: NodePopulatingEvent; + + /** + * Fired after the children of a node are populated in the case of load on demand. + */ + nodePopulated?: NodePopulatedEvent; + + /** + * Fired before a node is collapsed. + */ + nodeCollapsing?: NodeCollapsingEvent; + + /** + * Fired after a node is collapsed. + */ + nodeCollapsed?: NodeCollapsedEvent; + + /** + * Fired before a node is expanded. + */ + nodeExpanding?: NodeExpandingEvent; + + /** + * Fired after a node is expanded. + */ + nodeExpanded?: NodeExpandedEvent; + + /** + * Fired on node click. + */ + nodeClick?: NodeClickEvent; + + /** + * Fired on node double click. + */ + nodeDoubleClick?: NodeDoubleClickEvent; + + /** + * Fired on node drag start. + */ + dragStart?: DragStartEvent; + + /** + * Fired on node drag. + */ + drag?: DragEvent; + + /** + * Fired after a drag operation has completed. + */ + dragStop?: DragStopEvent; + + /** + * Fired before a node is dropped. + */ + nodeDropping?: NodeDroppingEvent; + + /** + * Fired after a node is dropped. + */ + nodeDropped?: NodeDroppedEvent; + + /** + * Option for igTree + */ + [optionName: string]: any; +} +interface IgTreeMethods { + /** + * Performs databinding on the igTree. + */ + dataBind(): void; + + /** + * 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. + */ + 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. + */ + 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. + */ + expandToNode(node: Object, toSelect?: boolean): void; + + /** + * Expands the specified node. + * + * @param node Specifies the node element to expand. + */ + expand(node: Object): void; + + /** + * Collapses the specified node. + * + * @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. + */ + parentNode(node: Object): Object; + + /** + * Retrieves the jQuery element of the node with the specified path. + * + * @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. + */ + nodesByValue(value: string): Object; + + /** + * Retrieves all the node objects for the nodes that have their checkboxes checked. + */ + checkedNodes(): any[]; + + /** + * Retrieves all the node objects for the nodes that have their checkboxes unchecked. + */ + uncheckedNodes(): any[]; + + /** + * Retrieves all the node objects for the nodes that have their checkboxes partially checked. + */ + partiallyCheckedNodes(): any[]; + + /** + * 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. + */ + select(node: Object, event?: Object): void; + + /** + * Deselects the specified node. + * + * @param node Specifies the node element to be deselected. + */ + deselect(node: Object): void; + + /** + * Deselects all the selected nodes. + */ + clearSelection(): void; + + /** + * Retrieves the node object for the selected node. + */ + selectedNode(): Object; + + /** + * 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. + */ + 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. + */ + 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. + */ + nodeByIndex(index: number, parent?: Object): Object; + + /** + * Retrieves a node object for the specified 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. + */ + 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. + */ + childrenByPath(path: string): any[]; + + /** + * Returns true if the provided node element is selected and false otherwise. + * + * @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. + */ + 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. + */ + isChecked(node: Object): boolean; + + /** + * Returns the specified node checkstate. + * + * @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. + */ + 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. + */ + removeAt(path: string): void; + + /** + * Removing all the nodes with the specified value. + * + * @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. + */ + applyChangesToNode(element: Object, data: Object): void; + + /** + * Returns the transaction log stack. + */ + transactionLog(): any[]; + + /** + * Returns the data for the node with specified path. + * + * @param path Specifies the node path for which the data is returned. + */ + nodeDataFor(path: string): Object; + + /** + * Destructor for the igTree widget. + */ + destroy(): void; +} +interface JQuery { + data(propertyName: "igTree"): IgTreeMethods; +} + +interface JQuery { + igTree(methodName: "dataBind"): void; + igTree(methodName: "toggleCheckstate", node: Object, event?: Object): void; + igTree(methodName: "toggle", node: Object, event?: Object): void; + igTree(methodName: "expandToNode", node: Object, toSelect?: boolean): void; + igTree(methodName: "expand", node: Object): void; + igTree(methodName: "collapse", node: Object): void; + igTree(methodName: "parentNode", node: Object): Object; + igTree(methodName: "nodeByPath", nodePath: string): Object; + igTree(methodName: "nodesByValue", value: string): Object; + igTree(methodName: "checkedNodes"): any[]; + igTree(methodName: "uncheckedNodes"): any[]; + igTree(methodName: "partiallyCheckedNodes"): any[]; + igTree(methodName: "select", node: Object, event?: Object): void; + igTree(methodName: "deselect", node: Object): void; + igTree(methodName: "clearSelection"): void; + igTree(methodName: "selectedNode"): Object; + igTree(methodName: "findNodesByText", text: string, parent?: Object): any[]; + igTree(methodName: "findImmediateNodesByText", text: string, parent?: Object): any[]; + igTree(methodName: "nodeByIndex", index: number, parent?: Object): Object; + igTree(methodName: "nodeFromElement", element: Object): Object; + igTree(methodName: "children", parent: Object): any[]; + igTree(methodName: "childrenByPath", path: string): any[]; + igTree(methodName: "isSelected", node: Object): boolean; + igTree(methodName: "isExpanded", node: Object): boolean; + igTree(methodName: "isChecked", node: Object): boolean; + igTree(methodName: "checkState", node: Object): string; + igTree(methodName: "addNode", node: Object, parent?: Object, nodeIndex?: number): void; + igTree(methodName: "removeAt", path: string): void; + igTree(methodName: "removeNodesByValue", value: string): void; + igTree(methodName: "applyChangesToNode", element: Object, data: Object): void; + igTree(methodName: "transactionLog"): any[]; + igTree(methodName: "nodeDataFor", path: string): Object; + igTree(methodName: "destroy"): void; + + /** + * Gets/Sets the width of the control container. + * + */ + igTree(optionLiteral: 'option', optionName: "width"): string|number; + + /** + * /Sets the width of the control container. + * + * + * @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; + + /** + * /Sets how the height of of the control container. + * + * + * @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; + + /** + * The behavior and type of the checkboxes rendered for the tree nodes. Can be set only at initialization. + * + * + * @optionValue New value to be set. + */ + igTree(optionLiteral: 'option', optionName: "checkboxMode", optionValue: string): void; + + /** + * Gets/Sets one or more branches to be expanded at a time. If set to true then only one branch at each level of the tree can be expanded at a time. Otherwise multiple branches can be expanded at a time. + * + */ + igTree(optionLiteral: 'option', optionName: "singleBranchExpand"): boolean; + + /** + * /Sets one or more branches to be expanded at a time. If set to true then only one branch at each level of the tree can be expanded at a time. Otherwise multiple branches can be expanded at a time. + * + * + * @optionValue New value to be set. + */ + igTree(optionLiteral: 'option', optionName: "singleBranchExpand", optionValue: boolean): void; + + /** + * Gets/Sets whether nodes are hoverable. Setting this option to false would make the tree to not apply hover styles on the nodes when they are hovered. + * + */ + igTree(optionLiteral: 'option', optionName: "hotTracking"): boolean; + + /** + * /Sets whether nodes are hoverable. Setting this option to false would make the tree to not apply hover styles on the nodes when they are hovered. + * + * + * @optionValue New value to be set. + */ + igTree(optionLiteral: 'option', optionName: "hotTracking", optionValue: boolean): void; + + /** + * Gets/Sets the image url applied to all parent nodes. + * + */ + igTree(optionLiteral: 'option', optionName: "parentNodeImageUrl"): string; + + /** + * /Sets the image url applied to all parent nodes. + * + * + * @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; + + /** + * /Sets the CSS class applied to all parent nodes. + * + * + * @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; + + /** + * /Sets the tooltip applied to all parent node images. + * + * + * @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; + + /** + * /Sets the image url applied to all leaf nodes. + * + * + * @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; + + /** + * /Sets the CSS class applied to all leaf nodes. + * + * + * @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; + + /** + * /Sets the tooltip applied to all leaf node images. + * + * + * @optionValue New value to be set. + */ + igTree(optionLiteral: 'option', optionName: "leafNodeImageTooltip", optionValue: string): void; + + /** + * Gets/Sets the duration of each animation such as the expand/collapse. + * + */ + igTree(optionLiteral: 'option', optionName: "animationDuration"): number; + + /** + * /Sets the duration of each animation such as the expand/collapse. + * + * + * @optionValue New value to be set. + */ + igTree(optionLiteral: 'option', optionName: "animationDuration", optionValue: number): void; + + /** + * Gets the node data-path attribute separator character. + * + */ + igTree(optionLiteral: 'option', optionName: "pathSeparator"): string; + + /** + * The node data-path attribute separator character. + * + * + * @optionValue New value to be set. + */ + igTree(optionLiteral: 'option', optionName: "pathSeparator", optionValue: string): void; + + /** + * Gets/Sets the igTree data source. Accepts any valid data source accepted by $.ig.DataSource, or an instance of an $.ig.DataSource itself. + * Once the data source is initialized, this option becomes an instance of the $.ig.HierarchicalDataSource. + * + */ + igTree(optionLiteral: 'option', optionName: "dataSource"): any; + + /** + * /Sets the igTree data source. Accepts any valid data source accepted by $.ig.DataSource, or an instance of an $.ig.DataSource itself. + * Once the data source is initialized, this option becomes an instance of the $.ig.HierarchicalDataSource. + * + * + * @optionValue New value to be set. + */ + igTree(optionLiteral: 'option', optionName: "dataSource", optionValue: any): void; + + /** + * Gets/Sets a remote URL accepted by [$.ig.DataSource](ig.datasource) in order to request data from it. + * + */ + igTree(optionLiteral: 'option', optionName: "dataSourceUrl"): string; + + /** + * /Sets a remote URL accepted by [$.ig.DataSource](ig.datasource) in order to request data from it. + * + * + * @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; + + /** + * 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. + * + * + * @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; + + /** + * 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. + * + * + * @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; + + /** + * 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. + * + * + * @optionValue New value to be set. + */ + igTree(optionLiteral: 'option', optionName: "responseDataType", optionValue: string): void; + + /** + * Gets the HTTP verb used for remote requests. Gets the HTTP verb to be used to issue the requests to the [dataSourceUrl](ui.igtree#options:dataSourceUrl). + * + */ + igTree(optionLiteral: 'option', optionName: "requestType"): string; + + /** + * The HTTP verb used for remote requests. Sets the HTTP verb to be used to issue the requests to the [dataSourceUrl](ui.igtree#options:dataSourceUrl). + * + * + * @optionValue New value to be set. + */ + igTree(optionLiteral: 'option', optionName: "requestType", optionValue: string): void; + + /** + * Gets the type of the content in a remote data source response. Content type of the response from the [dataSourceUrl](ui.igtree#options:dataSourceUrl). See http://api.jquery.com/jQuery.ajax/ => contentType + * + */ + igTree(optionLiteral: 'option', optionName: "responseContentType"): string; + + /** + * The type of the content in a remote data source response. Content type of the response from the [dataSourceUrl](ui.igtree#options:dataSourceUrl). See http://api.jquery.com/jQuery.ajax/ => contentType + * + * + * @optionValue New value to be set. + */ + igTree(optionLiteral: 'option', optionName: "responseContentType", optionValue: string): void; + + /** + * Gets the initial depth the igTree is going to be expanded to upon initial render. + * + */ + igTree(optionLiteral: 'option', optionName: "initialExpandDepth"): number; + + /** + * The initial depth the igTree is going to be expanded to upon initial render. + * + * + * @optionValue New value to be set. + */ + igTree(optionLiteral: 'option', optionName: "initialExpandDepth", optionValue: number): void; + + /** + * Gets whether all the data would be bound initially or each child collection would be bound upon expand. + * + */ + igTree(optionLiteral: 'option', optionName: "loadOnDemand"): boolean; + + /** + * Whether all the data would be bound initially or each child collection would be bound upon expand. + * + * + * @optionValue New value to be set. + */ + igTree(optionLiteral: 'option', optionName: "loadOnDemand", optionValue: boolean): void; + + /** + * Gets the data binding properties and keys. The igTree uses these to extract the corresponding data from the dataSource. + * + */ + igTree(optionLiteral: 'option', optionName: "bindings"): IgTreeBindings; + + /** + * The data binding properties and keys. The igTree uses these to extract the corresponding data from the dataSource. + * + * + * @optionValue New value to be set. + */ + igTree(optionLiteral: 'option', optionName: "bindings", optionValue: IgTreeBindings): void; + + /** + * Gets the default target attribute value for the node anchors. + * + */ + igTree(optionLiteral: 'option', optionName: "defaultNodeTarget"): string; + + /** + * The default target attribute value for the node anchors. + * + * + * @optionValue New value to be set. + */ + igTree(optionLiteral: 'option', optionName: "defaultNodeTarget", optionValue: string): void; + + /** + * Gets/Sets whether drag and drop functionality is enabled. + * + */ + igTree(optionLiteral: 'option', optionName: "dragAndDrop"): boolean; + + /** + * /Sets whether drag and drop functionality is enabled. + * + * + * @optionValue New value to be set. + */ + igTree(optionLiteral: 'option', optionName: "dragAndDrop", optionValue: boolean): void; + + /** + * Gets the URL to which updating requests will be made. + * + */ + igTree(optionLiteral: 'option', optionName: "updateUrl"): string; + + /** + * The URL to which updating requests will be made. + * + * + * @optionValue New value to be set. + */ + igTree(optionLiteral: 'option', optionName: "updateUrl", optionValue: string): void; + + /** + * Gets/Sets specific settings for the drag and drop functionality. + * + */ + igTree(optionLiteral: 'option', optionName: "dragAndDropSettings"): IgTreeDragAndDropSettings; + + /** + * /Sets specific settings for the drag and drop functionality. + * + * + * @optionValue New value to be set. + */ + igTree(optionLiteral: 'option', optionName: "dragAndDropSettings", optionValue: IgTreeDragAndDropSettings): void; + + /** + * Fired before databinding is performed. + */ + igTree(optionLiteral: 'option', optionName: "dataBinding"): DataBindingEvent; + + /** + * Fired before databinding is performed. + * + * @optionValue New value to be set. + */ + igTree(optionLiteral: 'option', optionName: "dataBinding", optionValue: DataBindingEvent): void; + + /** + * Fired after databinding is finished. + */ + igTree(optionLiteral: 'option', optionName: "dataBound"): DataBoundEvent; + + /** + * Fired after databinding is finished. + * + * @optionValue New value to be set. + */ + igTree(optionLiteral: 'option', optionName: "dataBound", optionValue: DataBoundEvent): void; + + /** + * Fired before rendering of the tree begins. + */ + igTree(optionLiteral: 'option', optionName: "rendering"): RenderingEvent; + + /** + * Fired before rendering of the tree begins. + * + * @optionValue New value to be set. + */ + igTree(optionLiteral: 'option', optionName: "rendering", optionValue: RenderingEvent): void; + + /** + * Fired after rendering of the tree has finished. + */ + igTree(optionLiteral: 'option', optionName: "rendered"): RenderedEvent; + + /** + * Fired after rendering of the tree has finished. + * + * @optionValue New value to be set. + */ + igTree(optionLiteral: 'option', optionName: "rendered", optionValue: RenderedEvent): void; + + /** + * Fired before a new node is selected. + */ + igTree(optionLiteral: 'option', optionName: "selectionChanging"): SelectionChangingEvent; + + /** + * Fired before a new node is selected. + * + * @optionValue New value to be set. + */ + igTree(optionLiteral: 'option', optionName: "selectionChanging", optionValue: SelectionChangingEvent): void; + + /** + * Fired after a new node is selected. + */ + igTree(optionLiteral: 'option', optionName: "selectionChanged"): SelectionChangedEvent; + + /** + * Fired after a new node is selected. + * + * @optionValue New value to be set. + */ + igTree(optionLiteral: 'option', optionName: "selectionChanged", optionValue: SelectionChangedEvent): void; + + /** + * Fired before the checkbox state of a node is changed. + */ + igTree(optionLiteral: 'option', optionName: "nodeCheckstateChanging"): NodeCheckstateChangingEvent; + + /** + * Fired before the checkbox state of a node is changed. + * + * @optionValue New value to be set. + */ + igTree(optionLiteral: 'option', optionName: "nodeCheckstateChanging", optionValue: NodeCheckstateChangingEvent): void; + + /** + * Fired after the checkstate of a node is changed. + */ + igTree(optionLiteral: 'option', optionName: "nodeCheckstateChanged"): NodeCheckstateChangedEvent; + + /** + * Fired after the checkstate of a node is changed. + * + * @optionValue New value to be set. + */ + igTree(optionLiteral: 'option', optionName: "nodeCheckstateChanged", optionValue: NodeCheckstateChangedEvent): void; + + /** + * Fired before the children of a node are populated in the case of load on demand. + */ + igTree(optionLiteral: 'option', optionName: "nodePopulating"): NodePopulatingEvent; + + /** + * Fired before the children of a node are populated in the case of load on demand. + * + * @optionValue New value to be set. + */ + igTree(optionLiteral: 'option', optionName: "nodePopulating", optionValue: NodePopulatingEvent): void; + + /** + * Fired after the children of a node are populated in the case of load on demand. + */ + igTree(optionLiteral: 'option', optionName: "nodePopulated"): NodePopulatedEvent; + + /** + * Fired after the children of a node are populated in the case of load on demand. + * + * @optionValue New value to be set. + */ + igTree(optionLiteral: 'option', optionName: "nodePopulated", optionValue: NodePopulatedEvent): void; + + /** + * Fired before a node is collapsed. + */ + igTree(optionLiteral: 'option', optionName: "nodeCollapsing"): NodeCollapsingEvent; + + /** + * Fired before a node is collapsed. + * + * @optionValue New value to be set. + */ + igTree(optionLiteral: 'option', optionName: "nodeCollapsing", optionValue: NodeCollapsingEvent): void; + + /** + * Fired after a node is collapsed. + */ + igTree(optionLiteral: 'option', optionName: "nodeCollapsed"): NodeCollapsedEvent; + + /** + * Fired after a node is collapsed. + * + * @optionValue New value to be set. + */ + igTree(optionLiteral: 'option', optionName: "nodeCollapsed", optionValue: NodeCollapsedEvent): void; + + /** + * Fired before a node is expanded. + */ + igTree(optionLiteral: 'option', optionName: "nodeExpanding"): NodeExpandingEvent; + + /** + * Fired before a node is expanded. + * + * @optionValue New value to be set. + */ + igTree(optionLiteral: 'option', optionName: "nodeExpanding", optionValue: NodeExpandingEvent): void; + + /** + * Fired after a node is expanded. + */ + igTree(optionLiteral: 'option', optionName: "nodeExpanded"): NodeExpandedEvent; + + /** + * Fired after a node is expanded. + * + * @optionValue New value to be set. + */ + igTree(optionLiteral: 'option', optionName: "nodeExpanded", optionValue: NodeExpandedEvent): void; + + /** + * Fired on node click. + */ + igTree(optionLiteral: 'option', optionName: "nodeClick"): NodeClickEvent; + + /** + * Fired on node click. + * + * @optionValue New value to be set. + */ + igTree(optionLiteral: 'option', optionName: "nodeClick", optionValue: NodeClickEvent): void; + + /** + * Fired on node double click. + */ + igTree(optionLiteral: 'option', optionName: "nodeDoubleClick"): NodeDoubleClickEvent; + + /** + * Fired on node double click. + * + * @optionValue New value to be set. + */ + igTree(optionLiteral: 'option', optionName: "nodeDoubleClick", optionValue: NodeDoubleClickEvent): void; + + /** + * Fired on node drag start. + */ + igTree(optionLiteral: 'option', optionName: "dragStart"): DragStartEvent; + + /** + * Fired on node drag start. + * + * @optionValue New value to be set. + */ + igTree(optionLiteral: 'option', optionName: "dragStart", optionValue: DragStartEvent): void; + + /** + * Fired on node drag. + */ + igTree(optionLiteral: 'option', optionName: "drag"): DragEvent; + + /** + * Fired on node drag. + * + * @optionValue New value to be set. + */ + igTree(optionLiteral: 'option', optionName: "drag", optionValue: DragEvent): void; + + /** + * Fired after a drag operation has completed. + */ + igTree(optionLiteral: 'option', optionName: "dragStop"): DragStopEvent; + + /** + * Fired after a drag operation has completed. + * + * @optionValue New value to be set. + */ + igTree(optionLiteral: 'option', optionName: "dragStop", optionValue: DragStopEvent): void; + + /** + * Fired before a node is dropped. + */ + igTree(optionLiteral: 'option', optionName: "nodeDropping"): NodeDroppingEvent; + + /** + * Fired before a node is dropped. + * + * @optionValue New value to be set. + */ + igTree(optionLiteral: 'option', optionName: "nodeDropping", optionValue: NodeDroppingEvent): void; + + /** + * Fired after a node is dropped. + */ + igTree(optionLiteral: 'option', optionName: "nodeDropped"): NodeDroppedEvent; + + /** + * Fired after a node is dropped. + * + * @optionValue New value to be set. + */ + igTree(optionLiteral: 'option', optionName: "nodeDropped", optionValue: NodeDroppedEvent): void; + igTree(options: IgTree): JQuery; + igTree(optionLiteral: 'option', optionName: string): any; + igTree(optionLiteral: 'option', options: IgTree): JQuery; + igTree(optionLiteral: 'option', optionName: string, optionValue: any): JQuery; + igTree(methodName: string, ...methodParams: any[]): any; +} interface IgTreeGridColumnFixing { + /** + * Specifies the tooltip text on the column fixing header icon when column is not fixed. + * + */ + headerFixButtonText?: string; + + /** + * Specifies the tooltip text on the column fixing header icon when column is fixed. + * + */ + headerUnfixButtonText?: string; + + /** + * Specifies whether to show the column fixing buttons in header cells/feature chooser. + * + */ + showFixButtons?: boolean; + + /** + * Enable row height sync for the fixed and unfixed portion of the grid. If you're observing row misalignment, please refer to [this article](http://www.igniteui.com/help/iggrid-known-issues#misalignment-ie9). + * + */ + syncRowHeights?: boolean; + + /** + * Scroll delta in pixels when scrolling with the mouse wheel or the keyboard in the fixed columns area of the grid. + * + */ + scrollDelta?: number; + + /** + * 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. + * + * + * Valid values: + * "left" Fixed columns are rendered on the left side of the main grid. + * "right" Fixed columns are rendered on the right side of the main grid. + */ + fixingDirection?: string; + + /** + * List of column settings that specifies custom column fixing options on a per column basis. + * + */ + columnSettings?: IgGridColumnFixingColumnSetting[]; + + /** + * Text of the feature chooser button for fixing a currently unfixed column. + * + */ + featureChooserTextFixedColumn?: string; + + /** + * Text of the feature chooser button for unfixing a currently fixed column. + * + */ + featureChooserTextUnfixedColumn?: string; + + /** + * 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. + * + * + * Valid values: + * "string" The width can be set in pixels (px) and percentage (%). + * "number" The width can be set in pixels as a number. + */ + minimalVisibleAreaWidth?: string|number; + + /** + * Specify initial fixing of all non data columns. Non-data columns are columns in the grid rendered for specific features, like the row selectors feature. The column containing the row numbering is such a column. This option is applicable when [fixingDirection](ui.iggridcolumnfixing#options:fixingDirection) is set to left. For a full column fixing configuration summary please refer to [this topic](http://www.igniteui.com/help/iggrid-columnfixing-configuring#configuration-summary). + * + */ + fixNondataColumns?: boolean; + + /** + * When true all the TR DOM attributes of the unfixed row will be copied to the fixed row. Note that when enabled this option negatively affects performance when fixing a column. + */ + populateDataRowsAttributes?: boolean; + + /** + * Event which is fired when column fixing operation is initiated. + */ + columnFixing?: ColumnFixingEvent; + + /** + * Event which is fired when column fixing operation is finished + */ + columnFixed?: ColumnFixedEvent; + + /** + * Event which is fired when column unfixing operation is initiated + */ + columnUnfixing?: ColumnUnfixingEvent; + + /** + * Event which is fired when column unfixing operation is done + */ + columnUnfixed?: ColumnUnfixedEvent; + + /** + * Event which is fired when column fixing operation has failed - e.g. sum of the width of the fixed columns container and width of the column to be fixed exceeds the grid width + */ + columnFixingRefused?: ColumnFixingRefusedEvent; + + /** + * Event which is fired when column unfixing operation has failed - e.g.: there is only one fixed visible column(and tries to unfix it) and at least one fixed hidden column + */ + columnUnfixingRefused?: ColumnUnfixingRefusedEvent; + /** * Option for igTreeGridColumnFixing */ @@ -71690,6 +79430,100 @@ interface IgTreeGridColumnFixing { } interface IgTreeGridColumnFixingMethods { destroy(): void; + + /** + * 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. + */ + unfixColumn(colIdentifier: Object, target?: string, after?: boolean): Object; + + /** + * Checks whether the heights of fixed and unfixed tables are equal - if not sync them. Similar check is made for heights of table rows. + */ + checkAndSyncHeights(): void; + + /** + * 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. + */ + 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. + */ + 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. + */ + 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. + */ + 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. + */ + fixColumn(colIdentifier: Object, target?: string, after?: boolean): Object; + + /** + * Fixes non-data columns (such as the row numbering column of row selectors) if any and if [fixingDirection](ui.iggridcolumnfixing#options:fixingDirection) is left. Does nothing if the non-data columns are already fixed. + */ + fixNonDataColumns(): void; + + /** + * This function is deprecated - use function fixNonDataColumns. + */ + fixDataSkippedColumns(): void; + + /** + * Unfixes non-data columns (such as the row numbering column of row selectors) if any and if [fixingDirection](ui.iggridcolumnfixing#options:fixingDirection) is left. Does nothing if the non-data columns are already fixed. + */ + unfixNonDataColumns(): void; + + /** + * This function is deprecated - use function unfixNonDataColumns. + */ + unfixDataSkippedColumns(): void; + + /** + * Unfixes all fixed columns. + */ + unfixAllColumns(): void; + + /** + * 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. + */ + 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). + */ + getWidthOfFixedColumns(fCols?: any[], excludeNonDataColumns?: boolean, includeHidden?: boolean): number; } interface JQuery { data(propertyName: "igTreeGridColumnFixing"): IgTreeGridColumnFixingMethods; @@ -71697,6 +79531,258 @@ interface JQuery { interface JQuery { igTreeGridColumnFixing(methodName: "destroy"): void; + igTreeGridColumnFixing(methodName: "unfixColumn", colIdentifier: Object, target?: string, after?: boolean): Object; + igTreeGridColumnFixing(methodName: "checkAndSyncHeights"): void; + igTreeGridColumnFixing(methodName: "syncHeights", check?: boolean, clearRowsHeights?: boolean): void; + igTreeGridColumnFixing(methodName: "isGroupHeader", colKey: string): boolean; + igTreeGridColumnFixing(methodName: "checkFixingAllowed", columns: any[]): boolean; + igTreeGridColumnFixing(methodName: "checkUnfixingAllowed", columns: any[]): boolean; + igTreeGridColumnFixing(methodName: "fixColumn", colIdentifier: Object, target?: string, after?: boolean): Object; + igTreeGridColumnFixing(methodName: "fixNonDataColumns"): void; + igTreeGridColumnFixing(methodName: "fixDataSkippedColumns"): void; + igTreeGridColumnFixing(methodName: "unfixNonDataColumns"): void; + igTreeGridColumnFixing(methodName: "unfixDataSkippedColumns"): void; + igTreeGridColumnFixing(methodName: "unfixAllColumns"): void; + igTreeGridColumnFixing(methodName: "syncRowsHeights", $trs: any[], $anotherRows: any[]): void; + igTreeGridColumnFixing(methodName: "getWidthOfFixedColumns", fCols?: any[], excludeNonDataColumns?: boolean, includeHidden?: boolean): number; + + /** + * Gets the tooltip text on the column fixing header icon when column is not fixed. + * + */ + igTreeGridColumnFixing(optionLiteral: 'option', optionName: "headerFixButtonText"): string; + + /** + * Sets the tooltip text on the column fixing header icon when column is not fixed. + * + * + * @optionValue New value to be set. + */ + igTreeGridColumnFixing(optionLiteral: 'option', optionName: "headerFixButtonText", optionValue: string): void; + + /** + * Gets the tooltip text on the column fixing header icon when column is fixed. + * + */ + igTreeGridColumnFixing(optionLiteral: 'option', optionName: "headerUnfixButtonText"): string; + + /** + * Sets the tooltip text on the column fixing header icon when column is fixed. + * + * + * @optionValue New value to be set. + */ + igTreeGridColumnFixing(optionLiteral: 'option', optionName: "headerUnfixButtonText", optionValue: string): void; + + /** + * Gets whether to show the column fixing buttons in header cells/feature chooser. + * + */ + igTreeGridColumnFixing(optionLiteral: 'option', optionName: "showFixButtons"): boolean; + + /** + * Sets whether to show the column fixing buttons in header cells/feature chooser. + * + * + * @optionValue New value to be set. + */ + igTreeGridColumnFixing(optionLiteral: 'option', optionName: "showFixButtons", optionValue: boolean): void; + + /** + * Enable row height sync for the fixed and unfixed portion of the grid. If you're observing row misalignment, please refer to [this article](http://www.igniteui.com/help/iggrid-known-issues#misalignment-ie9). + * + */ + igTreeGridColumnFixing(optionLiteral: 'option', optionName: "syncRowHeights"): boolean; + + /** + * Enable row height sync for the fixed and unfixed portion of the grid. If you're observing row misalignment, please refer to [this article](http://www.igniteui.com/help/iggrid-known-issues#misalignment-ie9). + * + * + * @optionValue New value to be set. + */ + igTreeGridColumnFixing(optionLiteral: 'option', optionName: "syncRowHeights", optionValue: boolean): void; + + /** + * Scroll delta in pixels when scrolling with the mouse wheel or the keyboard in the fixed columns area of the grid. + * + */ + igTreeGridColumnFixing(optionLiteral: 'option', optionName: "scrollDelta"): number; + + /** + * Scroll delta in pixels when scrolling with the mouse wheel or the keyboard in the fixed columns area of the grid. + * + * + * @optionValue New value to be set. + */ + igTreeGridColumnFixing(optionLiteral: 'option', optionName: "scrollDelta", optionValue: number): void; + + /** + * 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; + + /** + * 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. + * + * + * @optionValue New value to be set. + */ + igTreeGridColumnFixing(optionLiteral: 'option', optionName: "fixingDirection", optionValue: string): void; + + /** + * List of column settings that specifies custom column fixing options on a per column basis. + * + */ + igTreeGridColumnFixing(optionLiteral: 'option', optionName: "columnSettings"): IgGridColumnFixingColumnSetting[]; + + /** + * List of column settings that specifies custom column fixing options on a per column basis. + * + * + * @optionValue New value to be set. + */ + igTreeGridColumnFixing(optionLiteral: 'option', optionName: "columnSettings", optionValue: IgGridColumnFixingColumnSetting[]): void; + + /** + * Text of the feature chooser button for fixing a currently unfixed column. + * + */ + igTreeGridColumnFixing(optionLiteral: 'option', optionName: "featureChooserTextFixedColumn"): string; + + /** + * Text of the feature chooser button for fixing a currently unfixed column. + * + * + * @optionValue New value to be set. + */ + igTreeGridColumnFixing(optionLiteral: 'option', optionName: "featureChooserTextFixedColumn", optionValue: string): void; + + /** + * Text of the feature chooser button for unfixing a currently fixed column. + * + */ + igTreeGridColumnFixing(optionLiteral: 'option', optionName: "featureChooserTextUnfixedColumn"): string; + + /** + * Text of the feature chooser button for unfixing a currently fixed column. + * + * + * @optionValue New value to be set. + */ + igTreeGridColumnFixing(optionLiteral: 'option', optionName: "featureChooserTextUnfixedColumn", optionValue: string): void; + + /** + * 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; + + /** + * 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. + * + * + * @optionValue New value to be set. + */ + igTreeGridColumnFixing(optionLiteral: 'option', optionName: "minimalVisibleAreaWidth", optionValue: string|number): void; + + /** + * Specify initial fixing of all non data columns. Non-data columns are columns in the grid rendered for specific features, like the row selectors feature. The column containing the row numbering is such a column. This option is applicable when [fixingDirection](ui.iggridcolumnfixing#options:fixingDirection) is set to left. For a full column fixing configuration summary please refer to [this topic](http://www.igniteui.com/help/iggrid-columnfixing-configuring#configuration-summary). + * + */ + igTreeGridColumnFixing(optionLiteral: 'option', optionName: "fixNondataColumns"): boolean; + + /** + * Specify initial fixing of all non data columns. Non-data columns are columns in the grid rendered for specific features, like the row selectors feature. The column containing the row numbering is such a column. This option is applicable when [fixingDirection](ui.iggridcolumnfixing#options:fixingDirection) is set to left. For a full column fixing configuration summary please refer to [this topic](http://www.igniteui.com/help/iggrid-columnfixing-configuring#configuration-summary). + * + * + * @optionValue New value to be set. + */ + igTreeGridColumnFixing(optionLiteral: 'option', optionName: "fixNondataColumns", optionValue: boolean): void; + + /** + * When true all the TR DOM attributes of the unfixed row will be copied to the fixed row. Note that when enabled this option negatively affects performance when fixing a column. + */ + igTreeGridColumnFixing(optionLiteral: 'option', optionName: "populateDataRowsAttributes"): boolean; + + /** + * When true all the TR DOM attributes of the unfixed row will be copied to the fixed row. Note that when enabled this option negatively affects performance when fixing a column. + * + * @optionValue New value to be set. + */ + igTreeGridColumnFixing(optionLiteral: 'option', optionName: "populateDataRowsAttributes", optionValue: boolean): void; + + /** + * Event which is fired when column fixing operation is initiated. + */ + igTreeGridColumnFixing(optionLiteral: 'option', optionName: "columnFixing"): ColumnFixingEvent; + + /** + * Event which is fired when column fixing operation is initiated. + * + * @optionValue Define event handler function. + */ + igTreeGridColumnFixing(optionLiteral: 'option', optionName: "columnFixing", optionValue: ColumnFixingEvent): void; + + /** + * Event which is fired when column fixing operation is finished + */ + igTreeGridColumnFixing(optionLiteral: 'option', optionName: "columnFixed"): ColumnFixedEvent; + + /** + * Event which is fired when column fixing operation is finished + * + * @optionValue Define event handler function. + */ + igTreeGridColumnFixing(optionLiteral: 'option', optionName: "columnFixed", optionValue: ColumnFixedEvent): void; + + /** + * Event which is fired when column unfixing operation is initiated + */ + igTreeGridColumnFixing(optionLiteral: 'option', optionName: "columnUnfixing"): ColumnUnfixingEvent; + + /** + * Event which is fired when column unfixing operation is initiated + * + * @optionValue Define event handler function. + */ + igTreeGridColumnFixing(optionLiteral: 'option', optionName: "columnUnfixing", optionValue: ColumnUnfixingEvent): void; + + /** + * Event which is fired when column unfixing operation is done + */ + igTreeGridColumnFixing(optionLiteral: 'option', optionName: "columnUnfixed"): ColumnUnfixedEvent; + + /** + * Event which is fired when column unfixing operation is done + * + * @optionValue Define event handler function. + */ + igTreeGridColumnFixing(optionLiteral: 'option', optionName: "columnUnfixed", optionValue: ColumnUnfixedEvent): void; + + /** + * Event which is fired when column fixing operation has failed - e.g. sum of the width of the fixed columns container and width of the column to be fixed exceeds the grid width + */ + igTreeGridColumnFixing(optionLiteral: 'option', optionName: "columnFixingRefused"): ColumnFixingRefusedEvent; + + /** + * Event which is fired when column fixing operation has failed - e.g. sum of the width of the fixed columns container and width of the column to be fixed exceeds the grid width + * + * @optionValue Define event handler function. + */ + igTreeGridColumnFixing(optionLiteral: 'option', optionName: "columnFixingRefused", optionValue: ColumnFixingRefusedEvent): void; + + /** + * Event which is fired when column unfixing operation has failed - e.g.: there is only one fixed visible column(and tries to unfix it) and at least one fixed hidden column + */ + igTreeGridColumnFixing(optionLiteral: 'option', optionName: "columnUnfixingRefused"): ColumnUnfixingRefusedEvent; + + /** + * Event which is fired when column unfixing operation has failed - e.g.: there is only one fixed visible column(and tries to unfix it) and at least one fixed hidden column + * + * @optionValue Define event handler function. + */ + igTreeGridColumnFixing(optionLiteral: 'option', optionName: "columnUnfixingRefused", optionValue: ColumnUnfixingRefusedEvent): void; igTreeGridColumnFixing(options: IgTreeGridColumnFixing): JQuery; igTreeGridColumnFixing(optionLiteral: 'option', optionName: string): any; igTreeGridColumnFixing(optionLiteral: 'option', options: IgTreeGridColumnFixing): JQuery; @@ -71704,6 +79790,266 @@ interface JQuery { igTreeGridColumnFixing(methodName: string, ...methodParams: any[]): any; } interface IgTreeGridColumnMoving { + /** + * A list of column settings that specifies moving options on a per column basis. + * + */ + columnSettings?: IgGridColumnMovingColumnSetting[]; + + /** + * Specify the drag-and-drop mode for the feature + * + * + * Valid values: + * "immediate" Column headers will rearange as you drag with a space opening under the cursor for the header to be dropped on + * "deferred" A clone of the header dragged will be created and indicators will be shown between columns to help navigate the drop. + */ + mode?: string; + + /** + * Specify the way columns will be rearranged + * + * + * Valid values: + * "dom" Columns will be rearranged through dom manipulation + * "render" Columns will not be rearranged but the grid will be rendered again with the new column order. Please note this option is incompatible with immediate move mode. + */ + moveType?: string; + + /** + * Specifies if header cells should include an additional button that opens a moving helper dropdown. + * + */ + addMovingDropdown?: boolean; + + /** + * Specifies width of column moving dialog + * + */ + movingDialogWidth?: number; + + /** + * Specifies height of column moving dialog + * + */ + movingDialogHeight?: number; + + /** + * Specifies time in milliseconds for animation duration to show/hide modal dialog + * + */ + movingDialogAnimationDuration?: number; + + /** + * Specifies the length (in pixels) between the dragged column and the column edges below which the move operation is accepted + * + */ + movingAcceptanceTolerance?: number; + + /** + * Specifies the length (in pixels) between the dragged column and the grid edges below which horizontal scrolling occurs + * + */ + movingScrollTolerance?: number; + + /** + * Specifies a multiplier for the delay between subsequent scroll operations. The larger this number is, the slower scrolling will appear to be. + * + */ + scrollSpeedMultiplier?: number; + + /** + * Specifies the length (in pixels) of each individual scroll operation + * + */ + scrollDelta?: number; + + /** + * Specifies whether the contents of the column being dragged will get hidden. The option is only + * relevant in immediate moving mode. + * + */ + hideHeaderContentsDuringDrag?: boolean; + + /** + * Specifies the opacity of the drag markup, while a column header is being dragged. + * The value must be between 0 and 1. When GroupBy is enabled, the corresponding option in the GroupBy configuration + * will be used with priority over this one. + * + */ + dragHelperOpacity?: number; + + /** + * Specifies caption for each move down button in the column moving dialog + * + */ + movingDialogCaptionButtonDesc?: string; + + /** + * Specifies caption for each move up button in the column moving dialog + * + */ + movingDialogCaptionButtonAsc?: string; + + /** + * Specifies caption text for the column moving dialog + * + */ + movingDialogCaptionText?: string; + + /** + * Specifies caption text for the feature chooser entry + * + */ + movingDialogDisplayText?: string; + + /** + * Specifies text for drop tooltip in column moving dialog + * + */ + movingDialogDropTooltipText?: string; + + /** + * Specifies markup for drop tooltip in column moving dialog + * + */ + movingDialogDropTooltipMarkup?: string; + + /** + * Specifies caption for the move left dropdown button + * + */ + dropDownMoveLeftText?: string; + + /** + * Specifies caption for the move right dropdown button + * + */ + dropDownMoveRightText?: string; + + /** + * Specifies caption for the move first dropdown button + * + */ + dropDownMoveFirstText?: string; + + /** + * Specifies caption for the move last dropdown button + * + */ + dropDownMoveLastText?: string; + + /** + * Specifies tooltip text for the move indicator + * + */ + movingToolTipMove?: string; + + /** + * Specifies caption text for the feature chooser submenu button + * + */ + featureChooserSubmenuText?: string; + + /** + * Controls containment behavior of column moving dialog. + * + * owner The dialog will be draggable only in the grid area + * window The dialog will be draggable in the whole window area + */ + columnMovingDialogContainment?: string; + + /** + * Name of the dialog widget to be used. It should inherit from $.ui.igGridModalDialog. + * + */ + dialogWidget?: string; + + /** + * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. + */ + inherit?: boolean; + + /** + * Event which is fired when a drag operation begins on a column header + */ + columnDragStart?: ColumnDragStartEvent; + + /** + * Event which is fired when a drag operation ends on a column header + */ + columnDragEnd?: ColumnDragEndEvent; + + /** + * Event which is fired when a drag operation is canceled + */ + columnDragCanceled?: ColumnDragCanceledEvent; + + /** + * Event which is fired when a column moving operation is initiated + */ + columnMoving?: ColumnMovingEvent; + + /** + * Event which is fired when a column moving operation completes + */ + columnMoved?: ColumnMovedEvent; + + /** + * Event fired before the moving dialog is opened. + */ + movingDialogOpening?: MovingDialogOpeningEvent; + + /** + * Event fired after the column chooser is already opened. + */ + movingDialogOpened?: MovingDialogOpenedEvent; + + /** + * Event fired every time the moving dialog changes its position. + */ + movingDialogDragged?: MovingDialogDraggedEvent; + + /** + * Event fired before the moving dialog is closed. + */ + movingDialogClosing?: MovingDialogClosingEvent; + + /** + * Event fired after the moving dialog has been closed. + */ + movingDialogClosed?: MovingDialogClosedEvent; + + /** + * Event fired before the contents of the model dialog are rendered. + */ + movingDialogContentsRendering?: MovingDialogContentsRenderingEvent; + + /** + * Event fired after the contents of the model dialog are rendered. + */ + movingDialogContentsRendered?: MovingDialogContentsRenderedEvent; + + /** + * Event fired when move up button is pressed in the moving dialog + */ + movingDialogMoveUpButtonPressed?: MovingDialogMoveUpButtonPressedEvent; + + /** + * Event fired when move down button is pressed in the moving dialog + */ + movingDialogMoveDownButtonPressed?: MovingDialogMoveDownButtonPressedEvent; + + /** + * Event fired when column moving is initiated through dragging it in the moving dialog + */ + movingDialogDragColumnMoving?: MovingDialogDragColumnMovingEvent; + + /** + * Event fired when column moving is completed through dragging it in the moving dialog + */ + movingDialogDragColumnMoved?: MovingDialogDragColumnMovedEvent; + /** * Option for igTreeGridColumnMoving */ @@ -71711,6 +80057,18 @@ interface IgTreeGridColumnMoving { } interface IgTreeGridColumnMovingMethods { destroy(): void; + + /** + * 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. + */ + moveColumn(column: Object, target: Object, after?: boolean, inDom?: boolean, callback?: Function): void; } interface JQuery { data(propertyName: "igTreeGridColumnMoving"): IgTreeGridColumnMovingMethods; @@ -71718,6 +80076,599 @@ interface JQuery { interface JQuery { igTreeGridColumnMoving(methodName: "destroy"): void; + igTreeGridColumnMoving(methodName: "moveColumn", column: Object, target: Object, after?: boolean, inDom?: boolean, callback?: Function): void; + + /** + * A list of column settings that specifies moving options on a per column basis. + * + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "columnSettings"): IgGridColumnMovingColumnSetting[]; + + /** + * A list of column settings that specifies moving options on a per column basis. + * + * + * @optionValue New value to be set. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "columnSettings", optionValue: IgGridColumnMovingColumnSetting[]): void; + + /** + * Specify the drag-and-drop mode for the feature + * + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "mode"): string; + + /** + * Specify the drag-and-drop mode for the feature + * + * + * @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; + + /** + * Specify the way columns will be rearranged + * + * + * @optionValue New value to be set. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "moveType", optionValue: string): void; + + /** + * Gets if header cells should include an additional button that opens a moving helper dropdown. + * + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "addMovingDropdown"): boolean; + + /** + * Sets if header cells should include an additional button that opens a moving helper dropdown. + * + * + * @optionValue New value to be set. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "addMovingDropdown", optionValue: boolean): void; + + /** + * Gets width of column moving dialog + * + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogWidth"): number; + + /** + * Sets width of column moving dialog + * + * + * @optionValue New value to be set. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogWidth", optionValue: number): void; + + /** + * Gets height of column moving dialog + * + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogHeight"): number; + + /** + * Sets height of column moving dialog + * + * + * @optionValue New value to be set. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogHeight", optionValue: number): void; + + /** + * Gets time in milliseconds for animation duration to show/hide modal dialog + * + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogAnimationDuration"): number; + + /** + * Sets time in milliseconds for animation duration to show/hide modal dialog + * + * + * @optionValue New value to be set. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogAnimationDuration", optionValue: number): void; + + /** + * Gets the length (in pixels) between the dragged column and the column edges below which the move operation is accepted + * + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingAcceptanceTolerance"): number; + + /** + * Sets the length (in pixels) between the dragged column and the column edges below which the move operation is accepted + * + * + * @optionValue New value to be set. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingAcceptanceTolerance", optionValue: number): void; + + /** + * Gets the length (in pixels) between the dragged column and the grid edges below which horizontal scrolling occurs + * + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingScrollTolerance"): number; + + /** + * Sets the length (in pixels) between the dragged column and the grid edges below which horizontal scrolling occurs + * + * + * @optionValue New value to be set. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingScrollTolerance", optionValue: number): void; + + /** + * Gets a multiplier for the delay between subsequent scroll operations. The larger this number is, the slower scrolling will appear to be. + * + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "scrollSpeedMultiplier"): number; + + /** + * Sets a multiplier for the delay between subsequent scroll operations. The larger this number is, the slower scrolling will appear to be. + * + * + * @optionValue New value to be set. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "scrollSpeedMultiplier", optionValue: number): void; + + /** + * Gets the length (in pixels) of each individual scroll operation + * + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "scrollDelta"): number; + + /** + * Sets the length (in pixels) of each individual scroll operation + * + * + * @optionValue New value to be set. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "scrollDelta", optionValue: number): void; + + /** + * Gets whether the contents of the column being dragged will get hidden. The option is only + * relevant in immediate moving mode. + * + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "hideHeaderContentsDuringDrag"): boolean; + + /** + * Sets whether the contents of the column being dragged will get hidden. The option is only + * relevant in immediate moving mode. + * + * + * @optionValue New value to be set. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "hideHeaderContentsDuringDrag", optionValue: boolean): void; + + /** + * Gets the opacity of the drag markup, while a column header is being dragged. + * The value must be between 0 and 1. When GroupBy is enabled, the corresponding option in the GroupBy configuration + * will be used with priority over this one. + * + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "dragHelperOpacity"): number; + + /** + * Sets the opacity of the drag markup, while a column header is being dragged. + * The value must be between 0 and 1. When GroupBy is enabled, the corresponding option in the GroupBy configuration + * will be used with priority over this one. + * + * + * @optionValue New value to be set. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "dragHelperOpacity", optionValue: number): void; + + /** + * Gets caption for each move down button in the column moving dialog + * + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogCaptionButtonDesc"): string; + + /** + * Sets caption for each move down button in the column moving dialog + * + * + * @optionValue New value to be set. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogCaptionButtonDesc", optionValue: string): void; + + /** + * Gets caption for each move up button in the column moving dialog + * + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogCaptionButtonAsc"): string; + + /** + * Sets caption for each move up button in the column moving dialog + * + * + * @optionValue New value to be set. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogCaptionButtonAsc", optionValue: string): void; + + /** + * Gets caption text for the column moving dialog + * + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogCaptionText"): string; + + /** + * Sets caption text for the column moving dialog + * + * + * @optionValue New value to be set. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogCaptionText", optionValue: string): void; + + /** + * Gets caption text for the feature chooser entry + * + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogDisplayText"): string; + + /** + * Sets caption text for the feature chooser entry + * + * + * @optionValue New value to be set. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogDisplayText", optionValue: string): void; + + /** + * Gets text for drop tooltip in column moving dialog + * + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogDropTooltipText"): string; + + /** + * Sets text for drop tooltip in column moving dialog + * + * + * @optionValue New value to be set. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogDropTooltipText", optionValue: string): void; + + /** + * Gets markup for drop tooltip in column moving dialog + * + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogDropTooltipMarkup"): string; + + /** + * Sets markup for drop tooltip in column moving dialog + * + * + * @optionValue New value to be set. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogDropTooltipMarkup", optionValue: string): void; + + /** + * Gets caption for the move left dropdown button + * + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "dropDownMoveLeftText"): string; + + /** + * Sets caption for the move left dropdown button + * + * + * @optionValue New value to be set. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "dropDownMoveLeftText", optionValue: string): void; + + /** + * Gets caption for the move right dropdown button + * + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "dropDownMoveRightText"): string; + + /** + * Sets caption for the move right dropdown button + * + * + * @optionValue New value to be set. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "dropDownMoveRightText", optionValue: string): void; + + /** + * Gets caption for the move first dropdown button + * + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "dropDownMoveFirstText"): string; + + /** + * Sets caption for the move first dropdown button + * + * + * @optionValue New value to be set. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "dropDownMoveFirstText", optionValue: string): void; + + /** + * Gets caption for the move last dropdown button + * + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "dropDownMoveLastText"): string; + + /** + * Sets caption for the move last dropdown button + * + * + * @optionValue New value to be set. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "dropDownMoveLastText", optionValue: string): void; + + /** + * Gets tooltip text for the move indicator + * + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingToolTipMove"): string; + + /** + * Sets tooltip text for the move indicator + * + * + * @optionValue New value to be set. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingToolTipMove", optionValue: string): void; + + /** + * Gets caption text for the feature chooser submenu button + * + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "featureChooserSubmenuText"): string; + + /** + * Sets caption text for the feature chooser submenu button + * + * + * @optionValue New value to be set. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "featureChooserSubmenuText", optionValue: string): void; + + /** + * Controls containment behavior of column moving dialog. + * + * owner The dialog will be draggable only in the grid area + * window The dialog will be draggable in the whole window area + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "columnMovingDialogContainment"): string; + + /** + * Controls containment behavior of column moving dialog. + * + * owner The dialog will be draggable only in the grid area + * window The dialog will be draggable in the whole window area + * + * @optionValue New value to be set. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "columnMovingDialogContainment", optionValue: string): void; + + /** + * Name of the dialog widget to be used. It should inherit from $.ui.igGridModalDialog. + * + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "dialogWidget"): string; + + /** + * Name of the dialog widget to be used. It should inherit from $.ui.igGridModalDialog. + * + * + * @optionValue New value to be set. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "dialogWidget", optionValue: string): void; + + /** + * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "inherit"): boolean; + + /** + * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. + * + * @optionValue New value to be set. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "inherit", optionValue: boolean): void; + + /** + * Event which is fired when a drag operation begins on a column header + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "columnDragStart"): ColumnDragStartEvent; + + /** + * Event which is fired when a drag operation begins on a column header + * + * @optionValue Define event handler function. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "columnDragStart", optionValue: ColumnDragStartEvent): void; + + /** + * Event which is fired when a drag operation ends on a column header + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "columnDragEnd"): ColumnDragEndEvent; + + /** + * Event which is fired when a drag operation ends on a column header + * + * @optionValue Define event handler function. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "columnDragEnd", optionValue: ColumnDragEndEvent): void; + + /** + * Event which is fired when a drag operation is canceled + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "columnDragCanceled"): ColumnDragCanceledEvent; + + /** + * Event which is fired when a drag operation is canceled + * + * @optionValue Define event handler function. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "columnDragCanceled", optionValue: ColumnDragCanceledEvent): void; + + /** + * Event which is fired when a column moving operation is initiated + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "columnMoving"): ColumnMovingEvent; + + /** + * Event which is fired when a column moving operation is initiated + * + * @optionValue Define event handler function. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "columnMoving", optionValue: ColumnMovingEvent): void; + + /** + * Event which is fired when a column moving operation completes + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "columnMoved"): ColumnMovedEvent; + + /** + * Event which is fired when a column moving operation completes + * + * @optionValue Define event handler function. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "columnMoved", optionValue: ColumnMovedEvent): void; + + /** + * Event fired before the moving dialog is opened. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogOpening"): MovingDialogOpeningEvent; + + /** + * Event fired before the moving dialog is opened. + * + * @optionValue Define event handler function. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogOpening", optionValue: MovingDialogOpeningEvent): void; + + /** + * Event fired after the column chooser is already opened. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogOpened"): MovingDialogOpenedEvent; + + /** + * Event fired after the column chooser is already opened. + * + * @optionValue Define event handler function. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogOpened", optionValue: MovingDialogOpenedEvent): void; + + /** + * Event fired every time the moving dialog changes its position. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogDragged"): MovingDialogDraggedEvent; + + /** + * Event fired every time the moving dialog changes its position. + * + * @optionValue Define event handler function. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogDragged", optionValue: MovingDialogDraggedEvent): void; + + /** + * Event fired before the moving dialog is closed. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogClosing"): MovingDialogClosingEvent; + + /** + * Event fired before the moving dialog is closed. + * + * @optionValue Define event handler function. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogClosing", optionValue: MovingDialogClosingEvent): void; + + /** + * Event fired after the moving dialog has been closed. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogClosed"): MovingDialogClosedEvent; + + /** + * Event fired after the moving dialog has been closed. + * + * @optionValue Define event handler function. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogClosed", optionValue: MovingDialogClosedEvent): void; + + /** + * Event fired before the contents of the model dialog are rendered. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogContentsRendering"): MovingDialogContentsRenderingEvent; + + /** + * Event fired before the contents of the model dialog are rendered. + * + * @optionValue Define event handler function. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogContentsRendering", optionValue: MovingDialogContentsRenderingEvent): void; + + /** + * Event fired after the contents of the model dialog are rendered. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogContentsRendered"): MovingDialogContentsRenderedEvent; + + /** + * Event fired after the contents of the model dialog are rendered. + * + * @optionValue Define event handler function. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogContentsRendered", optionValue: MovingDialogContentsRenderedEvent): void; + + /** + * Event fired when move up button is pressed in the moving dialog + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogMoveUpButtonPressed"): MovingDialogMoveUpButtonPressedEvent; + + /** + * Event fired when move up button is pressed in the moving dialog + * + * @optionValue Define event handler function. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogMoveUpButtonPressed", optionValue: MovingDialogMoveUpButtonPressedEvent): void; + + /** + * Event fired when move down button is pressed in the moving dialog + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogMoveDownButtonPressed"): MovingDialogMoveDownButtonPressedEvent; + + /** + * Event fired when move down button is pressed in the moving dialog + * + * @optionValue Define event handler function. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogMoveDownButtonPressed", optionValue: MovingDialogMoveDownButtonPressedEvent): void; + + /** + * Event fired when column moving is initiated through dragging it in the moving dialog + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogDragColumnMoving"): MovingDialogDragColumnMovingEvent; + + /** + * Event fired when column moving is initiated through dragging it in the moving dialog + * + * @optionValue Define event handler function. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogDragColumnMoving", optionValue: MovingDialogDragColumnMovingEvent): void; + + /** + * Event fired when column moving is completed through dragging it in the moving dialog + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogDragColumnMoved"): MovingDialogDragColumnMovedEvent; + + /** + * Event fired when column moving is completed through dragging it in the moving dialog + * + * @optionValue Define event handler function. + */ + igTreeGridColumnMoving(optionLiteral: 'option', optionName: "movingDialogDragColumnMoved", optionValue: MovingDialogDragColumnMovedEvent): void; igTreeGridColumnMoving(options: IgTreeGridColumnMoving): JQuery; igTreeGridColumnMoving(optionLiteral: 'option', optionName: string): any; igTreeGridColumnMoving(optionLiteral: 'option', options: IgTreeGridColumnMoving): JQuery; @@ -71768,6 +80719,411 @@ interface IgTreeGridFiltering { */ filterSummaryInPagerTemplate?: string; + /** + * Enables or disables the filtering case sensitivity. Works only for local filtering. If true, it case sensitive filtering is performed. If false, filtering is case insensitive. + * + */ + caseSensitive?: boolean; + + /** + * Enable/disable footer visibility with summary info about the filter. + * When false, the filter summary row (in the footer) will only be visible when paging is enabled (or some other feature that renders a footer). + * When true, the filter summary row will only be visible when a filter is applied i.e. it's not visible by default. + * + */ + filterSummaryAlwaysVisible?: boolean; + + /** + * Render in [Feature Chooser](http://www.igniteui.com/help/iggrid-feature-chooser) + * + */ + renderFC?: boolean; + + /** + * Summary template that will appear in the bottom left corner of the footer. Has the format '${matches} matching records'. + * + */ + filterSummaryTemplate?: string; + + /** + * Type of animations for the column filter dropdowns. + * + * + * Valid values: + * "linear" The column filtering drop downs are shown with a linear animation. + * "none" No animation is used when showing the filtering drop downs. + */ + filterDropDownAnimations?: string; + + /** + * Animation duration in milliseconds for the [filterDropDownAnimations](ui.iggridfiltering#options:filterDropDownAnimations). + * + */ + filterDropDownAnimationDuration?: number; + + /** + * Width of the column filter dropdowns. + * + * + * Valid values: + * "string" The width in pixels (0px) + * "number" The width in pixels as a number (0) + */ + filterDropDownWidth?: string|number; + + /** + * Height of the column filter dropdowns. + * + * string The height of the column filter dropdowns in pixels (0px). + * number The height of the column filter dropdowns in pixels as a number (0). + */ + filterDropDownHeight?: any; + + /** + * URL key name that specifies how the filtering expressions will be encoded for remote requests, e.g. &filter('col') = startsWith. Default is OData. + * + */ + filterExprUrlKey?: string; + + /** + * Enable/disable filter icons visibility. + * + * + * Valid values: + * "true" All predefined filters in the filter dropdowns will have icons rendered in front of the text. + * "false" No icons will be rendered. + */ + filterDropDownItemIcons?: boolean; + + /** + * A list of column settings that specifies custom filtering options on a per column basis. + * + */ + columnSettings?: IgGridFilteringColumnSetting[]; + + /** + * Type of filtering. Delegates all filtering functionality to the [$.ig.DataSource](ig.datasource). + * + * + * Valid values: + * "remote" Filtering is performed by a remote end-point. + * "local" Filtering is performed locally by the [$.ig.DataSource](ig.datasource). + */ + type?: string; + + /** + * Time in milliseconds for which widget will wait between keystrokes before sending filtering requests. + * + */ + filterDelay?: number; + + /** + * Default is 'simple' for non-virtualized grids, and 'advanced' when [virtualization](ui.iggrid#options:virtualization) is enabled. + * + * + * Valid values: + * "simple" Renders just a filter row. + * "advanced" Allows to configure multiple filters from a dialog - Excel style. + */ + mode?: string; + + /** + * Defines whether to render editors in advanced [mode](ui.iggridfiltering#options:mode). If false, no editors will be rendered in the advanced [mode](ui.iggridfiltering#options:mode). + * + */ + advancedModeEditorsVisible?: boolean; + + /** + * Location of the advanced filtering button when [advancedModeEditorsVisible](ui.iggridfiltering#options:advancedModeEditorsVisible) is false (i.e. when the button is rendered in the header). + * + * + * Valid values: + * "left" + * "right" + */ + advancedModeHeaderButtonLocation?: string; + + /** + * Default filter dialog width (used for Advanced filtering [mode](ui.iggridfiltering#options:mode)). + * + * + * Valid values: + * "string" The dialog window width in pixels (370px). + * "number" The dialog window width in pixels as a number (370). + */ + filterDialogWidth?: string|number; + + /** + * default filter dialog height (used for Advanced filtering [mode](ui.iggridfiltering#options:mode)). + * + * + * Valid values: + * "string" The dialog window height in pixels (350px). + * "number" The dialog window height in pixels as a number (350). + */ + filterDialogHeight?: string|number; + + /** + * Width of the filtering condition dropdowns in the advanced filter dialog. + * + * + * Valid values: + * "string" The filtering condition dropdowns width in pixels (80px). + * "number" The filtering condition dropdowns width in pixels as a number (80). + */ + filterDialogFilterDropDownDefaultWidth?: string|number; + + /** + * Width of the filtering expression input boxes in the advanced filter dialog. + * + * + * Valid values: + * "string" The filtering expression input boxes width in pixels (80px). + * "number" The filtering expression input boxes width in pixels as a number (80). + */ + filterDialogExprInputDefaultWidth?: string|number; + + /** + * Width of the column chooser dropdowns in the advanced filter dialog. + * + * + * Valid values: + * "string" The column chooser dropdowns width in pixels (80px). + * "number" The column chooser dropdowns width in pixels as a number (80). + */ + filterDialogColumnDropDownDefaultWidth?: string|number; + + /** + * Enable/disable filter button visibility. If false, no filter dropdown buttons will be rendered and a predefined list of filters will not be rendered for the columns. + * + */ + renderFilterButton?: boolean; + + /** + * The filtering button for filter dropdowns can be rendered either on the left of the filter editor, or on the right. + * + * + * Valid values: + * "left" The button is rendered on the left. + * "right" The button is rendered on the right. + */ + filterButtonLocation?: string; + + /** + * List of configurable and localized null texts that will be used for the filter editors. + * + */ + nullTexts?: IgGridFilteringNullTexts; + + /** + * A list of configurable and localized labels that are used for the predefined filtering conditions in the filter dropdowns. + * + */ + labels?: IgGridFilteringLabels; + + /** + * Custom tooltip template for the filter button, when a filter is applied. + * + */ + tooltipTemplate?: string; + + /** + * Custom template for add condition area in the filter dialog. The default template is "
${label1}
${label2}
". + * + */ + filterDialogAddConditionTemplate?: string; + + /** + * Custom template for options in dropdown in add condition area in the filter dialog. The default template is "". + * + */ + filterDialogAddConditionDropDownTemplate?: string; + + /** + * Custom template for filter dialog. + * Each DOM element which is used for selecting filter conditions/columns/filter expressions has "data-*" attribute. + * E.g.: DOM element used for selecting column has attribute "data-af-col", for selecting filter condition - "data-af-cond", for filter expression- "data-af-expr". + * NOTE: The template is supported only with . + * The default template is " ". + * + */ + filterDialogFilterTemplate?: string; + + /** + * Custom template for options in condition list in filter dialog. The default template is "". + * + */ + filterDialogFilterConditionTemplate?: string; + + /** + * Add button width - in the advanced filter dialog. + * + * + * Valid values: + * "string" The dialog Add button width in pixels (100px). + * "number" The dialog Add button width in pixels as a number (100). + */ + filterDialogAddButtonWidth?: string|number; + + /** + * Width of the Ok and Cancel buttons in the advanced filtering dialogs. + * + * + * Valid values: + * "string" The advanced filter dialog Ok and Cancel buttons width in pixels (120px). + * "number" The advanced filter dialog Ok and Cancel buttons width in pixels as a number (120). + */ + filterDialogOkCancelButtonWidth?: string|number; + + /** + * Maximum number of filter rows in the advanced filtering dialog. If this number is exceeded, an error message will be rendered. + * + */ + filterDialogMaxFilterCount?: number; + + /** + * Controls containment behavior. + * + * owner The filter dialog will be draggable only within the grid area. + * window The filter dialog will be draggable within the whole window area. + */ + filterDialogContainment?: string; + + /** + * Enable/disable empty condition visibility in the filter. If true, shows empty and not empty filtering conditions in the dropdowns. + * + */ + showEmptyConditions?: boolean; + + /** + * Enable/disable visibility of null and not null filtering conditions in the dropdowns. If true, shows null and not null filtering conditions in the dropdowns. + * + */ + showNullConditions?: boolean; + + /** + * Feature chooser text when filter is shown and filter [mode](ui.iggridfiltering#options:mode) is simple. + * + */ + featureChooserText?: string; + + /** + * Feature chooser text when filter is hidden and filter [mode](ui.iggridfiltering#options:mode) is simple. + * + */ + featureChooserTextHide?: string; + + /** + * Feature chooser text when filter [mode](ui.iggridfiltering#options:mode) is advanced. + * + */ + featureChooserTextAdvancedFilter?: string; + + /** + * Name of the dialog widget to be used. It should inherit from $.ui.igGridModalDialog. + * + */ + dialogWidget?: string; + + /** + * Enables/disables filtering persistence between states. + * + */ + persist?: boolean; + + /** + * Enables/disables feature inheritance for the child [layouts](ui.ighierarchicalgrid#options:columnLayouts). NOTE: It only applies for [igHierarchicalGrid](ui.ighierarchicalgrid). + * + */ + inherit?: boolean; + + /** + * Event fired before a filtering operation is executed (remote request or local). + * Return false in order to cancel filtering operation. + */ + dataFiltering?: DataFilteringEvent; + + /** + * Event fired after the filtering has been executed and results are rendered. + */ + dataFiltered?: DataFilteredEvent; + + /** + * Event fired before the filter dropdown is opened for a specific column. + * Return false in order to cancel dropdown opening. + */ + dropDownOpening?: DropDownOpeningEvent; + + /** + * Event fired after the filter dropdown is opened for a specific column. + */ + dropDownOpened?: DropDownOpenedEvent; + + /** + * Event fired before the filter dropdown starts closing. + * Return false in order to cancel dropdown closing. + */ + dropDownClosing?: DropDownClosingEvent; + + /** + * Event fired after a filter column dropdown is completely closed. + */ + dropDownClosed?: DropDownClosedEvent; + + /** + * Event fired before the advanced filtering dialog is opened. + * Return false in order to cancel filter dialog opening. + */ + filterDialogOpening?: FilterDialogOpeningEvent; + + /** + * Event fired after the advanced filter dialog is already opened. + */ + filterDialogOpened?: FilterDialogOpenedEvent; + + /** + * Event fired every time the advanced filter dialog changes its position. + */ + filterDialogMoving?: FilterDialogMovingEvent; + + /** + * Event fired before a filter row is added to the advanced filter dialog. + * Return false in order to cancel filter adding to the advanced filtering dialog. + */ + filterDialogFilterAdding?: FilterDialogFilterAddingEvent; + + /** + * Event fired after a filter row is added to the advanced filter dialog. + */ + filterDialogFilterAdded?: FilterDialogFilterAddedEvent; + + /** + * Event fired before the advanced filter dialog is closed. + * Return false in order to cancel filtering dialog closing. + */ + filterDialogClosing?: FilterDialogClosingEvent; + + /** + * Event fired after the advanced filter dialog has been closed. + */ + filterDialogClosed?: FilterDialogClosedEvent; + + /** + * Event fired before the contents of the advanced filter dialog are rendered. + * Return false in order to cancel filtering dialog rendering. + */ + filterDialogContentsRendering?: FilterDialogContentsRenderingEvent; + + /** + * Event fired after the contents of the advanced filter dialog are rendered. + */ + filterDialogContentsRendered?: FilterDialogContentsRenderedEvent; + + /** + * Event fired when the OK button in the advanced filter dialog is pressed. + */ + filterDialogFiltering?: FilterDialogFilteringEvent; + /** * Option for igTreeGridFiltering */ @@ -71779,6 +81135,29 @@ interface IgTreeGridFilteringMethods { */ getFilteringMatchesCount(): number; destroy(): void; + + /** + * Toggle filter row when mode is simple or [advancedModeEditorsVisible](ui.iggridfiltering#options:advancedModeEditorsVisible) is true. Otherwise show/hide advanced dialog. + * + * @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 addedFromAdvanced + */ + filter(expressions: any[], updateUI?: boolean, addedFromAdvanced?: boolean): void; + + /** + * 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. + */ + requiresFilteringExpression(filterCondition: string): boolean; } interface JQuery { data(propertyName: "igTreeGridFiltering"): IgTreeGridFilteringMethods; @@ -71787,6 +81166,9 @@ interface JQuery { interface JQuery { igTreeGridFiltering(methodName: "getFilteringMatchesCount"): number; igTreeGridFiltering(methodName: "destroy"): void; + igTreeGridFiltering(methodName: "toggleFilterRowByFeatureChooser", event: string): void; + igTreeGridFiltering(methodName: "filter", expressions: any[], updateUI?: boolean, addedFromAdvanced?: boolean): void; + igTreeGridFiltering(methodName: "requiresFilteringExpression", filterCondition: string): boolean; /** * The property in the response that will hold the total number of records in the data source @@ -71885,6 +81267,820 @@ interface JQuery { * @optionValue New value to be set. */ igTreeGridFiltering(optionLiteral: 'option', optionName: "filterSummaryInPagerTemplate", optionValue: string): void; + + /** + * Enables or disables the filtering case sensitivity. Works only for local filtering. If true, it case sensitive filtering is performed. If false, filtering is case insensitive. + * + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "caseSensitive"): boolean; + + /** + * Enables or disables the filtering case sensitivity. Works only for local filtering. If true, it case sensitive filtering is performed. If false, filtering is case insensitive. + * + * + * @optionValue New value to be set. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "caseSensitive", optionValue: boolean): void; + + /** + * Enable/disable footer visibility with summary info about the filter. + * When false, the filter summary row (in the footer) will only be visible when paging is enabled (or some other feature that renders a footer). + * When true, the filter summary row will only be visible when a filter is applied i.e. it's not visible by default. + * + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterSummaryAlwaysVisible"): boolean; + + /** + * Enable/disable footer visibility with summary info about the filter. + * When false, the filter summary row (in the footer) will only be visible when paging is enabled (or some other feature that renders a footer). + * When true, the filter summary row will only be visible when a filter is applied i.e. it's not visible by default. + * + * + * @optionValue New value to be set. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterSummaryAlwaysVisible", optionValue: boolean): void; + + /** + * Render in [Feature Chooser](http://www.igniteui.com/help/iggrid-feature-chooser) + * + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "renderFC"): boolean; + + /** + * Render in [Feature Chooser](http://www.igniteui.com/help/iggrid-feature-chooser) + * + * + * @optionValue New value to be set. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "renderFC", optionValue: boolean): void; + + /** + * Summary template that will appear in the bottom left corner of the footer. Has the format '${matches} matching records'. + * + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterSummaryTemplate"): string; + + /** + * Summary template that will appear in the bottom left corner of the footer. Has the format '${matches} matching records'. + * + * + * @optionValue New value to be set. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterSummaryTemplate", optionValue: string): void; + + /** + * Type of animations for the column filter dropdowns. + * + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDropDownAnimations"): string; + + /** + * Type of animations for the column filter dropdowns. + * + * + * @optionValue New value to be set. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDropDownAnimations", optionValue: string): void; + + /** + * Animation duration in milliseconds for the [filterDropDownAnimations](ui.iggridfiltering#options:filterDropDownAnimations). + * + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDropDownAnimationDuration"): number; + + /** + * Animation duration in milliseconds for the [filterDropDownAnimations](ui.iggridfiltering#options:filterDropDownAnimations). + * + * + * @optionValue New value to be set. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDropDownAnimationDuration", optionValue: number): void; + + /** + * Width of the column filter dropdowns. + * + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDropDownWidth"): string|number; + + /** + * Width of the column filter dropdowns. + * + * + * @optionValue New value to be set. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDropDownWidth", optionValue: string|number): void; + + /** + * Height of the column filter dropdowns. + * + * string The height of the column filter dropdowns in pixels (0px). + * number The height of the column filter dropdowns in pixels as a number (0). + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDropDownHeight"): any; + + /** + * Height of the column filter dropdowns. + * + * string The height of the column filter dropdowns in pixels (0px). + * number The height of the column filter dropdowns in pixels as a number (0). + * + * @optionValue New value to be set. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDropDownHeight", optionValue: any): void; + + /** + * URL key name that specifies how the filtering expressions will be encoded for remote requests, e.g. &filter('col') = startsWith. Default is OData. + * + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterExprUrlKey"): string; + + /** + * URL key name that specifies how the filtering expressions will be encoded for remote requests, e.g. &filter('col') = startsWith. Default is OData. + * + * + * @optionValue New value to be set. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterExprUrlKey", optionValue: string): void; + + /** + * Enable/disable filter icons visibility. + * + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDropDownItemIcons"): boolean; + + /** + * Enable/disable filter icons visibility. + * + * + * @optionValue New value to be set. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDropDownItemIcons", optionValue: boolean): void; + + /** + * A list of column settings that specifies custom filtering options on a per column basis. + * + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "columnSettings"): IgGridFilteringColumnSetting[]; + + /** + * A list of column settings that specifies custom filtering options on a per column basis. + * + * + * @optionValue New value to be set. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "columnSettings", optionValue: IgGridFilteringColumnSetting[]): void; + + /** + * Type of filtering. Delegates all filtering functionality to the [$.ig.DataSource](ig.datasource). + * + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "type"): string; + + /** + * Type of filtering. Delegates all filtering functionality to the [$.ig.DataSource](ig.datasource). + * + * + * @optionValue New value to be set. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "type", optionValue: string): void; + + /** + * Time in milliseconds for which widget will wait between keystrokes before sending filtering requests. + * + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDelay"): number; + + /** + * Time in milliseconds for which widget will wait between keystrokes before sending filtering requests. + * + * + * @optionValue New value to be set. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDelay", optionValue: number): void; + + /** + * Default is 'simple' for non-virtualized grids, and 'advanced' when [virtualization](ui.iggrid#options:virtualization) is enabled. + * + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "mode"): string; + + /** + * Default is 'simple' for non-virtualized grids, and 'advanced' when [virtualization](ui.iggrid#options:virtualization) is enabled. + * + * + * @optionValue New value to be set. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "mode", optionValue: string): void; + + /** + * Defines whether to render editors in advanced [mode](ui.iggridfiltering#options:mode). If false, no editors will be rendered in the advanced [mode](ui.iggridfiltering#options:mode). + * + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "advancedModeEditorsVisible"): boolean; + + /** + * Defines whether to render editors in advanced [mode](ui.iggridfiltering#options:mode). If false, no editors will be rendered in the advanced [mode](ui.iggridfiltering#options:mode). + * + * + * @optionValue New value to be set. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "advancedModeEditorsVisible", optionValue: boolean): void; + + /** + * 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; + + /** + * Location of the advanced filtering button when [advancedModeEditorsVisible](ui.iggridfiltering#options:advancedModeEditorsVisible) is false (i.e. when the button is rendered in the header). + * + * + * @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; + + /** + * Default filter dialog width (used for Advanced filtering [mode](ui.iggridfiltering#options:mode)). + * + * + * @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; + + /** + * Default filter dialog height (used for Advanced filtering [mode](ui.iggridfiltering#options:mode)). + * + * + * @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; + + /** + * Width of the filtering condition dropdowns in the advanced filter dialog. + * + * + * @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; + + /** + * Width of the filtering expression input boxes in the advanced filter dialog. + * + * + * @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; + + /** + * Width of the column chooser dropdowns in the advanced filter dialog. + * + * + * @optionValue New value to be set. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogColumnDropDownDefaultWidth", optionValue: string|number): void; + + /** + * Enable/disable filter button visibility. If false, no filter dropdown buttons will be rendered and a predefined list of filters will not be rendered for the columns. + * + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "renderFilterButton"): boolean; + + /** + * Enable/disable filter button visibility. If false, no filter dropdown buttons will be rendered and a predefined list of filters will not be rendered for the columns. + * + * + * @optionValue New value to be set. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "renderFilterButton", optionValue: boolean): void; + + /** + * 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; + + /** + * The filtering button for filter dropdowns can be rendered either on the left of the filter editor, or on the right. + * + * + * @optionValue New value to be set. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterButtonLocation", optionValue: string): void; + + /** + * List of configurable and localized null texts that will be used for the filter editors. + * + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "nullTexts"): IgGridFilteringNullTexts; + + /** + * List of configurable and localized null texts that will be used for the filter editors. + * + * + * @optionValue New value to be set. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "nullTexts", optionValue: IgGridFilteringNullTexts): void; + + /** + * A list of configurable and localized labels that are used for the predefined filtering conditions in the filter dropdowns. + * + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "labels"): IgGridFilteringLabels; + + /** + * A list of configurable and localized labels that are used for the predefined filtering conditions in the filter dropdowns. + * + * + * @optionValue New value to be set. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "labels", optionValue: IgGridFilteringLabels): void; + + /** + * Custom tooltip template for the filter button, when a filter is applied. + * + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "tooltipTemplate"): string; + + /** + * Custom tooltip template for the filter button, when a filter is applied. + * + * + * @optionValue New value to be set. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "tooltipTemplate", optionValue: string): void; + + /** + * Custom template for add condition area in the filter dialog. The default template is "
${label1}
${label2}
". + * + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogAddConditionTemplate"): string; + + /** + * Custom template for add condition area in the filter dialog. The default template is "
${label1}
${label2}
". + * + * + * @optionValue New value to be set. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogAddConditionTemplate", optionValue: string): void; + + /** + * Custom template for options in dropdown in add condition area in the filter dialog. The default template is "". + * + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogAddConditionDropDownTemplate"): string; + + /** + * Custom template for options in dropdown in add condition area in the filter dialog. The default template is "". + * + * + * @optionValue New value to be set. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogAddConditionDropDownTemplate", optionValue: string): void; + + /** + * Custom template for filter dialog. + * Each DOM element which is used for selecting filter conditions/columns/filter expressions has "data-*" attribute. + * E.g.: DOM element used for selecting column has attribute "data-af-col", for selecting filter condition - "data-af-cond", for filter expression- "data-af-expr". + * NOTE: The template is supported only with . + * The default template is " ". + * + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogFilterTemplate"): string; + + /** + * Custom template for filter dialog. + * Each DOM element which is used for selecting filter conditions/columns/filter expressions has "data-*" attribute. + * E.g.: DOM element used for selecting column has attribute "data-af-col", for selecting filter condition - "data-af-cond", for filter expression- "data-af-expr". + * NOTE: The template is supported only with . + * The default template is " ". + * + * + * @optionValue New value to be set. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogFilterTemplate", optionValue: string): void; + + /** + * Custom template for options in condition list in filter dialog. The default template is "". + * + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogFilterConditionTemplate"): string; + + /** + * Custom template for options in condition list in filter dialog. The default template is "". + * + * + * @optionValue New value to be set. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogFilterConditionTemplate", optionValue: string): void; + + /** + * Add button width - in the advanced filter dialog. + * + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogAddButtonWidth"): string|number; + + /** + * Add button width - in the advanced filter dialog. + * + * + * @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; + + /** + * Width of the Ok and Cancel buttons in the advanced filtering dialogs. + * + * + * @optionValue New value to be set. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogOkCancelButtonWidth", optionValue: string|number): void; + + /** + * Maximum number of filter rows in the advanced filtering dialog. If this number is exceeded, an error message will be rendered. + * + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogMaxFilterCount"): number; + + /** + * Maximum number of filter rows in the advanced filtering dialog. If this number is exceeded, an error message will be rendered. + * + * + * @optionValue New value to be set. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogMaxFilterCount", optionValue: number): void; + + /** + * Controls containment behavior. + * + * owner The filter dialog will be draggable only within the grid area. + * window The filter dialog will be draggable within the whole window area. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogContainment"): string; + + /** + * Controls containment behavior. + * + * owner The filter dialog will be draggable only within the grid area. + * window The filter dialog will be draggable within the whole window area. + * + * @optionValue New value to be set. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogContainment", optionValue: string): void; + + /** + * Enable/disable empty condition visibility in the filter. If true, shows empty and not empty filtering conditions in the dropdowns. + * + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "showEmptyConditions"): boolean; + + /** + * Enable/disable empty condition visibility in the filter. If true, shows empty and not empty filtering conditions in the dropdowns. + * + * + * @optionValue New value to be set. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "showEmptyConditions", optionValue: boolean): void; + + /** + * Enable/disable visibility of null and not null filtering conditions in the dropdowns. If true, shows null and not null filtering conditions in the dropdowns. + * + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "showNullConditions"): boolean; + + /** + * Enable/disable visibility of null and not null filtering conditions in the dropdowns. If true, shows null and not null filtering conditions in the dropdowns. + * + * + * @optionValue New value to be set. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "showNullConditions", optionValue: boolean): void; + + /** + * Feature chooser text when filter is shown and filter [mode](ui.iggridfiltering#options:mode) is simple. + * + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "featureChooserText"): string; + + /** + * Feature chooser text when filter is shown and filter [mode](ui.iggridfiltering#options:mode) is simple. + * + * + * @optionValue New value to be set. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "featureChooserText", optionValue: string): void; + + /** + * Feature chooser text when filter is hidden and filter [mode](ui.iggridfiltering#options:mode) is simple. + * + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "featureChooserTextHide"): string; + + /** + * Feature chooser text when filter is hidden and filter [mode](ui.iggridfiltering#options:mode) is simple. + * + * + * @optionValue New value to be set. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "featureChooserTextHide", optionValue: string): void; + + /** + * Feature chooser text when filter [mode](ui.iggridfiltering#options:mode) is advanced. + * + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "featureChooserTextAdvancedFilter"): string; + + /** + * Feature chooser text when filter [mode](ui.iggridfiltering#options:mode) is advanced. + * + * + * @optionValue New value to be set. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "featureChooserTextAdvancedFilter", optionValue: string): void; + + /** + * Name of the dialog widget to be used. It should inherit from $.ui.igGridModalDialog. + * + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "dialogWidget"): string; + + /** + * Name of the dialog widget to be used. It should inherit from $.ui.igGridModalDialog. + * + * + * @optionValue New value to be set. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "dialogWidget", optionValue: string): void; + + /** + * Enables/disables filtering persistence between states. + * + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "persist"): boolean; + + /** + * Enables/disables filtering persistence between states. + * + * + * @optionValue New value to be set. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "persist", optionValue: boolean): void; + + /** + * Enables/disables feature inheritance for the child [layouts](ui.ighierarchicalgrid#options:columnLayouts). NOTE: It only applies for [igHierarchicalGrid](ui.ighierarchicalgrid). + * + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "inherit"): boolean; + + /** + * Enables/disables feature inheritance for the child [layouts](ui.ighierarchicalgrid#options:columnLayouts). NOTE: It only applies for [igHierarchicalGrid](ui.ighierarchicalgrid). + * + * + * @optionValue New value to be set. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "inherit", optionValue: boolean): void; + + /** + * Event fired before a filtering operation is executed (remote request or local). + * Return false in order to cancel filtering operation. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "dataFiltering"): DataFilteringEvent; + + /** + * Event fired before a filtering operation is executed (remote request or local). + * Return false in order to cancel filtering operation. + * + * @optionValue Define event handler function. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "dataFiltering", optionValue: DataFilteringEvent): void; + + /** + * Event fired after the filtering has been executed and results are rendered. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "dataFiltered"): DataFilteredEvent; + + /** + * Event fired after the filtering has been executed and results are rendered. + * + * @optionValue Define event handler function. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "dataFiltered", optionValue: DataFilteredEvent): void; + + /** + * Event fired before the filter dropdown is opened for a specific column. + * Return false in order to cancel dropdown opening. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "dropDownOpening"): DropDownOpeningEvent; + + /** + * Event fired before the filter dropdown is opened for a specific column. + * Return false in order to cancel dropdown opening. + * + * @optionValue Define event handler function. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "dropDownOpening", optionValue: DropDownOpeningEvent): void; + + /** + * Event fired after the filter dropdown is opened for a specific column. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "dropDownOpened"): DropDownOpenedEvent; + + /** + * Event fired after the filter dropdown is opened for a specific column. + * + * @optionValue Define event handler function. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "dropDownOpened", optionValue: DropDownOpenedEvent): void; + + /** + * Event fired before the filter dropdown starts closing. + * Return false in order to cancel dropdown closing. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "dropDownClosing"): DropDownClosingEvent; + + /** + * Event fired before the filter dropdown starts closing. + * Return false in order to cancel dropdown closing. + * + * @optionValue Define event handler function. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "dropDownClosing", optionValue: DropDownClosingEvent): void; + + /** + * Event fired after a filter column dropdown is completely closed. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "dropDownClosed"): DropDownClosedEvent; + + /** + * Event fired after a filter column dropdown is completely closed. + * + * @optionValue Define event handler function. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "dropDownClosed", optionValue: DropDownClosedEvent): void; + + /** + * Event fired before the advanced filtering dialog is opened. + * Return false in order to cancel filter dialog opening. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogOpening"): FilterDialogOpeningEvent; + + /** + * Event fired before the advanced filtering dialog is opened. + * Return false in order to cancel filter dialog opening. + * + * @optionValue Define event handler function. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogOpening", optionValue: FilterDialogOpeningEvent): void; + + /** + * Event fired after the advanced filter dialog is already opened. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogOpened"): FilterDialogOpenedEvent; + + /** + * Event fired after the advanced filter dialog is already opened. + * + * @optionValue Define event handler function. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogOpened", optionValue: FilterDialogOpenedEvent): void; + + /** + * Event fired every time the advanced filter dialog changes its position. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogMoving"): FilterDialogMovingEvent; + + /** + * Event fired every time the advanced filter dialog changes its position. + * + * @optionValue Define event handler function. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogMoving", optionValue: FilterDialogMovingEvent): void; + + /** + * Event fired before a filter row is added to the advanced filter dialog. + * Return false in order to cancel filter adding to the advanced filtering dialog. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogFilterAdding"): FilterDialogFilterAddingEvent; + + /** + * Event fired before a filter row is added to the advanced filter dialog. + * Return false in order to cancel filter adding to the advanced filtering dialog. + * + * @optionValue Define event handler function. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogFilterAdding", optionValue: FilterDialogFilterAddingEvent): void; + + /** + * Event fired after a filter row is added to the advanced filter dialog. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogFilterAdded"): FilterDialogFilterAddedEvent; + + /** + * Event fired after a filter row is added to the advanced filter dialog. + * + * @optionValue Define event handler function. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogFilterAdded", optionValue: FilterDialogFilterAddedEvent): void; + + /** + * Event fired before the advanced filter dialog is closed. + * Return false in order to cancel filtering dialog closing. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogClosing"): FilterDialogClosingEvent; + + /** + * Event fired before the advanced filter dialog is closed. + * Return false in order to cancel filtering dialog closing. + * + * @optionValue Define event handler function. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogClosing", optionValue: FilterDialogClosingEvent): void; + + /** + * Event fired after the advanced filter dialog has been closed. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogClosed"): FilterDialogClosedEvent; + + /** + * Event fired after the advanced filter dialog has been closed. + * + * @optionValue Define event handler function. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogClosed", optionValue: FilterDialogClosedEvent): void; + + /** + * Event fired before the contents of the advanced filter dialog are rendered. + * Return false in order to cancel filtering dialog rendering. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogContentsRendering"): FilterDialogContentsRenderingEvent; + + /** + * Event fired before the contents of the advanced filter dialog are rendered. + * Return false in order to cancel filtering dialog rendering. + * + * @optionValue Define event handler function. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogContentsRendering", optionValue: FilterDialogContentsRenderingEvent): void; + + /** + * Event fired after the contents of the advanced filter dialog are rendered. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogContentsRendered"): FilterDialogContentsRenderedEvent; + + /** + * Event fired after the contents of the advanced filter dialog are rendered. + * + * @optionValue Define event handler function. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogContentsRendered", optionValue: FilterDialogContentsRenderedEvent): void; + + /** + * Event fired when the OK button in the advanced filter dialog is pressed. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogFiltering"): FilterDialogFilteringEvent; + + /** + * Event fired when the OK button in the advanced filter dialog is pressed. + * + * @optionValue Define event handler function. + */ + igTreeGridFiltering(optionLiteral: 'option', optionName: "filterDialogFiltering", optionValue: FilterDialogFilteringEvent): void; igTreeGridFiltering(options: IgTreeGridFiltering): JQuery; igTreeGridFiltering(optionLiteral: 'option', optionName: string): any; igTreeGridFiltering(optionLiteral: 'option', options: IgTreeGridFiltering): JQuery; @@ -72010,153 +82206,81 @@ interface IgTreeGridHiding { /** * Event fired before a hiding operation is executed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the hidden column index. Has a value only if the column's key is a number. - * Use ui.columnKey to get the hidden column key. Has a value only if the column's key is a string. */ columnHiding?: ColumnHidingEvent; /** * Event fired when trying to hide all columns in fixed or unfixed area. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnKeys array of column keys. Has a value only if the column's key is a string. */ columnHidingRefused?: ColumnHidingRefusedEvent; /** * Event fired when trying to show column(s) in fixed area and total width of fixed are will be larger than whole grid width. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnKeys array of column keys. Has a value only if the column's key is a string. */ columnShowingRefused?: ColumnShowingRefusedEvent; /** * Event fired before a hiding operation is executed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnKeys to get array of the hidden column keys. In case when click on Reset button in column chooser then this is an array of column keys. */ multiColumnHiding?: MultiColumnHidingEvent; /** * Event fired after the hiding has been executed and results are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the hidden column index. Has a value only if the column's key is a number. - * Use ui.columnKey to get the hidden column key. Has a value only if the column's key is a string. */ columnHidden?: ColumnHiddenEvent; /** * Event fired before a showing operation is executed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the shown column index. - * Use ui.columnKey to get the shown column key. */ columnShowing?: ColumnShowingEvent; /** * Event fired after the showing has been executed and results are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the shown column index. - * Use ui.columnKey to get the shown column key. */ columnShown?: ColumnShownEvent; /** * Event fired before the column chooser is opened. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. */ columnChooserOpening?: ColumnChooserOpeningEvent; /** * Event fired after the column chooser is already opened. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. */ columnChooserOpened?: ColumnChooserOpenedEvent; /** * Event fired every time the column chooser changes its position. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. - * Use ui.originalPosition to get the original position of the column chooser div as { top, left } object, relative to the page. - * Use ui.position to get the current position of the column chooser div as { top, left } object, relative to the page. */ columnChooserMoving?: ColumnChooserMovingEvent; /** * Event fired before the column chooser is closed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. */ columnChooserClosing?: ColumnChooserClosingEvent; /** * Event fired after the column chooser has been closed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. */ columnChooserClosed?: ColumnChooserClosedEvent; /** * Event fired before the contents of the column chooser are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. */ columnChooserContentsRendering?: ColumnChooserContentsRenderingEvent; /** * Event fired after the contents of the column chooser are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. */ columnChooserContentsRendered?: ColumnChooserContentsRenderedEvent; /** * Event fired when button Apply in column chooser is clicked - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. - * Use ui.columnsToShow to get array of columns identifiers which should be shown - * Use ui.columnsToHide to get array of columns identifiers which should be hidden */ columnChooserButtonApplyClick?: ColumnChooserButtonApplyClickEvent; /** * Event fired when button Reset in column chooser is clicked - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. */ columnChooserButtonResetClick?: ColumnChooserButtonResetClickEvent; @@ -72525,21 +82649,11 @@ interface JQuery { /** * Event fired before a hiding operation is executed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the hidden column index. Has a value only if the column's key is a number. - * Use ui.columnKey to get the hidden column key. Has a value only if the column's key is a string. */ igTreeGridHiding(optionLiteral: 'option', optionName: "columnHiding"): ColumnHidingEvent; /** * Event fired before a hiding operation is executed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the hidden column index. Has a value only if the column's key is a number. - * Use ui.columnKey to get the hidden column key. Has a value only if the column's key is a string. * * @optionValue Define event handler function. */ @@ -72547,19 +82661,11 @@ interface JQuery { /** * Event fired when trying to hide all columns in fixed or unfixed area. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnKeys array of column keys. Has a value only if the column's key is a string. */ igTreeGridHiding(optionLiteral: 'option', optionName: "columnHidingRefused"): ColumnHidingRefusedEvent; /** * Event fired when trying to hide all columns in fixed or unfixed area. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnKeys array of column keys. Has a value only if the column's key is a string. * * @optionValue Define event handler function. */ @@ -72567,19 +82673,11 @@ interface JQuery { /** * Event fired when trying to show column(s) in fixed area and total width of fixed are will be larger than whole grid width. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnKeys array of column keys. Has a value only if the column's key is a string. */ igTreeGridHiding(optionLiteral: 'option', optionName: "columnShowingRefused"): ColumnShowingRefusedEvent; /** * Event fired when trying to show column(s) in fixed area and total width of fixed are will be larger than whole grid width. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnKeys array of column keys. Has a value only if the column's key is a string. * * @optionValue Define event handler function. */ @@ -72587,19 +82685,11 @@ interface JQuery { /** * Event fired before a hiding operation is executed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnKeys to get array of the hidden column keys. In case when click on Reset button in column chooser then this is an array of column keys. */ igTreeGridHiding(optionLiteral: 'option', optionName: "multiColumnHiding"): MultiColumnHidingEvent; /** * Event fired before a hiding operation is executed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnKeys to get array of the hidden column keys. In case when click on Reset button in column chooser then this is an array of column keys. * * @optionValue Define event handler function. */ @@ -72607,21 +82697,11 @@ interface JQuery { /** * Event fired after the hiding has been executed and results are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the hidden column index. Has a value only if the column's key is a number. - * Use ui.columnKey to get the hidden column key. Has a value only if the column's key is a string. */ igTreeGridHiding(optionLiteral: 'option', optionName: "columnHidden"): ColumnHiddenEvent; /** * Event fired after the hiding has been executed and results are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the hidden column index. Has a value only if the column's key is a number. - * Use ui.columnKey to get the hidden column key. Has a value only if the column's key is a string. * * @optionValue Define event handler function. */ @@ -72629,21 +82709,11 @@ interface JQuery { /** * Event fired before a showing operation is executed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the shown column index. - * Use ui.columnKey to get the shown column key. */ igTreeGridHiding(optionLiteral: 'option', optionName: "columnShowing"): ColumnShowingEvent; /** * Event fired before a showing operation is executed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the shown column index. - * Use ui.columnKey to get the shown column key. * * @optionValue Define event handler function. */ @@ -72651,21 +82721,11 @@ interface JQuery { /** * Event fired after the showing has been executed and results are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the shown column index. - * Use ui.columnKey to get the shown column key. */ igTreeGridHiding(optionLiteral: 'option', optionName: "columnShown"): ColumnShownEvent; /** * Event fired after the showing has been executed and results are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the shown column index. - * Use ui.columnKey to get the shown column key. * * @optionValue Define event handler function. */ @@ -72673,19 +82733,11 @@ interface JQuery { /** * Event fired before the column chooser is opened. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. */ igTreeGridHiding(optionLiteral: 'option', optionName: "columnChooserOpening"): ColumnChooserOpeningEvent; /** * Event fired before the column chooser is opened. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. * * @optionValue Define event handler function. */ @@ -72693,19 +82745,11 @@ interface JQuery { /** * Event fired after the column chooser is already opened. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. */ igTreeGridHiding(optionLiteral: 'option', optionName: "columnChooserOpened"): ColumnChooserOpenedEvent; /** * Event fired after the column chooser is already opened. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. * * @optionValue Define event handler function. */ @@ -72713,23 +82757,11 @@ interface JQuery { /** * Event fired every time the column chooser changes its position. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. - * Use ui.originalPosition to get the original position of the column chooser div as { top, left } object, relative to the page. - * Use ui.position to get the current position of the column chooser div as { top, left } object, relative to the page. */ igTreeGridHiding(optionLiteral: 'option', optionName: "columnChooserMoving"): ColumnChooserMovingEvent; /** * Event fired every time the column chooser changes its position. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. - * Use ui.originalPosition to get the original position of the column chooser div as { top, left } object, relative to the page. - * Use ui.position to get the current position of the column chooser div as { top, left } object, relative to the page. * * @optionValue Define event handler function. */ @@ -72737,19 +82769,11 @@ interface JQuery { /** * Event fired before the column chooser is closed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. */ igTreeGridHiding(optionLiteral: 'option', optionName: "columnChooserClosing"): ColumnChooserClosingEvent; /** * Event fired before the column chooser is closed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. * * @optionValue Define event handler function. */ @@ -72757,19 +82781,11 @@ interface JQuery { /** * Event fired after the column chooser has been closed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. */ igTreeGridHiding(optionLiteral: 'option', optionName: "columnChooserClosed"): ColumnChooserClosedEvent; /** * Event fired after the column chooser has been closed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. * * @optionValue Define event handler function. */ @@ -72777,19 +82793,11 @@ interface JQuery { /** * Event fired before the contents of the column chooser are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. */ igTreeGridHiding(optionLiteral: 'option', optionName: "columnChooserContentsRendering"): ColumnChooserContentsRenderingEvent; /** * Event fired before the contents of the column chooser are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. * * @optionValue Define event handler function. */ @@ -72797,19 +82805,11 @@ interface JQuery { /** * Event fired after the contents of the column chooser are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. */ igTreeGridHiding(optionLiteral: 'option', optionName: "columnChooserContentsRendered"): ColumnChooserContentsRenderedEvent; /** * Event fired after the contents of the column chooser are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. * * @optionValue Define event handler function. */ @@ -72817,23 +82817,11 @@ interface JQuery { /** * Event fired when button Apply in column chooser is clicked - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. - * Use ui.columnsToShow to get array of columns identifiers which should be shown - * Use ui.columnsToHide to get array of columns identifiers which should be hidden */ igTreeGridHiding(optionLiteral: 'option', optionName: "columnChooserButtonApplyClick"): ColumnChooserButtonApplyClickEvent; /** * Event fired when button Apply in column chooser is clicked - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. - * Use ui.columnsToShow to get array of columns identifiers which should be shown - * Use ui.columnsToHide to get array of columns identifiers which should be hidden * * @optionValue Define event handler function. */ @@ -72841,19 +82829,11 @@ interface JQuery { /** * Event fired when button Reset in column chooser is clicked - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. */ igTreeGridHiding(optionLiteral: 'option', optionName: "columnChooserButtonResetClick"): ColumnChooserButtonResetClickEvent; /** * Event fired when button Reset in column chooser is clicked - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridHiding widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. * * @optionValue Define event handler function. */ @@ -72866,16 +82846,30 @@ interface JQuery { } interface IgTreeGridDataSourceSettings { /** + * *** IMPORTANT DEPRECATED *** Use the expandedKey option instead. * The name of the property that keeps track of the expansion state of a data item. Defaults to __ig_options.expanded. * */ - propertyExpanded?: string; + propertyExpanded?: any; + + /** + * *** IMPORTANT DEPRECATED *** Use the dataLevelKey option instead. + * The name of the property that keeps track of the level in the hierarchy.Defaults to __ig_options.dataLevel. + * + */ + propertyDataLevel?: any; + + /** + * The name of the property that keeps track of the expansion state of a data item. Defaults to __ig_options.expanded. + * + */ + expandedKey?: string; /** * The name of the property that keeps track of the level in the hierarchy.Defaults to __ig_options.dataLevel. * */ - propertyDataLevel?: string; + dataLevelKey?: string; /** * If set to TRUE it is expected that the source of data is normalized and transformed(has set dataLevel and expansion state). The source of data is used as flatDataView. Usually used when the paging is remote and paging mode is allLevels, or features are remote(and the processing of the returned result should be made on the server) @@ -72974,44 +82968,490 @@ interface IgTreeGrid { */ dataSourceSettings?: IgTreeGridDataSourceSettings; + /** + * 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). + * + * + * Valid values: + * "string" The widget width can be set in pixels (px) or percentage (%). Example values: "800px", "800" (defaults to pixels), "100%". + * "number" The widget width can be set in pixels as a number. Example values: 800, 700. + * "null" will stretch to fit the sum of the columns widths. + */ + width?: string|number; + + /** + * 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). + * + * + * Valid values: + * "string" The widget height can be set in pixels (px) and percentage (%). + * "number" The widget height can be set as a number + * "null" will stretch vertically to fit data. + */ + height?: string|number; + + /** + * If autoAdjustHeight is set to false, the [height](ui.iggrid#options:height) will be set only on the scrolling container, and all other UI elements such as paging footer / filter row / headers will add on top of that, so the total height of the grid will be more than this value - the height of the scroll container (content area) will not be dynamically calculated. Setting this option to false will usually result in a lot better initial rendering performance for large data sets ( > 1000 rows rendered at once, no [virtualization](ui.iggrid#options:virtualization) enabled), since no reflows will be made by browsers when accessing DOM properties such as offsetHeight. + * + */ + autoAdjustHeight?: boolean; + + /** + * 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. + * + * + * Valid values: + * "string" The avarage row height can be set in pixels ("25px"). + * "number" The avarage row height can be set in pixels as a number (25). + */ + avgRowHeight?: string|number; + + /** + * 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. + * + * + * Valid values: + * "string" The avarage column width can be set in pixels ("25px"). + * "number" The avarage column width can be set in pixels as a number (25). + */ + avgColumnWidth?: string|number; + + /** + * Default column width that will be set for all columns, that don't have [column width](ui.iggrid#options:columns.width) defined. + * + * + * Valid values: + * "string" The default column width can be set in pixels ("100px"). + * "number" The default column width can be set in pixels as a number (100). + */ + defaultColumnWidth?: string|number; + + /** + * If no [columns](ui.iggrid#options:columns) collection is defined, and autoGenerateColumns is set to true, [columns](ui.iggrid#options:columns) will be inferred from the data source before the [dataRendering](ui.iggrid#events:dataRendering) event is fired. The inferred [columns](ui.iggrid#options:columns) collection will be available to the developer for modification at [dataRendering](ui.iggrid#events:dataRendering). If autoGenerateColumns is not explicitly set and [columns](ui.iggrid#options:columns) has at least one column defined then autoGenerateColumns is automatically set to false. + * If autoGenerateColumns is true and there are columns defined auto-generated columns will render after the explicitly defined ones. + * Since auto-generated columns don't have width defined consider setting [defaultColumnWidth](ui.iggrid#options:defaultColumnWidth) as well. + * + */ + autoGenerateColumns?: boolean; + + /** + * Enables/disables column and row virtualization at the same time. Virtualization can greatly enhance rendering performance. If enabled, the number of actual rendered rows (DOM elements) will be constant and related to the visible viewport of the grid. As the end user scrolls, those DOM elements will be dynamically reused to render the new data. [Here you can find more info about the performance guidelines when using the igGrid](http://www.igniteui.com/help/iggrid-performance-guide) + * + */ + virtualization?: boolean; + + /** + * Determines row virtualization mode. + * + * + * Valid values: + * "fixed" Renders only the visible rows and/or columns in the grid. On scrolling the same rows and/or columns are updated with new data from the data source. Only fixed virtualization can work with column virtualization at the same time. Fixed virtualization is not supported by some grid features: Resizing, Group By, Responsive. + * "continuous" renders a pre-defined number of rows in the grid. On scrolling the continuous virtualization loads another portion of rows and disposes the current one. + */ + virtualizationMode?: string; + + /** + * Enables virtualization for rows only. [Here you can find more info about igGrid row virtualization](http://www.igniteui.com/help/iggrid-virtualization-overview) + * + */ + rowVirtualization?: boolean; + + /** + * Enables virtualization for columns only. Column virtualization can work only in combination with fixed row virtalization. Setting columnVirtualization to true will automatically set [virtualization](ui.iggrid#options:virtualization) to true and [virtualizationMode](ui.iggrid#options:virtualizationMode) to "fixed". + * + */ + columnVirtualization?: boolean; + + /** + * Number of pixels to scroll the grid by, when virtualization is enabled, and mouse wheel scrolling is performed over the virtual grid area. If "null" the step will be equal to the [avgRowHeight](ui.iggrid#options:avgRowHeight). + * + */ + virtualizationMouseWheelStep?: number; + + /** + * If this option is set to true, the height of the grid row will be calculated automatically based on the [avgRowHeight](ui.iggrid#options:avgRowHeight) and the visible virtual records. If no [avgRowHeight](ui.iggrid#options:avgRowHeight) is specified, it will be calculated automatically at runtime. + * + */ + adjustVirtualHeights?: boolean; + + /** + * 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. + * + * + * Valid values: + * "infragistics" The grid will use the Infragistics Templating engine to render its [column templates](ui.iggrid#options:columns.template) and specific parts of the UI. + * "jsRender" The grid will use jsRender to render its [column templates](ui.iggrid#options:columns.template) and specific parts of the UI. + */ + templatingEngine?: string; + + /** + * An array of column objects. Checkout the [Columns and Layout](http://www.igniteui.com/help/iggrid-columns-and-layout#defining-columns) topic for details on configuring the columns array. + * + */ + columns?: IgGridColumn[]; + + /** + * Can be any valid data source accepted by [$.ig.DataSource](ig.datasource), or an instance of an $.ig.DataSource itself + * + * + * Valid values: + * "array" dataSource as an array + * "object" ddataSource as an object + * "string" dataSource as a string + */ + dataSource?: Array|Object|string; + + /** + * Specifies a remote URL as a data source, from which data will be retrieved using the [$.ig.DataSource](ig.datasource). + * + */ + dataSourceUrl?: string; + + /** + * Explicitly set data source type (such as "json"). Please refer to the documentation of [$.ig.DataSource type](ig.datasource#options:settings.type). + * + */ + dataSourceType?: string; + + /** + * See [$.ig.DataSource responseDataKey](ig.datasource#options:settings.responseDataKey). This is the property in the responses where data records are held, if the response is wrapped. + * + */ + responseDataKey?: string; + + /** + * See [$.ig.DataSource responseTotalRecCountKey](ig.datasource#options:settings.responseTotalRecCountKey). Property in the response specifying the total number of records on the server. + * + */ + responseTotalRecCountKey?: string; + + /** + * Specifies the HTTP verb to be used to issue the requests to a remote data source. + * + */ + requestType?: string; + + /** + * Content type of the response. See http://api.jquery.com/jQuery.ajax/ => contentType + * + */ + responseContentType?: string; + + /** + * Controls the visibility of the grid header. + * + */ + showHeader?: boolean; + + /** + * Controls the visibility of the grid footer. + * + */ + showFooter?: boolean; + + /** + * Headers will be fixed if this option is set to true, and only the grid data will be scrollable. If [virtualization](ui.iggrid#options:virtualization) is enabled, fixedHeaders will always act as if it's true, no matter which value is set. + * + */ + fixedHeaders?: boolean; + + /** + * Footers will be fixed if this option is set to true, and only the grid data will be scrollable. If [virtualization](ui.iggrid#options:virtualization) is enabled, fixedFooters will always act as if it's true, no matter which value is set. + * + */ + fixedFooters?: boolean; + + /** + * Caption text that will be shown above the grid header. + * + */ + caption?: string; + + /** + * List of grid feature definitions: sorting, paging, etc. Each feature goes with its separate options that are documented for the feature accordingly. [Here you can find detailed documentation for all igGrid features](http://www.igniteui.com/help/iggrid-features-landing-page) + * + */ + features?: IgGridFeature[]; + + /** + * Initial tabIndex attribute that will be set on all focusable elements. + * + */ + tabIndex?: number; + + /** + * If this option is set to false, the data to which the grid is bound will be used "as is" with no additional transformations based on [columns](ui.iggrid#options:columns) defined. Otherwise only the subset of data properties used in the [columns](ui.iggrid#options:columns) defined will be extracted in a new object and used. + * + */ + localSchemaTransform?: boolean; + + /** + * Key of the column containing unique identifiers for the data records. + * + */ + primaryKey?: string; + + /** + * If true, the transaction log will always be sent in the request for remote data, by the data source. Also this means that if there are values in the log, a POST will be performed instead of GET. + * + */ + serializeTransactionLog?: boolean; + + /** + * Automatically commits the transactions as rows/cells are being edited to the client data source. A [saveChanges](ui.iggrid#methods:saveChanges) call still needs to be performed in order to commit the transactions to a server-side data source. + * + */ + autoCommit?: boolean; + + /** + * If set to true, the following behavior will take place: + * If a new row is added, and then deleted, there will be no transaction added to the log. + * If a new row is added, edited, then deleted, there will be no transaction added to the log. + * If several edits are made to a row or an individual cell, this should result in a single transaction. + * Note: This option takes effect only when [autoCommit](ui.iggrid#options:autoCommit) is set to false. + * + */ + aggregateTransactions?: boolean; + + /** + * 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) + * + * + * Valid values: + * "date" formats only Date columns + * "number" formats only number columns + * "dateandnumber" formats both Date and number columns + * "true" formats Date and number columns + * "false" auto formatting is disabled + */ + autoFormat?: string|boolean; + + /** + * Gets sets ability to render checkboxes and use checkbox editor when dataType of a column is "bool". Checkboxes are not rendered for boolean values in columns with a [column template](ui.iggrid#options:columns.template). + * + */ + renderCheckboxes?: boolean; + + /** + * URL to which updating requests will be made. + * + */ + 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). + * + */ + alternateRowStyles?: boolean; + + /** + * If set to true and all columns' widths are specified and their combined width is less than the grid width then the last column width will be automatically adjusted to fill the remaining empty space of the grid. + * + */ + autofitLastColumn?: boolean; + + /** + * Enables/disables rendering of hover styles when the mouse is over a record. This can be useful in templating scenarios, for example, where we don't want to apply hover styling to templated content. + * + */ + enableHoverStyles?: boolean; + + /** + * Enables/Disables serializing client date as UTC ISO 8061 string instead of using the local time and zone values. + * + */ + enableUTCDates?: boolean; + + /** + * Merge unbound columns values inside data source when data source is remote. If true then the unbound columns are merged to the data source at runtime on the server. Note that data source is expanded with the new data and this could cause performance issues when the data is huge. If mergeUnboundColumns is false then the unbound data is sent and merged on the client. This option is used by the [igGrid MVC Helper](http://www.igniteui.com/help/iggrid-developing-asp-net-mvc-applications-with-iggrid). + * Checkout [Populating Unbound Columns Remotely (igGrid)](http://www.igniteui.com/help/iggrid-unboundcolumns-populating-with-data-remotely) topic for more information. + * + */ + mergeUnboundColumns?: boolean; + + /** + * When dataSource is a remote URL, defines whether to set the type of the remote data source to JSONP. + * + */ + jsonpRequest?: boolean; + + /** + * Enables/disables grid adjusting its dimensions when its [width](ui.iggrid#options:width) and/or [height](ui.iggrid#options:height) is set in percent (%) and grid parent DOM container is resized. + * + */ + enableResizeContainerCheck?: boolean; + + /** + * Configures how the feature chooser icon should display on header cells - e.g. to display as gear icon or not. + * + * + * Valid values: + * "none" Always hide the feature chooser icon; The feature chooser is shown on tapping/clicking the column header. + * "desktopOnly" Always show the icon on desktop but hide when touch device detected. + * "always" Always show it in any environment. Chooser is shown when tapping the gear icon or column header. + */ + featureChooserIconDisplay?: string; + + /** + * Settings related to content scrolling. + * + */ + scrollSettings?: IgGridScrollSettings; + /** * Fired when a row is about to be expanded. - * use args.owner to access the instance of the igTreeGrid - * use args.row to access the row element (as a wrapped jQuery object) that is about to be expanded - * use args.fixedRow to access the row element (as a jQuery wrapped object) in a fixed column that is about to expanded. If there are no fixed columns then this property returns undefined. - * use args.dataLevel to access the level in the hierarchy associated with the row */ rowExpanding?: RowExpandingEvent; /** * Fired when a row is expanded. - * use args.owner to access the instance of the igTreeGrid - * use args.row to access the row element (as a wrapped jQuery object) that is about to be expanded - * use args.fixedRow to access the row element (as a jQuery wrapped object) in a fixed column that is about to expanded. If there are no fixed columns then this property returns undefined. - * use args.dataLevel to access the level in the hierarchy associated with the row - * use args.dataRecord to access the source data record */ rowExpanded?: RowExpandedEvent; /** * Fired when a row is about to be collapsed. - * use args.owner to access the instance of the igTreeGrid - * use args.row to access the row element (as a wrapped jQuery object) that is about to be expanded - * use args.fixedRow to access the row element (as a jQuery wrapped object) in a fixed column that is about to expanded. If there are no fixed columns then this property returns undefined. - * use args.dataLevel to access the level in the hierarchy associated with the row */ rowCollapsing?: RowCollapsingEvent; /** * Fired after a row is collapsed - * use args.owner to access the instance of the igTreeGrid - * use args.row to access the row element (as a wrapped jQuery object) that is about to be expanded - * use args.fixedRow to access the row element (as a jQuery wrapped object) in a fixed column that is about to expanded. If there are no fixed columns then this property returns undefined. - * use args.dataLevel to access the level in the hierarchy associated with the row - * use args.dataRecord to access the source data record */ rowCollapsed?: RowCollapsedEvent; + /** + * Event fired when a cell is clicked. + */ + cellClick?: CellClickEvent; + + /** + * Event fired when a cell is right clicked. + */ + cellRightClick?: CellRightClickEvent; + + /** + * Event fired before data binding takes place. + * + * Return false in order to cancel data binding. + */ + dataBinding?: DataBindingEvent; + + /** + * Event fired after data binding is complete. + */ + dataBound?: DataBoundEvent; + + /** + * Event fired before the grid starts rendering (all contents). + * This event is fired only when the grid is being initialized. + * It will not be fired if the grid is rebound to its data + * (for example, when calling the dataBind() API method + * or when changing the page size (when paging is enabled)). + * Return false in order to cancel grid rendering. + */ + rendering?: RenderingEvent; + + /** + * Event fired after the whole grid widget has been rendered (including headers, footers, etc.). + * This event is fired only when the grid is being initialized. + * It will not be fired if the grid is rebound to its data + * (for example, when calling the dataBind() API method + * or when changing the page size (when paging is enabled)). + */ + rendered?: RenderedEvent; + + /** + * Event fired before the TBODY holding the data records starts its rendering. + * Return false in order to cancel data records rendering. + */ + dataRendering?: DataRenderingEvent; + + /** + * Event fired after all of the data records in the grid table body have been rendered. + */ + dataRendered?: DataRenderedEvent; + + /** + * Event fired before the header starts its rendering. + * Return false in order to cancel header rendering. + */ + headerRendering?: HeaderRenderingEvent; + + /** + * Event fired after the header has been rendered. + */ + headerRendered?: HeaderRenderedEvent; + + /** + * Event fired before the caption starts its rendering. + * Return false in order to cancel caption rendering. + */ + captionRendering?: CaptionRenderingEvent; + + /** + * Event fired after the caption has been rendered. + */ + captionRendered?: CaptionRenderedEvent; + + /** + * Event fired before the footer starts its rendering. + * + * Return false in order to cancel footer rendering. + */ + footerRendering?: FooterRenderingEvent; + + /** + * Event fired after the footer has been rendered. + */ + footerRendered?: FooterRenderedEvent; + + /** + * Event fired after every TH in the grid header has been rendered. + */ + headerCellRendered?: HeaderCellRenderedEvent; + + /** + * Event fired before actual data rows (TRs) are rendered. + * Return false in order to cancel rows rendering. + */ + rowsRendering?: RowsRenderingEvent; + + /** + * Event fired after data rows are rendered. + */ + rowsRendered?: RowsRenderedEvent; + + /** + * Event fired after $.ig.DataSource schema has been generated, in case it needs to be modified. + */ + schemaGenerated?: SchemaGeneratedEvent; + + /** + * Event fired after the columns colection has been modified(e.g. a column is hidden) + */ + columnsCollectionModified?: ColumnsCollectionModifiedEvent; + + /** + * Event fired if there is an error in the request, when the grid is doing a remote operation, + * such as data binding, paging, sorting, etc. + */ + requestError?: RequestErrorEvent; + + /** + * Fired when the grid is created and the initial structure is rendered (this doesn't necessarily imply the data will be there if the data source is remote) + */ + created?: CreatedEvent; + + /** + * Fired when the grid is destroyed + */ + destroyed?: DestroyedEvent; + /** * Option for igTreeGrid */ @@ -73067,6 +83507,452 @@ interface IgTreeGridMethods { * Destroys igTreeGrid */ destroy(): Object; + + /** + * Returns the element holding the data records + */ + widget(): void; + + /** + * Returns whether grid has non-data fixed columns(e.g. row selectors column) + */ + hasFixedDataSkippedColumns(): boolean; + + /** + * Returns true if grid has at least one fixed columns(even if a non-data column - like row-selectors column) + */ + hasFixedColumns(): boolean; + + /** + * Returns the current fixing direction. NOTE - use only if ColumnFixing feature is enabled + * @return left|right + */ + fixingDirection(): string; + + /** + * 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. + */ + isFixedColumn(colKey: Object): boolean; + + /** + * Called to detect whether grid container is resized. When autoAdjustHeight is true and height of the grid is changed then the height of grid is re-set. + */ + resizeContainer(): void; + + /** + * Returns whether the header identified by colKey is multicolumn header(has children) + * + * @param colKey value of the column key + */ + isGroupHeader(colKey: string): Object; + + /** + * Returns an object that contains information on the passed Dom element + * + * rowId - the id of the record associated with the element - if primaryKey is not set this will be null. + * rowIndex - the index (in the DOM) of the row associated with the element. + * 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. + */ + getElementInfo(elem: Element): Object; + + /** + * Returns the ID of the TABLE element where data records are rendered + */ + id(): string; + + /** + * Returns the DIV that is the topmost container of the grid widget + */ + container(): Element; + + /** + * Returns the table that contains the header cells + */ + headersTable(): Element; + + /** + * Returns the table that contains the footer cells + */ + footersTable(): Element; + + /** + * Returns the DIV that is used as a scroll container for the grid contents + */ + scrollContainer(): Element; + + /** + * Returns the DIV that is the topmost container of the fixed grid - contains fixed columns(in ColumnFixing scenario) + */ + fixedContainer(): Element; + + /** + * Returns the DIV that is the topmost container of the fixed body grid - contains fixed columns(in ColumnFixing scenario) + */ + fixedBodyContainer(): Element; + + /** + * Returns container(jQuery representation) containing fixed footer - contains fixed columns(in ColumnFixing scenario) + */ + fixedFooterContainer(): Object; + + /** + * Returns container(jQuery representation) containing fixed header - contains fixed columns(in ColumnFixing scenario) + */ + fixedHeaderContainer(): Object; + + /** + * Returns the table that contains the FIXED header cells - contains fixed columns(in ColumnFixing scenario) + */ + fixedHeadersTable(): Element; + + /** + * Returns the table that contains the footer cells - contains fixed columns(in ColumnFixing scenario) + */ + fixedFootersTable(): Element; + + /** + * 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 + */ + 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. + */ + cellById(rowId: Object, columnKey: string): Element; + + /** + * Returns the fixed table - contains fixed columns(in ColumnFixing scenario). If there aren't fixed columns returns the grid table + */ + fixedTable(): Object; + + /** + * Gets all immediate children of the current grid + */ + immediateChildrenWidgets(): any[]; + + /** + * Gets all children of the current grid, recursively + */ + childrenWidgets(): any[]; + + /** + * Gets all children's elements of the current grid, recursively + */ + children(): any[]; + + /** + * Gets all immediate children's elements of the current grid + */ + immediateChildren(): any[]; + + /** + * Returns the row (TR element) at the specified index. jQuery selectors aren't used for performance reasons + * + * @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. + */ + 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. + */ + fixedRowAt(i: number): Element; + + /** + * Returns a list of all fixed TR elements holding data in the grid(in ColumnFixing scenario - only when there is at least one fixed column) + */ + fixedRows(): any[]; + + /** + * Returns a list of all TR elements holding data in the grid(when there is at least one fixed column returns rows only in the UNFIXED table) + */ + rows(): any[]; + + /** + * Returns all data fixed rows recursively, not only the immediate ones(in ColumnFixing scenario - only when there is at least one fixed column) + */ + allFixedRows(): any[]; + + /** + * Returns all data rows recursively, not only the immediate ones(when there is at least one fixed column returns rows only in the UNFIXED table) + */ + allRows(): any[]; + + /** + * Returns a column object by the specified 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. + */ + columnByText(text: string): Object; + + /** + * Returns an array of selected cells in arbitrary order where every objects has the format { element: , row: , index: , rowIndex: , columnKey: } . + * If multiple selection is disabled the function will return null. + */ + selectedCells(): any[]; + + /** + * Returns an array of selected rows in arbitrary order where every object has the format { element: , index: } . + * If multiple selection is disabled the function will return null. + */ + selectedRows(): any[]; + + /** + * Returns the currently selected cell that has the format { element: , row: , index: , rowIndex: , columnKey: }, if any. + * If multiple selection is enabled the function will return null. + */ + selectedCell(): Object; + + /** + * Returns the currently selected row that has the format { element: , index: }, if any. + * If multiple selection is enabled the function will return null. + */ + selectedRow(): Object; + + /** + * Returns the currently active (focused) cell that has the format { element: , row: , index: , rowIndex: , columnKey: }, if any. + */ + activeCell(): Object; + + /** + * Returns the currently active (focused) row that has the format { element: , index: }, if any. + */ + activeRow(): Object; + + /** + * 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. + */ + getCellValue(rowId: Object, colKey: string): Object; + + /** + * 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. + */ + 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 + */ + 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. + */ + commit(rowId?: Object): void; + + /** + * 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 + */ + findRecordByKey(key: Object): Object; + + /** + * 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. + */ + getDetachedRecord(t: Object): Object; + + /** + * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source. + * That is a wrapper for this.dataSource.pendingTransactions(). + */ + pendingTransactions(): any[]; + + /** + * Returns a list of all transaction objects that are either pending, or have been committed in the data source. + * That is a wrapper for this.dataSource.allTransactions(). + */ + allTransactions(): any[]; + + /** + * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently. + * That is a wrapper for this.dataSource.transactionsAsString(). + */ + transactionsAsString(): string; + + /** + * 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) + */ + 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. + */ + 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. + */ + dataSourceObject(dataSource: Object): void; + + /** + * Returns the total number of records in the underlying backend. If paging or filtering is enabled, this may differ from the number of records in the client-side data source. + * In order for this to work, the response JSON/XML must include a property that specifies the total number of records, which name is specified by options.responseTotalRecCountKey. + * This functionality is completely delegated to the data source control. + */ + totalRecordsCount(): number; + + /** + * 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. + */ + moveColumn(column: Object, target: Object, after?: boolean, inDom?: boolean, callback?: Function): void; + + /** + * 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) + */ + showColumn(column: Object, callback: Function): void; + + /** + * 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) + */ + 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 + */ + 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 + */ + 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 + */ + 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 + */ + getUnboundColumnByKey(key: string): Object; + + /** + * Returns whether there is vertical scrollbar. Because of perfrormance issues in older Internet Explorer especially 8,9 - there is no need to check if height is not set - there is no scrollbar OR if row virtualization is enabled - it is supposed there is vertical scrollbar + */ + hasVerticalScrollbar(): Object; + + /** + * Auto resize columns that have property width set to "*" so content to be auto-fitted(not shrinked/cutted). Auto-resizing is applied ONLY for visible columns + */ + autoSizeColumns(): void; + + /** + * 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 + */ + calculateAutoFitColumnWidth(columnIndex: number): number; + + /** + * 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 + */ + getVisibleIndexByKey(columnKey: string, includeDataSkip: boolean): number; + + /** + * When called the method re-renders the whole grid(also rebinds to the data source) and renders the cols object + * + * @param cols an array of column objects + */ + renderMultiColumnHeader(cols: any[]): void; + + /** + * 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 + */ + 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 + */ + getColumnByTD($td: Object): Object; } interface JQuery { data(propertyName: "igTreeGrid"): IgTreeGridMethods; @@ -73080,6 +83966,74 @@ interface JQuery { igTreeGrid(methodName: "collapseRow", row: Object, callback?: Function): void; igTreeGrid(methodName: "renderNewChild", rec: Object, parentId?: string): void; igTreeGrid(methodName: "destroy"): Object; + igTreeGrid(methodName: "widget"): void; + igTreeGrid(methodName: "hasFixedDataSkippedColumns"): boolean; + igTreeGrid(methodName: "hasFixedColumns"): boolean; + igTreeGrid(methodName: "fixingDirection"): string; + igTreeGrid(methodName: "isFixedColumn", colKey: Object): boolean; + igTreeGrid(methodName: "resizeContainer"): void; + igTreeGrid(methodName: "isGroupHeader", colKey: string): Object; + igTreeGrid(methodName: "getElementInfo", elem: Element): Object; + igTreeGrid(methodName: "id"): string; + igTreeGrid(methodName: "container"): Element; + igTreeGrid(methodName: "headersTable"): Element; + igTreeGrid(methodName: "footersTable"): Element; + igTreeGrid(methodName: "scrollContainer"): Element; + igTreeGrid(methodName: "fixedContainer"): Element; + igTreeGrid(methodName: "fixedBodyContainer"): Element; + igTreeGrid(methodName: "fixedFooterContainer"): Object; + igTreeGrid(methodName: "fixedHeaderContainer"): Object; + igTreeGrid(methodName: "fixedHeadersTable"): Element; + igTreeGrid(methodName: "fixedFootersTable"): Element; + igTreeGrid(methodName: "cellAt", x: number, y: number, isFixed: boolean): Element; + igTreeGrid(methodName: "cellById", rowId: Object, columnKey: string): Element; + igTreeGrid(methodName: "fixedTable"): Object; + igTreeGrid(methodName: "immediateChildrenWidgets"): any[]; + igTreeGrid(methodName: "childrenWidgets"): any[]; + igTreeGrid(methodName: "children"): any[]; + igTreeGrid(methodName: "immediateChildren"): any[]; + igTreeGrid(methodName: "rowAt", i: number): Element; + igTreeGrid(methodName: "rowById", rowId: Object, isFixed?: boolean): Element; + igTreeGrid(methodName: "fixedRowAt", i: number): Element; + igTreeGrid(methodName: "fixedRows"): any[]; + igTreeGrid(methodName: "rows"): any[]; + igTreeGrid(methodName: "allFixedRows"): any[]; + igTreeGrid(methodName: "allRows"): any[]; + igTreeGrid(methodName: "columnByKey", key: string): Object; + igTreeGrid(methodName: "columnByText", text: string): Object; + igTreeGrid(methodName: "selectedCells"): any[]; + igTreeGrid(methodName: "selectedRows"): any[]; + igTreeGrid(methodName: "selectedCell"): Object; + igTreeGrid(methodName: "selectedRow"): Object; + igTreeGrid(methodName: "activeCell"): Object; + igTreeGrid(methodName: "activeRow"): Object; + igTreeGrid(methodName: "getCellValue", rowId: Object, colKey: string): Object; + igTreeGrid(methodName: "getCellText", rowId: Object, colKey: string): string; + igTreeGrid(methodName: "setColumnTemplate", col: Object, tmpl: string, render?: boolean): void; + igTreeGrid(methodName: "commit", rowId?: Object): void; + igTreeGrid(methodName: "findRecordByKey", key: Object): Object; + igTreeGrid(methodName: "getDetachedRecord", t: Object): Object; + igTreeGrid(methodName: "pendingTransactions"): any[]; + igTreeGrid(methodName: "allTransactions"): any[]; + igTreeGrid(methodName: "transactionsAsString"): string; + igTreeGrid(methodName: "saveChanges", success: Function, error: Function): void; + igTreeGrid(methodName: "renderNewRow", rec?: string): void; + igTreeGrid(methodName: "dataSourceObject", dataSource: Object): void; + igTreeGrid(methodName: "totalRecordsCount"): number; + igTreeGrid(methodName: "moveColumn", column: Object, target: Object, after?: boolean, inDom?: boolean, callback?: Function): void; + igTreeGrid(methodName: "showColumn", column: Object, callback: Function): void; + igTreeGrid(methodName: "hideColumn", column: Object, callback: Function): void; + igTreeGrid(methodName: "getUnboundValues", key: string): Object; + igTreeGrid(methodName: "setUnboundValues", key: string, values: any[], removeOldValues: Object): void; + igTreeGrid(methodName: "setUnboundValueByPK", col: string, rowId: string, val: Object, notToRender: Object): void; + igTreeGrid(methodName: "getUnboundColumnByKey", key: string): Object; + igTreeGrid(methodName: "hasVerticalScrollbar"): Object; + igTreeGrid(methodName: "autoSizeColumns"): void; + igTreeGrid(methodName: "calculateAutoFitColumnWidth", columnIndex: number): number; + igTreeGrid(methodName: "getVisibleIndexByKey", columnKey: string, includeDataSkip: boolean): number; + igTreeGrid(methodName: "renderMultiColumnHeader", cols: any[]): void; + igTreeGrid(methodName: "virtualScrollTo", scrollerPosition: Object): void; + igTreeGrid(methodName: "getColumnByTD", $td: Object): Object; /** * Gets the indentation (in pixels or percent) for a tree grid row. Nested indentation is achieved by calculating the level times the indentation value. Ex: '10px' or '5%'. Default is 30. @@ -73277,21 +84231,685 @@ interface JQuery { */ igTreeGrid(optionLiteral: 'option', optionName: "dataSourceSettings", optionValue: IgTreeGridDataSourceSettings): 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; + + /** + * 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). + * + * + * @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; + + /** + * 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). + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "height", optionValue: string|number): void; + + /** + * If autoAdjustHeight is set to false, the [height](ui.iggrid#options:height) will be set only on the scrolling container, and all other UI elements such as paging footer / filter row / headers will add on top of that, so the total height of the grid will be more than this value - the height of the scroll container (content area) will not be dynamically calculated. Setting this option to false will usually result in a lot better initial rendering performance for large data ( > 1000 rows rendered at once, no [virtualization](ui.iggrid#options:virtualization) enabled), since no reflows will be made by browsers when accessing DOM properties such as offsetHeight. + * + */ + igTreeGrid(optionLiteral: 'option', optionName: "autoAdjustHeight"): boolean; + + /** + * If autoAdjustHeight is set to false, the [height](ui.iggrid#options:height) will be set only on the scrolling container, and all other UI elements such as paging footer / filter row / headers will add on top of that, so the total height of the grid will be more than this value - the height of the scroll container (content area) will not be dynamically calculated. Setting this option to false will usually result in a lot better initial rendering performance for large data sets ( > 1000 rows rendered at once, no [virtualization](ui.iggrid#options:virtualization) enabled), since no reflows will be made by browsers when accessing DOM properties such as offsetHeight. + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "autoAdjustHeight", optionValue: boolean): void; + + /** + * 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; + + /** + * 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. + * + * + * @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; + + /** + * 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. + * + * + * @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; + + /** + * Default column width that will be set for all columns, that don't have [column width](ui.iggrid#options:columns.width) defined. + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "defaultColumnWidth", optionValue: string|number): void; + + /** + * If no [columns](ui.iggrid#options:columns) collection is defined, and autoGenerateColumns is set to true, [columns](ui.iggrid#options:columns) will be inferred from the data source before the [dataRendering](ui.iggrid#events:dataRendering) event is fired. The inferred [columns](ui.iggrid#options:columns) collection will be available to the developer for modification at [dataRendering](ui.iggrid#events:dataRendering). If autoGenerateColumns is not explicitly set and [columns](ui.iggrid#options:columns) has at least one column defined then autoGenerateColumns is automatically set to false. + * If autoGenerateColumns is true and there are columns defined auto-generated columns will render after the explicitly defined ones. + * Since auto-generated columns don't have width defined consider setting [defaultColumnWidth](ui.iggrid#options:defaultColumnWidth) as well. + * + */ + igTreeGrid(optionLiteral: 'option', optionName: "autoGenerateColumns"): boolean; + + /** + * If no [columns](ui.iggrid#options:columns) collection is defined, and autoGenerateColumns is set to true, [columns](ui.iggrid#options:columns) will be inferred from the data source before the [dataRendering](ui.iggrid#events:dataRendering) event is fired. The inferred [columns](ui.iggrid#options:columns) collection will be available to the developer for modification at [dataRendering](ui.iggrid#events:dataRendering). If autoGenerateColumns is not explicitly set and [columns](ui.iggrid#options:columns) has at least one column defined then autoGenerateColumns is automatically set to false. + * If autoGenerateColumns is true and there are columns defined auto-generated columns will render after the explicitly defined ones. + * Since auto-generated columns don't have width defined consider setting [defaultColumnWidth](ui.iggrid#options:defaultColumnWidth) as well. + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "autoGenerateColumns", optionValue: boolean): void; + + /** + * Enables/disables column and row virtualization at the same time. Virtualization can greatly enhance rendering performance. If enabled, the number of actual rendered rows (DOM elements) will be constant and related to the visible viewport of the grid. As the end user scrolls, those DOM elements will be dynamically reused to render the new data. [Here you can find more info about the performance guidelines when using the igGrid](http://www.igniteui.com/help/iggrid-performance-guide) + * + */ + igTreeGrid(optionLiteral: 'option', optionName: "virtualization"): boolean; + + /** + * Enables/disables column and row virtualization at the same time. Virtualization can greatly enhance rendering performance. If enabled, the number of actual rendered rows (DOM elements) will be constant and related to the visible viewport of the grid. As the end user scrolls, those DOM elements will be dynamically reused to render the new data. [Here you can find more info about the performance guidelines when using the igGrid](http://www.igniteui.com/help/iggrid-performance-guide) + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "virtualization", optionValue: boolean): void; + + /** + * Determines row virtualization mode. + * + */ + igTreeGrid(optionLiteral: 'option', optionName: "virtualizationMode"): string; + + /** + * Determines row virtualization mode. + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "virtualizationMode", optionValue: string): void; + + /** + * Enables virtualization for rows only. [Here you can find more info about igGrid row virtualization](http://www.igniteui.com/help/iggrid-virtualization-overview) + * + */ + igTreeGrid(optionLiteral: 'option', optionName: "rowVirtualization"): boolean; + + /** + * Enables virtualization for rows only. [Here you can find more info about igGrid row virtualization](http://www.igniteui.com/help/iggrid-virtualization-overview) + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "rowVirtualization", optionValue: boolean): void; + + /** + * Enables virtualization for columns only. Column virtualization can work only in combination with fixed row virtalization. Setting columnVirtualization to true will automatically set [virtualization](ui.iggrid#options:virtualization) to true and [virtualizationMode](ui.iggrid#options:virtualizationMode) to "fixed". + * + */ + igTreeGrid(optionLiteral: 'option', optionName: "columnVirtualization"): boolean; + + /** + * Enables virtualization for columns only. Column virtualization can work only in combination with fixed row virtalization. Setting columnVirtualization to true will automatically set [virtualization](ui.iggrid#options:virtualization) to true and [virtualizationMode](ui.iggrid#options:virtualizationMode) to "fixed". + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "columnVirtualization", optionValue: boolean): void; + + /** + * Number of pixels to scroll the grid by, when virtualization is enabled, and mouse wheel scrolling is performed over the virtual grid area. If "null" the step will be equal to the [avgRowHeight](ui.iggrid#options:avgRowHeight). + * + */ + igTreeGrid(optionLiteral: 'option', optionName: "virtualizationMouseWheelStep"): number; + + /** + * Number of pixels to scroll the grid by, when virtualization is enabled, and mouse wheel scrolling is performed over the virtual grid area. If "null" the step will be equal to the [avgRowHeight](ui.iggrid#options:avgRowHeight). + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "virtualizationMouseWheelStep", optionValue: number): void; + + /** + * If this option is set to true, the height of the grid row will be calculated automatically based on the [avgRowHeight](ui.iggrid#options:avgRowHeight) and the visible virtual records. If no [avgRowHeight](ui.iggrid#options:avgRowHeight) is specified, it will be calculated automatically at runtime. + * + */ + igTreeGrid(optionLiteral: 'option', optionName: "adjustVirtualHeights"): boolean; + + /** + * If this option is set to true, the height of the grid row will be calculated automatically based on the [avgRowHeight](ui.iggrid#options:avgRowHeight) and the visible virtual records. If no [avgRowHeight](ui.iggrid#options:avgRowHeight) is specified, it will be calculated automatically at runtime. + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "adjustVirtualHeights", optionValue: boolean): void; + + /** + * 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; + + /** + * 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. + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "templatingEngine", optionValue: string): void; + + /** + * An array of column objects. Checkout the [Columns and Layout](http://www.igniteui.com/help/iggrid-columns-and-layout#defining-columns) topic for details on configuring the columns array. + * + */ + igTreeGrid(optionLiteral: 'option', optionName: "columns"): IgGridColumn[]; + + /** + * An array of column objects. Checkout the [Columns and Layout](http://www.igniteui.com/help/iggrid-columns-and-layout#defining-columns) topic for details on configuring the columns array. + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "columns", optionValue: IgGridColumn[]): void; + + /** + * 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; + + /** + * Can be any valid data source accepted by [$.ig.DataSource](ig.datasource), or an instance of an $.ig.DataSource itself + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "dataSource", optionValue: Array|Object|string): void; + + /** + * Gets a remote URL as a data source, from which data will be retrieved using the [$.ig.DataSource](ig.datasource). + * + */ + igTreeGrid(optionLiteral: 'option', optionName: "dataSourceUrl"): string; + + /** + * Sets a remote URL as a data source, from which data will be retrieved using the [$.ig.DataSource](ig.datasource). + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "dataSourceUrl", 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). + * + */ + igTreeGrid(optionLiteral: 'option', optionName: "dataSourceType"): string; + + /** + * Explicitly set data source type (such as "json"). Please refer to the documentation of [$.ig.DataSource type](ig.datasource#options:settings.type). + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "dataSourceType", optionValue: string): void; + + /** + * See [$.ig.DataSource responseDataKey](ig.datasource#options:settings.responseDataKey). This is the property in the responses where data records are held, if the response is wrapped. + * + */ + igTreeGrid(optionLiteral: 'option', optionName: "responseDataKey"): string; + + /** + * See [$.ig.DataSource responseDataKey](ig.datasource#options:settings.responseDataKey). This is the property in the responses where data records are held, if the response is wrapped. + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "responseDataKey", optionValue: string): void; + + /** + * See [$.ig.DataSource responseTotalRecCountKey](ig.datasource#options:settings.responseTotalRecCountKey). Property in the response specifying the total number of records on the server. + * + */ + igTreeGrid(optionLiteral: 'option', optionName: "responseTotalRecCountKey"): string; + + /** + * See [$.ig.DataSource responseTotalRecCountKey](ig.datasource#options:settings.responseTotalRecCountKey). Property in the response specifying the total number of records on the server. + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "responseTotalRecCountKey", optionValue: string): void; + + /** + * Gets the HTTP verb to be used to issue the requests to a remote data source. + * + */ + igTreeGrid(optionLiteral: 'option', optionName: "requestType"): string; + + /** + * Sets the HTTP verb to be used to issue the requests to a remote data source. + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "requestType", optionValue: string): void; + + /** + * Content type of the response. See http://api.jquery.com/jQuery.ajax/ => contentType + * + */ + igTreeGrid(optionLiteral: 'option', optionName: "responseContentType"): string; + + /** + * Content type of the response. See http://api.jquery.com/jQuery.ajax/ => contentType + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "responseContentType", optionValue: string): void; + + /** + * Controls the visibility of the grid header. + * + */ + igTreeGrid(optionLiteral: 'option', optionName: "showHeader"): boolean; + + /** + * Controls the visibility of the grid header. + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "showHeader", optionValue: boolean): void; + + /** + * Controls the visibility of the grid footer. + * + */ + igTreeGrid(optionLiteral: 'option', optionName: "showFooter"): boolean; + + /** + * Controls the visibility of the grid footer. + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "showFooter", optionValue: boolean): void; + + /** + * Headers will be fixed if this option is set to true, and only the grid data will be scrollable. If [virtualization](ui.iggrid#options:virtualization) is enabled, fixedHeaders will always act as if it's true, no matter which value is set. + * + */ + igTreeGrid(optionLiteral: 'option', optionName: "fixedHeaders"): boolean; + + /** + * Headers will be fixed if this option is set to true, and only the grid data will be scrollable. If [virtualization](ui.iggrid#options:virtualization) is enabled, fixedHeaders will always act as if it's true, no matter which value is set. + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "fixedHeaders", optionValue: boolean): void; + + /** + * Footers will be fixed if this option is set to true, and only the grid data will be scrollable. If [virtualization](ui.iggrid#options:virtualization) is enabled, fixedFooters will always act as if it's true, no matter which value is set. + * + */ + igTreeGrid(optionLiteral: 'option', optionName: "fixedFooters"): boolean; + + /** + * Footers will be fixed if this option is set to true, and only the grid data will be scrollable. If [virtualization](ui.iggrid#options:virtualization) is enabled, fixedFooters will always act as if it's true, no matter which value is set. + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "fixedFooters", optionValue: boolean): void; + + /** + * Caption text that will be shown above the grid header. + * + */ + igTreeGrid(optionLiteral: 'option', optionName: "caption"): string; + + /** + * Caption text that will be shown above the grid header. + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "caption", optionValue: string): void; + + /** + * List of grid feature definitions: sorting, paging, etc. Each feature goes with its separate options that are documented for the feature accordingly. [Here you can find detailed documentation for all igGrid features](http://www.igniteui.com/help/iggrid-features-landing-page) + * + */ + igTreeGrid(optionLiteral: 'option', optionName: "features"): IgGridFeature[]; + + /** + * List of grid feature definitions: sorting, paging, etc. Each feature goes with its separate options that are documented for the feature accordingly. [Here you can find detailed documentation for all igGrid features](http://www.igniteui.com/help/iggrid-features-landing-page) + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "features", optionValue: IgGridFeature[]): void; + + /** + * Initial tabIndex attribute that will be set on all focusable elements. + * + */ + igTreeGrid(optionLiteral: 'option', optionName: "tabIndex"): number; + + /** + * Initial tabIndex attribute that will be set on all focusable elements. + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "tabIndex", optionValue: number): void; + + /** + * If this option is set to false, the data to which the grid is bound will be used "as is" with no additional transformations based on [columns](ui.iggrid#options:columns) defined. Otherwise only the subset of data properties used in the [columns](ui.iggrid#options:columns) defined will be extracted in a new object and used. + * + */ + igTreeGrid(optionLiteral: 'option', optionName: "localSchemaTransform"): boolean; + + /** + * If this option is set to false, the data to which the grid is bound will be used "as is" with no additional transformations based on [columns](ui.iggrid#options:columns) defined. Otherwise only the subset of data properties used in the [columns](ui.iggrid#options:columns) defined will be extracted in a new object and used. + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "localSchemaTransform", optionValue: boolean): void; + + /** + * Key of the column containing unique identifiers for the data records. + * + */ + igTreeGrid(optionLiteral: 'option', optionName: "primaryKey"): string; + + /** + * Key of the column containing unique identifiers for the data records. + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "primaryKey", optionValue: string): void; + + /** + * If true, the transaction log will always be sent in the request for remote data, by the data source. Also this means that if there are values in the log, a POST will be performed instead of GET. + * + */ + igTreeGrid(optionLiteral: 'option', optionName: "serializeTransactionLog"): boolean; + + /** + * If true, the transaction log will always be sent in the request for remote data, by the data source. Also this means that if there are values in the log, a POST will be performed instead of GET. + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "serializeTransactionLog", optionValue: boolean): void; + + /** + * Automatically commits the transactions as rows/cells are being edited to the client data source. A [saveChanges](ui.iggrid#methods:saveChanges) call still needs to be performed in order to commit the transactions to a server-side data source. + * + */ + igTreeGrid(optionLiteral: 'option', optionName: "autoCommit"): boolean; + + /** + * Automatically commits the transactions as rows/cells are being edited to the client data source. A [saveChanges](ui.iggrid#methods:saveChanges) call still needs to be performed in order to commit the transactions to a server-side data source. + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "autoCommit", optionValue: boolean): void; + + /** + * If set to true, the following behavior will take place: + * If a new row is added, and then deleted, there will be no transaction added to the log. + * If a new row is added, edited, then deleted, there will be no transaction added to the log. + * If several edits are made to a row or an individual cell, this should result in a single transaction. + * Note: This option takes effect only when [autoCommit](ui.iggrid#options:autoCommit) is set to false. + * + */ + igTreeGrid(optionLiteral: 'option', optionName: "aggregateTransactions"): boolean; + + /** + * If set to true, the following behavior will take place: + * If a new row is added, and then deleted, there will be no transaction added to the log. + * If a new row is added, edited, then deleted, there will be no transaction added to the log. + * If several edits are made to a row or an individual cell, this should result in a single transaction. + * Note: This option takes effect only when [autoCommit](ui.iggrid#options:autoCommit) is set to false. + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "aggregateTransactions", optionValue: boolean): void; + + /** + * 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; + + /** + * 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) + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "autoFormat", optionValue: string|boolean): void; + + /** + * Gets ability to render checkboxes and use checkbox editor when dataType of a column is "bool". Checkboxes are not rendered for boolean values in columns with a [column template](ui.iggrid#options:columns.template). + * + */ + igTreeGrid(optionLiteral: 'option', optionName: "renderCheckboxes"): boolean; + + /** + * Sets ability to render checkboxes and use checkbox editor when dataType of a column is "bool". Checkboxes are not rendered for boolean values in columns with a [column template](ui.iggrid#options:columns.template). + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "renderCheckboxes", optionValue: boolean): void; + + /** + * URL to which updating requests will be made. + * + */ + igTreeGrid(optionLiteral: 'option', optionName: "updateUrl"): string; + + /** + * URL to which updating requests will be made. + * + * + * @optionValue New value to be set. + */ + 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). + * + */ + igTreeGrid(optionLiteral: 'option', optionName: "alternateRowStyles"): boolean; + + /** + * Enables/disables rendering of alternating row styles (odd and even rows receive different styling). + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "alternateRowStyles", optionValue: boolean): void; + + /** + * If set to true and all columns' widths are specified and their combined width is less than the grid width then the last column width will be automatically adjusted to fill the remaining empty space of the grid. + * + */ + igTreeGrid(optionLiteral: 'option', optionName: "autofitLastColumn"): boolean; + + /** + * If set to true and all columns' widths are specified and their combined width is less than the grid width then the last column width will be automatically adjusted to fill the remaining empty space of the grid. + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "autofitLastColumn", optionValue: boolean): void; + + /** + * Enables/disables rendering of hover styles when the mouse is over a record. This can be useful in templating scenarios, for example, where we don't want to apply hover styling to templated content. + * + */ + igTreeGrid(optionLiteral: 'option', optionName: "enableHoverStyles"): boolean; + + /** + * Enables/disables rendering of hover styles when the mouse is over a record. This can be useful in templating scenarios, for example, where we don't want to apply hover styling to templated content. + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "enableHoverStyles", optionValue: boolean): void; + + /** + * Enables/Disables serializing client date as UTC ISO 8061 string instead of using the local time and zone values. + * + */ + igTreeGrid(optionLiteral: 'option', optionName: "enableUTCDates"): boolean; + + /** + * Enables/Disables serializing client date as UTC ISO 8061 string instead of using the local time and zone values. + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "enableUTCDates", optionValue: boolean): void; + + /** + * Merge unbound columns values inside data source when data source is remote. If true then the unbound columns are merged to the data source at runtime on the server. Note that data source is expanded with the new data and this could cause performance issues when the data is huge. If mergeUnboundColumns is false then the unbound data is sent and merged on the client. This option is used by the [igGrid MVC Helper](http://www.igniteui.com/help/iggrid-developing-asp-net-mvc-applications-with-iggrid). + * Checkout [Populating Unbound Columns Remotely (igGrid)](http://www.igniteui.com/help/iggrid-unboundcolumns-populating-with-data-remotely) topic for more information. + * + */ + igTreeGrid(optionLiteral: 'option', optionName: "mergeUnboundColumns"): boolean; + + /** + * Merge unbound columns values inside data source when data source is remote. If true then the unbound columns are merged to the data source at runtime on the server. Note that data source is expanded with the new data and this could cause performance issues when the data is huge. If mergeUnboundColumns is false then the unbound data is sent and merged on the client. This option is used by the [igGrid MVC Helper](http://www.igniteui.com/help/iggrid-developing-asp-net-mvc-applications-with-iggrid). + * Checkout [Populating Unbound Columns Remotely (igGrid)](http://www.igniteui.com/help/iggrid-unboundcolumns-populating-with-data-remotely) topic for more information. + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "mergeUnboundColumns", optionValue: boolean): void; + + /** + * When dataSource is a remote URL, defines whether to set the type of the remote data source to JSONP. + * + */ + igTreeGrid(optionLiteral: 'option', optionName: "jsonpRequest"): boolean; + + /** + * When dataSource is a remote URL, defines whether to set the type of the remote data source to JSONP. + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "jsonpRequest", optionValue: boolean): void; + + /** + * Enables/disables grid adjusting its dimensions when its [width](ui.iggrid#options:width) and/or [height](ui.iggrid#options:height) is set in percent (%) and grid parent DOM container is resized. + * + */ + igTreeGrid(optionLiteral: 'option', optionName: "enableResizeContainerCheck"): boolean; + + /** + * Enables/disables grid adjusting its dimensions when its [width](ui.iggrid#options:width) and/or [height](ui.iggrid#options:height) is set in percent (%) and grid parent DOM container is resized. + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "enableResizeContainerCheck", optionValue: boolean): void; + + /** + * 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; + + /** + * Configures how the feature chooser icon should display on header cells - e.g. to display as gear icon or not. + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "featureChooserIconDisplay", optionValue: string): void; + + /** + * Settings related to content scrolling. + * + */ + igTreeGrid(optionLiteral: 'option', optionName: "scrollSettings"): IgGridScrollSettings; + + /** + * Settings related to content scrolling. + * + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "scrollSettings", optionValue: IgGridScrollSettings): void; + /** * Fired when a row is about to be expanded. - * use args.owner to access the instance of the igTreeGrid - * use args.row to access the row element (as a wrapped jQuery object) that is about to be expanded - * use args.fixedRow to access the row element (as a jQuery wrapped object) in a fixed column that is about to expanded. If there are no fixed columns then this property returns undefined. - * use args.dataLevel to access the level in the hierarchy associated with the row */ igTreeGrid(optionLiteral: 'option', optionName: "rowExpanding"): RowExpandingEvent; /** * Fired when a row is about to be expanded. - * use args.owner to access the instance of the igTreeGrid - * use args.row to access the row element (as a wrapped jQuery object) that is about to be expanded - * use args.fixedRow to access the row element (as a jQuery wrapped object) in a fixed column that is about to expanded. If there are no fixed columns then this property returns undefined. - * use args.dataLevel to access the level in the hierarchy associated with the row * * @optionValue New value to be set. */ @@ -73299,21 +84917,11 @@ interface JQuery { /** * Fired when a row is expanded. - * use args.owner to access the instance of the igTreeGrid - * use args.row to access the row element (as a wrapped jQuery object) that is about to be expanded - * use args.fixedRow to access the row element (as a jQuery wrapped object) in a fixed column that is about to expanded. If there are no fixed columns then this property returns undefined. - * use args.dataLevel to access the level in the hierarchy associated with the row - * use args.dataRecord to access the source data record */ igTreeGrid(optionLiteral: 'option', optionName: "rowExpanded"): RowExpandedEvent; /** * Fired when a row is expanded. - * use args.owner to access the instance of the igTreeGrid - * use args.row to access the row element (as a wrapped jQuery object) that is about to be expanded - * use args.fixedRow to access the row element (as a jQuery wrapped object) in a fixed column that is about to expanded. If there are no fixed columns then this property returns undefined. - * use args.dataLevel to access the level in the hierarchy associated with the row - * use args.dataRecord to access the source data record * * @optionValue New value to be set. */ @@ -73321,19 +84929,11 @@ interface JQuery { /** * Fired when a row is about to be collapsed. - * use args.owner to access the instance of the igTreeGrid - * use args.row to access the row element (as a wrapped jQuery object) that is about to be expanded - * use args.fixedRow to access the row element (as a jQuery wrapped object) in a fixed column that is about to expanded. If there are no fixed columns then this property returns undefined. - * use args.dataLevel to access the level in the hierarchy associated with the row */ igTreeGrid(optionLiteral: 'option', optionName: "rowCollapsing"): RowCollapsingEvent; /** * Fired when a row is about to be collapsed. - * use args.owner to access the instance of the igTreeGrid - * use args.row to access the row element (as a wrapped jQuery object) that is about to be expanded - * use args.fixedRow to access the row element (as a jQuery wrapped object) in a fixed column that is about to expanded. If there are no fixed columns then this property returns undefined. - * use args.dataLevel to access the level in the hierarchy associated with the row * * @optionValue New value to be set. */ @@ -73341,25 +84941,315 @@ interface JQuery { /** * Fired after a row is collapsed - * use args.owner to access the instance of the igTreeGrid - * use args.row to access the row element (as a wrapped jQuery object) that is about to be expanded - * use args.fixedRow to access the row element (as a jQuery wrapped object) in a fixed column that is about to expanded. If there are no fixed columns then this property returns undefined. - * use args.dataLevel to access the level in the hierarchy associated with the row - * use args.dataRecord to access the source data record */ igTreeGrid(optionLiteral: 'option', optionName: "rowCollapsed"): RowCollapsedEvent; /** * Fired after a row is collapsed - * use args.owner to access the instance of the igTreeGrid - * use args.row to access the row element (as a wrapped jQuery object) that is about to be expanded - * use args.fixedRow to access the row element (as a jQuery wrapped object) in a fixed column that is about to expanded. If there are no fixed columns then this property returns undefined. - * use args.dataLevel to access the level in the hierarchy associated with the row - * use args.dataRecord to access the source data record * * @optionValue New value to be set. */ igTreeGrid(optionLiteral: 'option', optionName: "rowCollapsed", optionValue: RowCollapsedEvent): void; + + /** + * Event fired when a cell is clicked. + */ + igTreeGrid(optionLiteral: 'option', optionName: "cellClick"): CellClickEvent; + + /** + * Event fired when a cell is clicked. + * + * @optionValue Define event handler function. + */ + igTreeGrid(optionLiteral: 'option', optionName: "cellClick", optionValue: CellClickEvent): void; + + /** + * Event fired when a cell is right clicked. + */ + igTreeGrid(optionLiteral: 'option', optionName: "cellRightClick"): CellRightClickEvent; + + /** + * Event fired when a cell is right clicked. + * + * @optionValue Define event handler function. + */ + igTreeGrid(optionLiteral: 'option', optionName: "cellRightClick", optionValue: CellRightClickEvent): void; + + /** + * Event fired before data binding takes place. + * + * Return false in order to cancel data binding. + */ + igTreeGrid(optionLiteral: 'option', optionName: "dataBinding"): DataBindingEvent; + + /** + * Event fired before data binding takes place. + * + * Return false in order to cancel data binding. + * + * @optionValue Define event handler function. + */ + igTreeGrid(optionLiteral: 'option', optionName: "dataBinding", optionValue: DataBindingEvent): void; + + /** + * Event fired after data binding is complete. + */ + igTreeGrid(optionLiteral: 'option', optionName: "dataBound"): DataBoundEvent; + + /** + * Event fired after data binding is complete. + * + * @optionValue Define event handler function. + */ + igTreeGrid(optionLiteral: 'option', optionName: "dataBound", optionValue: DataBoundEvent): void; + + /** + * Event fired before the grid starts rendering (all contents). + * This event is fired only when the grid is being initialized. + * It will not be fired if the grid is rebound to its data + * (for example, when calling the dataBind() API method + * or when changing the page size (when paging is enabled)). + * Return false in order to cancel grid rendering. + */ + igTreeGrid(optionLiteral: 'option', optionName: "rendering"): RenderingEvent; + + /** + * Event fired before the grid starts rendering (all contents). + * This event is fired only when the grid is being initialized. + * It will not be fired if the grid is rebound to its data + * (for example, when calling the dataBind() API method + * or when changing the page size (when paging is enabled)). + * Return false in order to cancel grid rendering. + * + * @optionValue Define event handler function. + */ + igTreeGrid(optionLiteral: 'option', optionName: "rendering", optionValue: RenderingEvent): void; + + /** + * Event fired after the whole grid widget has been rendered (including headers, footers, etc.). + * This event is fired only when the grid is being initialized. + * It will not be fired if the grid is rebound to its data + * (for example, when calling the dataBind() API method + * or when changing the page size (when paging is enabled)). + */ + igTreeGrid(optionLiteral: 'option', optionName: "rendered"): RenderedEvent; + + /** + * Event fired after the whole grid widget has been rendered (including headers, footers, etc.). + * This event is fired only when the grid is being initialized. + * It will not be fired if the grid is rebound to its data + * (for example, when calling the dataBind() API method + * or when changing the page size (when paging is enabled)). + * + * @optionValue Define event handler function. + */ + igTreeGrid(optionLiteral: 'option', optionName: "rendered", optionValue: RenderedEvent): void; + + /** + * Event fired before the TBODY holding the data records starts its rendering. + * Return false in order to cancel data records rendering. + */ + igTreeGrid(optionLiteral: 'option', optionName: "dataRendering"): DataRenderingEvent; + + /** + * Event fired before the TBODY holding the data records starts its rendering. + * Return false in order to cancel data records rendering. + * + * @optionValue Define event handler function. + */ + igTreeGrid(optionLiteral: 'option', optionName: "dataRendering", optionValue: DataRenderingEvent): void; + + /** + * Event fired after all of the data records in the grid table body have been rendered. + */ + igTreeGrid(optionLiteral: 'option', optionName: "dataRendered"): DataRenderedEvent; + + /** + * Event fired after all of the data records in the grid table body have been rendered. + * + * @optionValue Define event handler function. + */ + igTreeGrid(optionLiteral: 'option', optionName: "dataRendered", optionValue: DataRenderedEvent): void; + + /** + * Event fired before the header starts its rendering. + * Return false in order to cancel header rendering. + */ + igTreeGrid(optionLiteral: 'option', optionName: "headerRendering"): HeaderRenderingEvent; + + /** + * Event fired before the header starts its rendering. + * Return false in order to cancel header rendering. + * + * @optionValue Define event handler function. + */ + igTreeGrid(optionLiteral: 'option', optionName: "headerRendering", optionValue: HeaderRenderingEvent): void; + + /** + * Event fired after the header has been rendered. + */ + igTreeGrid(optionLiteral: 'option', optionName: "headerRendered"): HeaderRenderedEvent; + + /** + * Event fired after the header has been rendered. + * + * @optionValue Define event handler function. + */ + igTreeGrid(optionLiteral: 'option', optionName: "headerRendered", optionValue: HeaderRenderedEvent): void; + + /** + * Event fired before the caption starts its rendering. + * Return false in order to cancel caption rendering. + */ + igTreeGrid(optionLiteral: 'option', optionName: "captionRendering"): CaptionRenderingEvent; + + /** + * Event fired before the caption starts its rendering. + * Return false in order to cancel caption rendering. + * + * @optionValue Define event handler function. + */ + igTreeGrid(optionLiteral: 'option', optionName: "captionRendering", optionValue: CaptionRenderingEvent): void; + + /** + * Event fired after the caption has been rendered. + */ + igTreeGrid(optionLiteral: 'option', optionName: "captionRendered"): CaptionRenderedEvent; + + /** + * Event fired after the caption has been rendered. + * + * @optionValue Define event handler function. + */ + igTreeGrid(optionLiteral: 'option', optionName: "captionRendered", optionValue: CaptionRenderedEvent): void; + + /** + * Event fired before the footer starts its rendering. + * + * Return false in order to cancel footer rendering. + */ + igTreeGrid(optionLiteral: 'option', optionName: "footerRendering"): FooterRenderingEvent; + + /** + * Event fired before the footer starts its rendering. + * + * Return false in order to cancel footer rendering. + * + * @optionValue Define event handler function. + */ + igTreeGrid(optionLiteral: 'option', optionName: "footerRendering", optionValue: FooterRenderingEvent): void; + + /** + * Event fired after the footer has been rendered. + */ + igTreeGrid(optionLiteral: 'option', optionName: "footerRendered"): FooterRenderedEvent; + + /** + * Event fired after the footer has been rendered. + * + * @optionValue Define event handler function. + */ + igTreeGrid(optionLiteral: 'option', optionName: "footerRendered", optionValue: FooterRenderedEvent): void; + + /** + * Event fired after every TH in the grid header has been rendered. + */ + igTreeGrid(optionLiteral: 'option', optionName: "headerCellRendered"): HeaderCellRenderedEvent; + + /** + * Event fired after every TH in the grid header has been rendered. + * + * @optionValue Define event handler function. + */ + igTreeGrid(optionLiteral: 'option', optionName: "headerCellRendered", optionValue: HeaderCellRenderedEvent): void; + + /** + * Event fired before actual data rows (TRs) are rendered. + * Return false in order to cancel rows rendering. + */ + igTreeGrid(optionLiteral: 'option', optionName: "rowsRendering"): RowsRenderingEvent; + + /** + * Event fired before actual data rows (TRs) are rendered. + * Return false in order to cancel rows rendering. + * + * @optionValue Define event handler function. + */ + igTreeGrid(optionLiteral: 'option', optionName: "rowsRendering", optionValue: RowsRenderingEvent): void; + + /** + * Event fired after data rows are rendered. + */ + igTreeGrid(optionLiteral: 'option', optionName: "rowsRendered"): RowsRenderedEvent; + + /** + * Event fired after data rows are rendered. + * + * @optionValue Define event handler function. + */ + igTreeGrid(optionLiteral: 'option', optionName: "rowsRendered", optionValue: RowsRenderedEvent): void; + + /** + * Event fired after $.ig.DataSource schema has been generated, in case it needs to be modified. + */ + igTreeGrid(optionLiteral: 'option', optionName: "schemaGenerated"): SchemaGeneratedEvent; + + /** + * Event fired after $.ig.DataSource schema has been generated, in case it needs to be modified. + * + * @optionValue Define event handler function. + */ + igTreeGrid(optionLiteral: 'option', optionName: "schemaGenerated", optionValue: SchemaGeneratedEvent): void; + + /** + * Event fired after the columns colection has been modified(e.g. a column is hidden) + */ + igTreeGrid(optionLiteral: 'option', optionName: "columnsCollectionModified"): ColumnsCollectionModifiedEvent; + + /** + * Event fired after the columns colection has been modified(e.g. a column is hidden) + * + * @optionValue Define event handler function. + */ + igTreeGrid(optionLiteral: 'option', optionName: "columnsCollectionModified", optionValue: ColumnsCollectionModifiedEvent): void; + + /** + * Event fired if there is an error in the request, when the grid is doing a remote operation, + * such as data binding, paging, sorting, etc. + */ + igTreeGrid(optionLiteral: 'option', optionName: "requestError"): RequestErrorEvent; + + /** + * Event fired if there is an error in the request, when the grid is doing a remote operation, + * such as data binding, paging, sorting, etc. + * + * @optionValue Define event handler function. + */ + igTreeGrid(optionLiteral: 'option', optionName: "requestError", optionValue: RequestErrorEvent): void; + + /** + * Fired when the grid is created and the initial structure is rendered (this doesn't necessarily imply the data will be there if the data source is remote) + */ + igTreeGrid(optionLiteral: 'option', optionName: "created"): CreatedEvent; + + /** + * Fired when the grid is created and the initial structure is rendered (this doesn't necessarily imply the data will be there if the data source is remote) + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "created", optionValue: CreatedEvent): void; + + /** + * Fired when the grid is destroyed + */ + igTreeGrid(optionLiteral: 'option', optionName: "destroyed"): DestroyedEvent; + + /** + * Fired when the grid is destroyed + * + * @optionValue New value to be set. + */ + igTreeGrid(optionLiteral: 'option', optionName: "destroyed", optionValue: DestroyedEvent): void; igTreeGrid(options: IgTreeGrid): JQuery; igTreeGrid(optionLiteral: 'option', optionName: string): any; igTreeGrid(optionLiteral: 'option', options: IgTreeGrid): JQuery; @@ -73374,41 +85264,21 @@ interface IgTreeGridMultiColumnHeaders { /** * Event fired before a group collapsing operation is executed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridMultiColumnHeaders widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.column to get the column object for the current group that is collapsing. - * Use ui.element to get a reference to the jQuery object for the column being collapsing (th). */ groupCollapsing?: GroupCollapsingEvent; /** * Event fired after the group collapsing has been executed and results are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridMultiColumnHeaders widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.column to get the column object for the current group that is collapsed. - * Use ui.element to get a reference to the jQuery object for the column being collapsed (th). */ groupCollapsed?: GroupCollapsedEvent; /** * Event fired before a group expanding operation is executed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridMultiColumnHeaders widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.column to get the column object for the current group that is expanding. - * Use ui.element to get a reference to the jQuery object for the column being expanded (th). */ groupExpanding?: GroupExpandingEvent; /** * Event fired after the group expanding has been executed and results are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridMultiColumnHeaders widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.column to get the column object for the current group that is expanded. - * Use ui.element to get a reference to the jQuery object for the column being expanded (th). */ groupExpanded?: GroupExpandedEvent; @@ -73477,21 +85347,11 @@ interface JQuery { /** * Event fired before a group collapsing operation is executed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridMultiColumnHeaders widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.column to get the column object for the current group that is collapsing. - * Use ui.element to get a reference to the jQuery object for the column being collapsing (th). */ igTreeGridMultiColumnHeaders(optionLiteral: 'option', optionName: "groupCollapsing"): GroupCollapsingEvent; /** * Event fired before a group collapsing operation is executed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridMultiColumnHeaders widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.column to get the column object for the current group that is collapsing. - * Use ui.element to get a reference to the jQuery object for the column being collapsing (th). * * @optionValue Define event handler function. */ @@ -73499,21 +85359,11 @@ interface JQuery { /** * Event fired after the group collapsing has been executed and results are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridMultiColumnHeaders widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.column to get the column object for the current group that is collapsed. - * Use ui.element to get a reference to the jQuery object for the column being collapsed (th). */ igTreeGridMultiColumnHeaders(optionLiteral: 'option', optionName: "groupCollapsed"): GroupCollapsedEvent; /** * Event fired after the group collapsing has been executed and results are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridMultiColumnHeaders widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.column to get the column object for the current group that is collapsed. - * Use ui.element to get a reference to the jQuery object for the column being collapsed (th). * * @optionValue Define event handler function. */ @@ -73521,21 +85371,11 @@ interface JQuery { /** * Event fired before a group expanding operation is executed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridMultiColumnHeaders widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.column to get the column object for the current group that is expanding. - * Use ui.element to get a reference to the jQuery object for the column being expanded (th). */ igTreeGridMultiColumnHeaders(optionLiteral: 'option', optionName: "groupExpanding"): GroupExpandingEvent; /** * Event fired before a group expanding operation is executed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridMultiColumnHeaders widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.column to get the column object for the current group that is expanding. - * Use ui.element to get a reference to the jQuery object for the column being expanded (th). * * @optionValue Define event handler function. */ @@ -73543,21 +85383,11 @@ interface JQuery { /** * Event fired after the group expanding has been executed and results are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridMultiColumnHeaders widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.column to get the column object for the current group that is expanded. - * Use ui.element to get a reference to the jQuery object for the column being expanded (th). */ igTreeGridMultiColumnHeaders(optionLiteral: 'option', optionName: "groupExpanded"): GroupExpandedEvent; /** * Event fired after the group expanding has been executed and results are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridMultiColumnHeaders widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.column to get the column object for the current group that is expanded. - * Use ui.element to get a reference to the jQuery object for the column being expanded (th). * * @optionValue Define event handler function. */ @@ -73573,25 +85403,6 @@ interface ContextRowRenderingEvent { } interface ContextRowRenderingEventUIParam { - /** - * Used to get reference to igTreeGridPaging. - */ - owner?: any; - - /** - * Used to get reference to the first data row. Null if there are no records. - */ - dataRow?: any; - - /** - * Used to get current page index. - */ - currentPageIndex?: any; - - /** - * Used to get the current context row mode. - */ - contextRowMode?: any; } interface ContextRowRenderedEvent { @@ -73599,30 +85410,6 @@ interface ContextRowRenderedEvent { } interface ContextRowRenderedEventUIParam { - /** - * Used to get reference to igTreeGridPaging. - */ - owner?: any; - - /** - * Used to get reference to the first data row. Null if there are no records. - */ - dataRow?: any; - - /** - * Used to get current page index. - */ - currentPageIndex?: any; - - /** - * Used to get array of the parent rows(of the ui.dataRow). If the dataRow is null(for instance filter is applied and no records are shown) then it is empty array. Otherwise it contains all ancestors ordered by level(including the current dataRow) - the first item is root level, the last array item is the current ui.dataRow - */ - parentRows?: any; - - /** - * Used to get the current context row mode. - */ - contextRowMode?: any; } interface IgTreeGridPaging { @@ -73898,81 +85685,45 @@ interface IgTreeGridPaging { /** * Event fired before rendering context row content. * Return false in order to cancel this event. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to igTreeGridPaging. - * Use ui.dataRow to get reference to the first data row. Null if there are no records. - * Use ui.currentPageIndex to get current page index. - * Use ui.contextRowMode to get the current context row mode. */ contextRowRendering?: ContextRowRenderingEvent; /** * Event fired context row content is rendered. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to igTreeGridPaging. - * Use ui.dataRow to get reference to the first data row. Null if there are no records. - * Use ui.currentPageIndex to get current page index. - * Use ui.parentRows to get array of the parent rows(of the ui.dataRow). If the dataRow is null(for instance filter is applied and no records are shown) then it is empty array. Otherwise it contains all ancestors ordered by level(including the current dataRow) - the first item is root level, the last array item is the current ui.dataRow - * Use ui.contextRowMode to get the current context row mode. */ contextRowRendered?: ContextRowRenderedEvent; /** * Event fired before the page index is changed. * Return false in order to cancel page index changing. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridPaging. - * Use ui.owner.grid to get reference to the grid. - * Use ui.currentPageIndex to get current page index. - * Use ui.newPageIndex to get new page index. */ pageIndexChanging?: PageIndexChangingEvent; /** * Event fired after the page index is changed , but before grid data rebinds - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridPaging. - * Use ui.owner.grid to get reference to the grid. - * Use ui.pageIndex to get current page index. */ pageIndexChanged?: PageIndexChangedEvent; /** * Event fired when the page size is about to be changed from the page size dropdown. * Return false in order to cancel page size changing. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridPaging. - * Use ui.owner.grid to get reference to the grid. - * Use ui.currentPageSize to get current page size. * Use ui.newPageSize to get new page size. */ pageSizeChanging?: PageSizeChangingEvent; /** * Event fired after the page size is changed from the page size dropdown. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridPaging. - * Use ui.owner.grid to get reference to the grid. - * Use ui.pageSize to get current page size. */ pageSizeChanged?: PageSizeChangedEvent; /** * Event fired before the pager footer is rendered (the whole area below the grid records). - * Return false in order to cancel pager footer rendering. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridPaging. - * Use ui.owner.grid to get reference to the grid. - * Use ui.dataSource to get reference to grid's data source. + * Event fired after the page size is changed from the page size dropdown. */ pagerRendering?: PagerRenderingEvent; /** * Event fired after the pager footer is rendered - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridPaging. - * Use ui.owner.grid to get reference to the grid. - * Use ui.dataSource to get reference to grid's data source. */ pagerRendered?: PagerRenderedEvent; @@ -74613,22 +86364,12 @@ interface JQuery { /** * Event fired before rendering context row content. * Return false in order to cancel this event. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to igTreeGridPaging. - * Use ui.dataRow to get reference to the first data row. Null if there are no records. - * Use ui.currentPageIndex to get current page index. - * Use ui.contextRowMode to get the current context row mode. */ igTreeGridPaging(optionLiteral: 'option', optionName: "contextRowRendering"): ContextRowRenderingEvent; /** * Event fired before rendering context row content. * Return false in order to cancel this event. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to igTreeGridPaging. - * Use ui.dataRow to get reference to the first data row. Null if there are no records. - * Use ui.currentPageIndex to get current page index. - * Use ui.contextRowMode to get the current context row mode. * * @optionValue Define event handler function. */ @@ -74636,23 +86377,11 @@ interface JQuery { /** * Event fired context row content is rendered. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to igTreeGridPaging. - * Use ui.dataRow to get reference to the first data row. Null if there are no records. - * Use ui.currentPageIndex to get current page index. - * Use ui.parentRows to get array of the parent rows(of the ui.dataRow). If the dataRow is null(for instance filter is applied and no records are shown) then it is empty array. Otherwise it contains all ancestors ordered by level(including the current dataRow) - the first item is root level, the last array item is the current ui.dataRow - * Use ui.contextRowMode to get the current context row mode. */ igTreeGridPaging(optionLiteral: 'option', optionName: "contextRowRendered"): ContextRowRenderedEvent; /** * Event fired context row content is rendered. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to igTreeGridPaging. - * Use ui.dataRow to get reference to the first data row. Null if there are no records. - * Use ui.currentPageIndex to get current page index. - * Use ui.parentRows to get array of the parent rows(of the ui.dataRow). If the dataRow is null(for instance filter is applied and no records are shown) then it is empty array. Otherwise it contains all ancestors ordered by level(including the current dataRow) - the first item is root level, the last array item is the current ui.dataRow - * Use ui.contextRowMode to get the current context row mode. * * @optionValue Define event handler function. */ @@ -74661,22 +86390,12 @@ interface JQuery { /** * Event fired before the page index is changed. * Return false in order to cancel page index changing. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridPaging. - * Use ui.owner.grid to get reference to the grid. - * Use ui.currentPageIndex to get current page index. - * Use ui.newPageIndex to get new page index. */ igTreeGridPaging(optionLiteral: 'option', optionName: "pageIndexChanging"): PageIndexChangingEvent; /** * Event fired before the page index is changed. * Return false in order to cancel page index changing. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridPaging. - * Use ui.owner.grid to get reference to the grid. - * Use ui.currentPageIndex to get current page index. - * Use ui.newPageIndex to get new page index. * * @optionValue Define event handler function. */ @@ -74684,19 +86403,11 @@ interface JQuery { /** * Event fired after the page index is changed , but before grid data rebinds - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridPaging. - * Use ui.owner.grid to get reference to the grid. - * Use ui.pageIndex to get current page index. */ igTreeGridPaging(optionLiteral: 'option', optionName: "pageIndexChanged"): PageIndexChangedEvent; /** * Event fired after the page index is changed , but before grid data rebinds - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridPaging. - * Use ui.owner.grid to get reference to the grid. - * Use ui.pageIndex to get current page index. * * @optionValue Define event handler function. */ @@ -74705,10 +86416,6 @@ interface JQuery { /** * Event fired when the page size is about to be changed from the page size dropdown. * Return false in order to cancel page size changing. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridPaging. - * Use ui.owner.grid to get reference to the grid. - * Use ui.currentPageSize to get current page size. * Use ui.newPageSize to get new page size. */ igTreeGridPaging(optionLiteral: 'option', optionName: "pageSizeChanging"): PageSizeChangingEvent; @@ -74716,10 +86423,6 @@ interface JQuery { /** * Event fired when the page size is about to be changed from the page size dropdown. * Return false in order to cancel page size changing. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridPaging. - * Use ui.owner.grid to get reference to the grid. - * Use ui.currentPageSize to get current page size. * Use ui.newPageSize to get new page size. * * @optionValue Define event handler function. @@ -74728,19 +86431,11 @@ interface JQuery { /** * Event fired after the page size is changed from the page size dropdown. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridPaging. - * Use ui.owner.grid to get reference to the grid. - * Use ui.pageSize to get current page size. */ igTreeGridPaging(optionLiteral: 'option', optionName: "pageSizeChanged"): PageSizeChangedEvent; /** * Event fired after the page size is changed from the page size dropdown. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridPaging. - * Use ui.owner.grid to get reference to the grid. - * Use ui.pageSize to get current page size. * * @optionValue Define event handler function. */ @@ -74748,21 +86443,13 @@ interface JQuery { /** * Event fired before the pager footer is rendered (the whole area below the grid records). - * Return false in order to cancel pager footer rendering. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridPaging. - * Use ui.owner.grid to get reference to the grid. - * Use ui.dataSource to get reference to grid's data source. + * Event fired after the page size is changed from the page size dropdown. */ igTreeGridPaging(optionLiteral: 'option', optionName: "pagerRendering"): PagerRenderingEvent; /** * Event fired before the pager footer is rendered (the whole area below the grid records). - * Return false in order to cancel pager footer rendering. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridPaging. - * Use ui.owner.grid to get reference to the grid. - * Use ui.dataSource to get reference to grid's data source. + * Event fired after the page size is changed from the page size dropdown. * * @optionValue Define event handler function. */ @@ -74770,19 +86457,11 @@ interface JQuery { /** * Event fired after the pager footer is rendered - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridPaging. - * Use ui.owner.grid to get reference to the grid. - * Use ui.dataSource to get reference to grid's data source. */ igTreeGridPaging(optionLiteral: 'option', optionName: "pagerRendered"): PagerRenderedEvent; /** * Event fired after the pager footer is rendered - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridPaging. - * Use ui.owner.grid to get reference to the grid. - * Use ui.dataSource to get reference to grid's data source. * * @optionValue Define event handler function. */ @@ -74825,35 +86504,16 @@ interface IgTreeGridResizing { /** * Event fired before a resizing operation is executed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridResizing widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the resized column index. - * Use ui.columnKey to get the resized column key. - * Use ui.desiredWidth to get the desired width(before min/max coercion) for the resized column. */ columnResizing?: ColumnResizingEvent; /** * Event fired(only when columnFixing is enabled) when trying to resize column in fixed area so total width of unfixed area to be less than minimalVisibleAreaWidth(option defined in columnFixing) - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridResizing widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the resized column index. - * Use ui.columnKey to get the resized column key. - * Use ui.desiredWidth to get the desired width(before min/max coercion) for the resized column. */ columnResizingRefused?: ColumnResizingRefusedEvent; /** * Event fired after the resizing has been executed and results are rendered - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridResizing widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the resized column index. - * Use ui.columnKey to get the resized column key. - * Use ui.originalWidth to get the original column width. - * Use ui.newWidth to get the final column width after resizing. */ columnResized?: ColumnResizedEvent; @@ -74951,23 +86611,11 @@ interface JQuery { /** * Event fired before a resizing operation is executed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridResizing widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the resized column index. - * Use ui.columnKey to get the resized column key. - * Use ui.desiredWidth to get the desired width(before min/max coercion) for the resized column. */ igTreeGridResizing(optionLiteral: 'option', optionName: "columnResizing"): ColumnResizingEvent; /** * Event fired before a resizing operation is executed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridResizing widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the resized column index. - * Use ui.columnKey to get the resized column key. - * Use ui.desiredWidth to get the desired width(before min/max coercion) for the resized column. * * @optionValue Define event handler function. */ @@ -74975,23 +86623,11 @@ interface JQuery { /** * Event fired(only when columnFixing is enabled) when trying to resize column in fixed area so total width of unfixed area to be less than minimalVisibleAreaWidth(option defined in columnFixing) - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridResizing widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the resized column index. - * Use ui.columnKey to get the resized column key. - * Use ui.desiredWidth to get the desired width(before min/max coercion) for the resized column. */ igTreeGridResizing(optionLiteral: 'option', optionName: "columnResizingRefused"): ColumnResizingRefusedEvent; /** * Event fired(only when columnFixing is enabled) when trying to resize column in fixed area so total width of unfixed area to be less than minimalVisibleAreaWidth(option defined in columnFixing) - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridResizing widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the resized column index. - * Use ui.columnKey to get the resized column key. - * Use ui.desiredWidth to get the desired width(before min/max coercion) for the resized column. * * @optionValue Define event handler function. */ @@ -74999,25 +86635,11 @@ interface JQuery { /** * Event fired after the resizing has been executed and results are rendered - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridResizing widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the resized column index. - * Use ui.columnKey to get the resized column key. - * Use ui.originalWidth to get the original column width. - * Use ui.newWidth to get the final column width after resizing. */ igTreeGridResizing(optionLiteral: 'option', optionName: "columnResized"): ColumnResizedEvent; /** * Event fired after the resizing has been executed and results are rendered - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridResizing widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnIndex to get the resized column index. - * Use ui.columnKey to get the resized column key. - * Use ui.originalWidth to get the original column width. - * Use ui.newWidth to get the final column width after resizing. * * @optionValue Define event handler function. */ @@ -75068,6 +86690,7 @@ interface IgTreeGridRowSelectors { rowNumberingSeed?: number; /** + * defines width of the row selector`s column in pixels or percentage. * * * Valid values: @@ -75124,43 +86747,16 @@ interface IgTreeGridRowSelectors { /** * Event fired after a row selector is clicked. - * Function takes arguments evt and ui. - * Use ui.row to get reference to the row the clicked row selector resides in. - * Use ui.fixedRow to get reference to the fixed row the clicked row selector resides in(if there are fixed columns). - * Use ui.rowIndex to get the index of the row the clicked row selector resides in. - * Use ui.rowKey to get the key of the row the clicked row selector resides in. - * Use ui.rowSelector to get reference to the row selector cell. - * Use ui.owner to get reference to RowSelectors. - * Use ui.grid to get reference to the grid the RowSelectors are initialized for. */ rowSelectorClicked?: RowSelectorClickedEvent; /** * Event fired when a row selector checkbox is changing. - * Function takes arguments evt and ui. - * Use ui.row to get reference to the row the clicked row selector resides in. - * Use ui.rowIndex to get the index of the row the clicked row selector resides in. - * Use ui.rowKey to get the key of the row the clicked row selector resides in. - * Use ui.rowSelector to get reference to the row selector cell. - * Use ui.owner to get reference to igRowSelectors. - * Use ui.grid to get reference to the grid the RowSelectors are initialized for. - * Use ui.currentState to get the current state of the checkbox ("on","off"). - * Use ui.newState to get the new state of the checkbox ("on","off"). - * Use ui.isHeader to check if the header check box is the one being clicked. In this case no row related args are passed. */ checkBoxStateChanging?: CheckBoxStateChangingEvent; /** * Event fired after a row selector checkbox had changed state. - * Function takes arguments evt and ui. - * Use ui.row to get reference to the row the clicked row selector resides in. - * Use ui.rowIndex to get the index of the row the clicked row selector resides in. - * Use ui.rowKey to get the key of the row the clicked row selector resides in. - * Use ui.rowSelector to get reference to the row selector cell. - * Use ui.owner to get reference to igRowSelectors. - * Use ui.grid to get reference to the grid the RowSelectors are initialized for. - * Use ui.state to get the state of the checkbox ("on","off"). - * Use ui.isHeader to check if the header check box is the one being clicked. In this case no row related args are passed. */ checkBoxStateChanged?: CheckBoxStateChangedEvent; @@ -75310,12 +86906,14 @@ interface JQuery { igTreeGridRowSelectors(optionLiteral: 'option', optionName: "rowNumberingSeed", optionValue: number): void; /** - * * + * Defines width of the row selector`s column in pixels or percentage. + * */ igTreeGridRowSelectors(optionLiteral: 'option', optionName: "rowSelectorColumnWidth"): string|number; /** - * * + * Defines width of the row selector`s column in pixels or percentage. + * * * @optionValue New value to be set. */ @@ -75425,27 +87023,11 @@ interface JQuery { /** * Event fired after a row selector is clicked. - * Function takes arguments evt and ui. - * Use ui.row to get reference to the row the clicked row selector resides in. - * Use ui.fixedRow to get reference to the fixed row the clicked row selector resides in(if there are fixed columns). - * Use ui.rowIndex to get the index of the row the clicked row selector resides in. - * Use ui.rowKey to get the key of the row the clicked row selector resides in. - * Use ui.rowSelector to get reference to the row selector cell. - * Use ui.owner to get reference to RowSelectors. - * Use ui.grid to get reference to the grid the RowSelectors are initialized for. */ igTreeGridRowSelectors(optionLiteral: 'option', optionName: "rowSelectorClicked"): RowSelectorClickedEvent; /** * Event fired after a row selector is clicked. - * Function takes arguments evt and ui. - * Use ui.row to get reference to the row the clicked row selector resides in. - * Use ui.fixedRow to get reference to the fixed row the clicked row selector resides in(if there are fixed columns). - * Use ui.rowIndex to get the index of the row the clicked row selector resides in. - * Use ui.rowKey to get the key of the row the clicked row selector resides in. - * Use ui.rowSelector to get reference to the row selector cell. - * Use ui.owner to get reference to RowSelectors. - * Use ui.grid to get reference to the grid the RowSelectors are initialized for. * * @optionValue Define event handler function. */ @@ -75453,31 +87035,11 @@ interface JQuery { /** * Event fired when a row selector checkbox is changing. - * Function takes arguments evt and ui. - * Use ui.row to get reference to the row the clicked row selector resides in. - * Use ui.rowIndex to get the index of the row the clicked row selector resides in. - * Use ui.rowKey to get the key of the row the clicked row selector resides in. - * Use ui.rowSelector to get reference to the row selector cell. - * Use ui.owner to get reference to igRowSelectors. - * Use ui.grid to get reference to the grid the RowSelectors are initialized for. - * Use ui.currentState to get the current state of the checkbox ("on","off"). - * Use ui.newState to get the new state of the checkbox ("on","off"). - * Use ui.isHeader to check if the header check box is the one being clicked. In this case no row related args are passed. */ igTreeGridRowSelectors(optionLiteral: 'option', optionName: "checkBoxStateChanging"): CheckBoxStateChangingEvent; /** * Event fired when a row selector checkbox is changing. - * Function takes arguments evt and ui. - * Use ui.row to get reference to the row the clicked row selector resides in. - * Use ui.rowIndex to get the index of the row the clicked row selector resides in. - * Use ui.rowKey to get the key of the row the clicked row selector resides in. - * Use ui.rowSelector to get reference to the row selector cell. - * Use ui.owner to get reference to igRowSelectors. - * Use ui.grid to get reference to the grid the RowSelectors are initialized for. - * Use ui.currentState to get the current state of the checkbox ("on","off"). - * Use ui.newState to get the new state of the checkbox ("on","off"). - * Use ui.isHeader to check if the header check box is the one being clicked. In this case no row related args are passed. * * @optionValue Define event handler function. */ @@ -75485,29 +87047,11 @@ interface JQuery { /** * Event fired after a row selector checkbox had changed state. - * Function takes arguments evt and ui. - * Use ui.row to get reference to the row the clicked row selector resides in. - * Use ui.rowIndex to get the index of the row the clicked row selector resides in. - * Use ui.rowKey to get the key of the row the clicked row selector resides in. - * Use ui.rowSelector to get reference to the row selector cell. - * Use ui.owner to get reference to igRowSelectors. - * Use ui.grid to get reference to the grid the RowSelectors are initialized for. - * Use ui.state to get the state of the checkbox ("on","off"). - * Use ui.isHeader to check if the header check box is the one being clicked. In this case no row related args are passed. */ igTreeGridRowSelectors(optionLiteral: 'option', optionName: "checkBoxStateChanged"): CheckBoxStateChangedEvent; /** * Event fired after a row selector checkbox had changed state. - * Function takes arguments evt and ui. - * Use ui.row to get reference to the row the clicked row selector resides in. - * Use ui.rowIndex to get the index of the row the clicked row selector resides in. - * Use ui.rowKey to get the key of the row the clicked row selector resides in. - * Use ui.rowSelector to get reference to the row selector cell. - * Use ui.owner to get reference to igRowSelectors. - * Use ui.grid to get reference to the grid the RowSelectors are initialized for. - * Use ui.state to get the state of the checkbox ("on","off"). - * Use ui.isHeader to check if the header check box is the one being clicked. In this case no row related args are passed. * * @optionValue Define event handler function. */ @@ -75586,122 +87130,44 @@ interface IgTreeGridSelection { /** * Event fired before row(s) are about to be selected (cancellable). * Return false in order to cancel selection changing. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.row to get reference to row object. - * Use ui.row.element to get reference to row DOM element. - * Use ui.row.index to get row index. - * Use ui.row.id to get the row id if primary key is defined or persistence is enabled. - * Use ui.selectedRows to get reference to rows object array. - * Use ui.startIndex to get the start index for a range row selection. - * Use ui.endIndex to get the end index for a range row selection. */ rowSelectionChanging?: RowSelectionChangingEvent; /** * Event fired after row(s) are selected. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.row to get reference to row object. - * Use ui.row.element to get reference to row DOM element. - * Use ui.row.index to get row index. - * Use ui.row.id to get the row id if primary key is defined or persistence is enabled. - * Use ui.selectedRows to get reference to rows object array. */ rowSelectionChanged?: RowSelectionChangedEvent; /** * Event fired before cell(s) are about to be selected (cancellable). * Return false in order to cancel cell selection changing. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.cell to get reference to cell object. - * Use ui.cell.element to get reference to cell DOM element. - * Use ui.cell.columnKey to get reference to column key. - * Use ui.cell.rowId to get the row id if primary key is defined or persistence is enabled. - * Use ui.cell.index to get column index. - * Use ui.cell.row to get reference to row DOM element. - * Use ui.cell.rowIndex to get row index. - * Use ui.selectedCells to get reference to selected cells object array. - * Use ui.firstColumnIndex to get the column index for the first cell in a range selection. - * Use ui.firstRowIndex to get the row index for the first cell in a range selection. - * Use ui.lastColumnIndex to get the column index for the last cell in a range selection. - * Use ui.lastRowIndex to get the row index for the last cell in a range selection. */ cellSelectionChanging?: CellSelectionChangingEvent; /** * Event fired after cell(s) are selected. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.cell to get reference to cell object. - * Use ui.cell.element to get reference to cell DOM element. - * Use ui.cell.columnKey to get reference to column key. - * Use ui.cell.rowId to get the row id if primary key is defined or persistence is enabled. - * Use ui.cell.index to get column index. - * Use ui.cell.row to get reference to row DOM element. - * Use ui.cell.rowIndex to get row index. - * Use ui.selectedCells to get reference to selected cells object array. */ cellSelectionChanged?: CellSelectionChangedEvent; /** * Event fired before a cell becomes active (focus style applied) (cancellable). * Return false in order to cancel active cell changing. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.cell to get reference to cell object. - * Use ui.cell.element to get reference to cell DOM element. - * Use ui.cell.columnKey to get column key. - * Use ui.cell.rowId to get the row id if primary key is defined or persistence is enabled. - * Use ui.cell.index to get column index. - * Use ui.cell.row to get reference to row DOM element. - * Use ui.cell.rowIndex to get row index. */ activeCellChanging?: ActiveCellChangingEvent; /** * Event fired after a cell becomes active (focus style applied). - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.cell to get reference to cell object. - * Use ui.cell.element to get reference to cell DOM element. - * Use ui.cell.columnKey to get column key. - * Use ui.cell.rowId to get the row id if primary key is defined or persistence is enabled. - * Use ui.cell.index to get column index. - * Use ui.cell.row to get reference to row DOM element. - * Use ui.cell.rowIndex to get row index. */ activeCellChanged?: ActiveCellChangedEvent; /** * Event fired before a row becomes active (focus style applied) (cancellable). * Return false in order to cancel active row changing. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.row to get reference to row object. - * Use ui.row.element to get reference to active row DOM element. - * Use ui.row.index to get active row index. - * Use ui.row.id to get the active row id if primary key is defined or persistence is enabled. */ activeRowChanging?: ActiveRowChangingEvent; /** * Event fired after a row becomes active (focus style applied). - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.row to get reference to row object. - * Use ui.row.element to get reference to active row DOM element. - * Use ui.row.index to get active row index. - * Use ui.row.id to get the active row id if primary key is defined or persistence is enabled. */ activeRowChanged?: ActiveRowChangedEvent; @@ -75783,28 +87249,28 @@ interface IgTreeGridSelectionMethods { /** * Returns an array of selected cells in arbitrary order where every objects has the format { element: , row: , index: , rowIndex: , columnKey: } . * - * If multiple selection is disabled the function will return null. + * If multiple selection is disabled the function will return null. */ selectedCells(): any[]; /** * Returns an array of selected rows in arbitrary order where every object has the format { element: , index: } . * - * If multiple selection is disabled the function will return null. + * If multiple selection is disabled the function will return null. */ selectedRows(): any[]; /** * Returns the currently selected cell that has the format { element: , row: , index: , rowIndex: , columnKey: }, if any. * - * If multiple selection is enabled the function will return null. + * If multiple selection is enabled the function will return null. */ selectedCell(): Object; /** * Returns the currently selected row that has the format { element: , index: }, if any. * - * If multiple selection is enabled the function will return null. + * If multiple selection is enabled the function will return null. */ selectedRow(): Object; @@ -75983,32 +87449,12 @@ interface JQuery { /** * Event fired before row(s) are about to be selected (cancellable). * Return false in order to cancel selection changing. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.row to get reference to row object. - * Use ui.row.element to get reference to row DOM element. - * Use ui.row.index to get row index. - * Use ui.row.id to get the row id if primary key is defined or persistence is enabled. - * Use ui.selectedRows to get reference to rows object array. - * Use ui.startIndex to get the start index for a range row selection. - * Use ui.endIndex to get the end index for a range row selection. */ igTreeGridSelection(optionLiteral: 'option', optionName: "rowSelectionChanging"): RowSelectionChangingEvent; /** * Event fired before row(s) are about to be selected (cancellable). * Return false in order to cancel selection changing. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.row to get reference to row object. - * Use ui.row.element to get reference to row DOM element. - * Use ui.row.index to get row index. - * Use ui.row.id to get the row id if primary key is defined or persistence is enabled. - * Use ui.selectedRows to get reference to rows object array. - * Use ui.startIndex to get the start index for a range row selection. - * Use ui.endIndex to get the end index for a range row selection. * * @optionValue Define event handler function. */ @@ -76016,27 +87462,11 @@ interface JQuery { /** * Event fired after row(s) are selected. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.row to get reference to row object. - * Use ui.row.element to get reference to row DOM element. - * Use ui.row.index to get row index. - * Use ui.row.id to get the row id if primary key is defined or persistence is enabled. - * Use ui.selectedRows to get reference to rows object array. */ igTreeGridSelection(optionLiteral: 'option', optionName: "rowSelectionChanged"): RowSelectionChangedEvent; /** * Event fired after row(s) are selected. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.row to get reference to row object. - * Use ui.row.element to get reference to row DOM element. - * Use ui.row.index to get row index. - * Use ui.row.id to get the row id if primary key is defined or persistence is enabled. - * Use ui.selectedRows to get reference to rows object array. * * @optionValue Define event handler function. */ @@ -76045,42 +87475,12 @@ interface JQuery { /** * Event fired before cell(s) are about to be selected (cancellable). * Return false in order to cancel cell selection changing. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.cell to get reference to cell object. - * Use ui.cell.element to get reference to cell DOM element. - * Use ui.cell.columnKey to get reference to column key. - * Use ui.cell.rowId to get the row id if primary key is defined or persistence is enabled. - * Use ui.cell.index to get column index. - * Use ui.cell.row to get reference to row DOM element. - * Use ui.cell.rowIndex to get row index. - * Use ui.selectedCells to get reference to selected cells object array. - * Use ui.firstColumnIndex to get the column index for the first cell in a range selection. - * Use ui.firstRowIndex to get the row index for the first cell in a range selection. - * Use ui.lastColumnIndex to get the column index for the last cell in a range selection. - * Use ui.lastRowIndex to get the row index for the last cell in a range selection. */ igTreeGridSelection(optionLiteral: 'option', optionName: "cellSelectionChanging"): CellSelectionChangingEvent; /** * Event fired before cell(s) are about to be selected (cancellable). * Return false in order to cancel cell selection changing. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.cell to get reference to cell object. - * Use ui.cell.element to get reference to cell DOM element. - * Use ui.cell.columnKey to get reference to column key. - * Use ui.cell.rowId to get the row id if primary key is defined or persistence is enabled. - * Use ui.cell.index to get column index. - * Use ui.cell.row to get reference to row DOM element. - * Use ui.cell.rowIndex to get row index. - * Use ui.selectedCells to get reference to selected cells object array. - * Use ui.firstColumnIndex to get the column index for the first cell in a range selection. - * Use ui.firstRowIndex to get the row index for the first cell in a range selection. - * Use ui.lastColumnIndex to get the column index for the last cell in a range selection. - * Use ui.lastRowIndex to get the row index for the last cell in a range selection. * * @optionValue Define event handler function. */ @@ -76088,33 +87488,11 @@ interface JQuery { /** * Event fired after cell(s) are selected. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.cell to get reference to cell object. - * Use ui.cell.element to get reference to cell DOM element. - * Use ui.cell.columnKey to get reference to column key. - * Use ui.cell.rowId to get the row id if primary key is defined or persistence is enabled. - * Use ui.cell.index to get column index. - * Use ui.cell.row to get reference to row DOM element. - * Use ui.cell.rowIndex to get row index. - * Use ui.selectedCells to get reference to selected cells object array. */ igTreeGridSelection(optionLiteral: 'option', optionName: "cellSelectionChanged"): CellSelectionChangedEvent; /** * Event fired after cell(s) are selected. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.cell to get reference to cell object. - * Use ui.cell.element to get reference to cell DOM element. - * Use ui.cell.columnKey to get reference to column key. - * Use ui.cell.rowId to get the row id if primary key is defined or persistence is enabled. - * Use ui.cell.index to get column index. - * Use ui.cell.row to get reference to row DOM element. - * Use ui.cell.rowIndex to get row index. - * Use ui.selectedCells to get reference to selected cells object array. * * @optionValue Define event handler function. */ @@ -76123,32 +87501,12 @@ interface JQuery { /** * Event fired before a cell becomes active (focus style applied) (cancellable). * Return false in order to cancel active cell changing. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.cell to get reference to cell object. - * Use ui.cell.element to get reference to cell DOM element. - * Use ui.cell.columnKey to get column key. - * Use ui.cell.rowId to get the row id if primary key is defined or persistence is enabled. - * Use ui.cell.index to get column index. - * Use ui.cell.row to get reference to row DOM element. - * Use ui.cell.rowIndex to get row index. */ igTreeGridSelection(optionLiteral: 'option', optionName: "activeCellChanging"): ActiveCellChangingEvent; /** * Event fired before a cell becomes active (focus style applied) (cancellable). * Return false in order to cancel active cell changing. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.cell to get reference to cell object. - * Use ui.cell.element to get reference to cell DOM element. - * Use ui.cell.columnKey to get column key. - * Use ui.cell.rowId to get the row id if primary key is defined or persistence is enabled. - * Use ui.cell.index to get column index. - * Use ui.cell.row to get reference to row DOM element. - * Use ui.cell.rowIndex to get row index. * * @optionValue Define event handler function. */ @@ -76156,31 +87514,11 @@ interface JQuery { /** * Event fired after a cell becomes active (focus style applied). - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.cell to get reference to cell object. - * Use ui.cell.element to get reference to cell DOM element. - * Use ui.cell.columnKey to get column key. - * Use ui.cell.rowId to get the row id if primary key is defined or persistence is enabled. - * Use ui.cell.index to get column index. - * Use ui.cell.row to get reference to row DOM element. - * Use ui.cell.rowIndex to get row index. */ igTreeGridSelection(optionLiteral: 'option', optionName: "activeCellChanged"): ActiveCellChangedEvent; /** * Event fired after a cell becomes active (focus style applied). - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.cell to get reference to cell object. - * Use ui.cell.element to get reference to cell DOM element. - * Use ui.cell.columnKey to get column key. - * Use ui.cell.rowId to get the row id if primary key is defined or persistence is enabled. - * Use ui.cell.index to get column index. - * Use ui.cell.row to get reference to row DOM element. - * Use ui.cell.rowIndex to get row index. * * @optionValue Define event handler function. */ @@ -76189,26 +87527,12 @@ interface JQuery { /** * Event fired before a row becomes active (focus style applied) (cancellable). * Return false in order to cancel active row changing. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.row to get reference to row object. - * Use ui.row.element to get reference to active row DOM element. - * Use ui.row.index to get active row index. - * Use ui.row.id to get the active row id if primary key is defined or persistence is enabled. */ igTreeGridSelection(optionLiteral: 'option', optionName: "activeRowChanging"): ActiveRowChangingEvent; /** * Event fired before a row becomes active (focus style applied) (cancellable). * Return false in order to cancel active row changing. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.row to get reference to row object. - * Use ui.row.element to get reference to active row DOM element. - * Use ui.row.index to get active row index. - * Use ui.row.id to get the active row id if primary key is defined or persistence is enabled. * * @optionValue Define event handler function. */ @@ -76216,25 +87540,11 @@ interface JQuery { /** * Event fired after a row becomes active (focus style applied). - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.row to get reference to row object. - * Use ui.row.element to get reference to active row DOM element. - * Use ui.row.index to get active row index. - * Use ui.row.id to get the active row id if primary key is defined or persistence is enabled. */ igTreeGridSelection(optionLiteral: 'option', optionName: "activeRowChanged"): ActiveRowChangedEvent; /** * Event fired after a row becomes active (focus style applied). - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSelection. - * Use ui.owner.grid to get reference to the grid. - * Use ui.row to get reference to row object. - * Use ui.row.element to get reference to active row DOM element. - * Use ui.row.index to get active row index. - * Use ui.row.id to get the active row id if primary key is defined or persistence is enabled. * * @optionValue Define event handler function. */ @@ -76468,138 +87778,71 @@ interface IgTreeGridSorting { /** * Event fired before sorting is invoked for a certain column. * Return false in order to cancel column sorting. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSorting. - * Use ui.owner.grid to get reference to grid. - * Use ui.columnKey to get column key. - * Use ui.direction to get sorting direction. - * Use ui.newExpressions to get sorting expressions. */ columnSorting?: ColumnSortingEvent; /** * Event fired after the column has already been sorted and data - re-rendered. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSorting. - * Use ui.owner.grid to get reference to grid. - * Use ui.columnKey to get column key. - * Use ui.direction to get sorting direction. - * Use ui.expressions to get sorted expressions. */ columnSorted?: ColumnSortedEvent; /** * Event fired before the modal dialog is opened. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the modal dialog element. This is a jQuery object. */ modalDialogOpening?: ModalDialogOpeningEvent; /** * Event fired after the modal dialog is already opened. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. */ modalDialogOpened?: ModalDialogOpenedEvent; /** * Event fired every time the modal dialog changes its position. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. - * Use ui.originalPosition to get the original position of the modal dialog div as { top, left } object, relative to the page. - * Use ui.position to get the current position of the modal dialog div as { top, left } object, relative to the page. */ modalDialogMoving?: ModalDialogMovingEvent; /** * Event fired before the modal dialog is closed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. */ modalDialogClosing?: ModalDialogClosingEvent; /** * Event fired after the modal dialog has been closed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. */ modalDialogClosed?: ModalDialogClosedEvent; /** * Event fired before the contents of the modal dialog are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. */ modalDialogContentsRendering?: ModalDialogContentsRenderingEvent; /** * Event fired after the contents of the modal dialog are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. */ modalDialogContentsRendered?: ModalDialogContentsRenderedEvent; /** * Event fired when sorting of column is changed in modal dialog. Column should be sorted - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. - * Use ui.columnKey to get the column key - * Use ui.isAsc to get whether column should be ascending or not. If true it should be ascending */ modalDialogSortingChanged?: ModalDialogSortingChangedEvent; /** * Event fired when button to unsort column is clicked in modal dialog - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. - * Use ui.columnKey to get the column key */ modalDialogButtonUnsortClick?: ModalDialogButtonUnsortClickEvent; /** * Event fired when column(which is not sorted) is clicked to be sorted in modal dialog - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. - * Use ui.columnKey to get the column key */ modalDialogSortClick?: ModalDialogSortClickEvent; /** * Event fired when button Apply in modal dialog is clicked - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. - * Use ui.columnsToSort to get array of columns which should be sorted - array of objects of sort order - Asc/Desc and columnIdentifier */ modalDialogButtonApplyClick?: ModalDialogButtonApplyClickEvent; /** * Event fired when the button to reset sorting is clicked. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. */ modalDialogButtonResetClick?: ModalDialogButtonResetClickEvent; @@ -77149,24 +88392,12 @@ interface JQuery { /** * Event fired before sorting is invoked for a certain column. * Return false in order to cancel column sorting. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSorting. - * Use ui.owner.grid to get reference to grid. - * Use ui.columnKey to get column key. - * Use ui.direction to get sorting direction. - * Use ui.newExpressions to get sorting expressions. */ igTreeGridSorting(optionLiteral: 'option', optionName: "columnSorting"): ColumnSortingEvent; /** * Event fired before sorting is invoked for a certain column. * Return false in order to cancel column sorting. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSorting. - * Use ui.owner.grid to get reference to grid. - * Use ui.columnKey to get column key. - * Use ui.direction to get sorting direction. - * Use ui.newExpressions to get sorting expressions. * * @optionValue Define event handler function. */ @@ -77174,23 +88405,11 @@ interface JQuery { /** * Event fired after the column has already been sorted and data - re-rendered. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSorting. - * Use ui.owner.grid to get reference to grid. - * Use ui.columnKey to get column key. - * Use ui.direction to get sorting direction. - * Use ui.expressions to get sorted expressions. */ igTreeGridSorting(optionLiteral: 'option', optionName: "columnSorted"): ColumnSortedEvent; /** * Event fired after the column has already been sorted and data - re-rendered. - * Function takes arguments evt and ui. - * Use ui.owner to get reference to GridSorting. - * Use ui.owner.grid to get reference to grid. - * Use ui.columnKey to get column key. - * Use ui.direction to get sorting direction. - * Use ui.expressions to get sorted expressions. * * @optionValue Define event handler function. */ @@ -77198,19 +88417,11 @@ interface JQuery { /** * Event fired before the modal dialog is opened. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the modal dialog element. This is a jQuery object. */ igTreeGridSorting(optionLiteral: 'option', optionName: "modalDialogOpening"): ModalDialogOpeningEvent; /** * Event fired before the modal dialog is opened. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.columnChooserElement to get a reference to the modal dialog element. This is a jQuery object. * * @optionValue Define event handler function. */ @@ -77218,19 +88429,11 @@ interface JQuery { /** * Event fired after the modal dialog is already opened. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. */ igTreeGridSorting(optionLiteral: 'option', optionName: "modalDialogOpened"): ModalDialogOpenedEvent; /** * Event fired after the modal dialog is already opened. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. * * @optionValue Define event handler function. */ @@ -77238,23 +88441,11 @@ interface JQuery { /** * Event fired every time the modal dialog changes its position. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. - * Use ui.originalPosition to get the original position of the modal dialog div as { top, left } object, relative to the page. - * Use ui.position to get the current position of the modal dialog div as { top, left } object, relative to the page. */ igTreeGridSorting(optionLiteral: 'option', optionName: "modalDialogMoving"): ModalDialogMovingEvent; /** * Event fired every time the modal dialog changes its position. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. - * Use ui.originalPosition to get the original position of the modal dialog div as { top, left } object, relative to the page. - * Use ui.position to get the current position of the modal dialog div as { top, left } object, relative to the page. * * @optionValue Define event handler function. */ @@ -77262,19 +88453,11 @@ interface JQuery { /** * Event fired before the modal dialog is closed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. */ igTreeGridSorting(optionLiteral: 'option', optionName: "modalDialogClosing"): ModalDialogClosingEvent; /** * Event fired before the modal dialog is closed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. * * @optionValue Define event handler function. */ @@ -77282,19 +88465,11 @@ interface JQuery { /** * Event fired after the modal dialog has been closed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. */ igTreeGridSorting(optionLiteral: 'option', optionName: "modalDialogClosed"): ModalDialogClosedEvent; /** * Event fired after the modal dialog has been closed. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. * * @optionValue Define event handler function. */ @@ -77302,19 +88477,11 @@ interface JQuery { /** * Event fired before the contents of the modal dialog are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. */ igTreeGridSorting(optionLiteral: 'option', optionName: "modalDialogContentsRendering"): ModalDialogContentsRenderingEvent; /** * Event fired before the contents of the modal dialog are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. * * @optionValue Define event handler function. */ @@ -77322,19 +88489,11 @@ interface JQuery { /** * Event fired after the contents of the modal dialog are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. */ igTreeGridSorting(optionLiteral: 'option', optionName: "modalDialogContentsRendered"): ModalDialogContentsRenderedEvent; /** * Event fired after the contents of the modal dialog are rendered. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. * * @optionValue Define event handler function. */ @@ -77342,23 +88501,11 @@ interface JQuery { /** * Event fired when sorting of column is changed in modal dialog. Column should be sorted - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. - * Use ui.columnKey to get the column key - * Use ui.isAsc to get whether column should be ascending or not. If true it should be ascending */ igTreeGridSorting(optionLiteral: 'option', optionName: "modalDialogSortingChanged"): ModalDialogSortingChangedEvent; /** * Event fired when sorting of column is changed in modal dialog. Column should be sorted - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. - * Use ui.columnKey to get the column key - * Use ui.isAsc to get whether column should be ascending or not. If true it should be ascending * * @optionValue Define event handler function. */ @@ -77366,21 +88513,11 @@ interface JQuery { /** * Event fired when button to unsort column is clicked in modal dialog - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. - * Use ui.columnKey to get the column key */ igTreeGridSorting(optionLiteral: 'option', optionName: "modalDialogButtonUnsortClick"): ModalDialogButtonUnsortClickEvent; /** * Event fired when button to unsort column is clicked in modal dialog - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. - * Use ui.columnKey to get the column key * * @optionValue Define event handler function. */ @@ -77388,21 +88525,11 @@ interface JQuery { /** * Event fired when column(which is not sorted) is clicked to be sorted in modal dialog - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. - * Use ui.columnKey to get the column key */ igTreeGridSorting(optionLiteral: 'option', optionName: "modalDialogSortClick"): ModalDialogSortClickEvent; /** * Event fired when column(which is not sorted) is clicked to be sorted in modal dialog - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. - * Use ui.columnKey to get the column key * * @optionValue Define event handler function. */ @@ -77410,21 +88537,11 @@ interface JQuery { /** * Event fired when button Apply in modal dialog is clicked - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. - * Use ui.columnsToSort to get array of columns which should be sorted - array of objects of sort order - Asc/Desc and columnIdentifier */ igTreeGridSorting(optionLiteral: 'option', optionName: "modalDialogButtonApplyClick"): ModalDialogButtonApplyClickEvent; /** * Event fired when button Apply in modal dialog is clicked - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. - * Use ui.columnsToSort to get array of columns which should be sorted - array of objects of sort order - Asc/Desc and columnIdentifier * * @optionValue Define event handler function. */ @@ -77432,19 +88549,11 @@ interface JQuery { /** * Event fired when the button to reset sorting is clicked. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. */ igTreeGridSorting(optionLiteral: 'option', optionName: "modalDialogButtonResetClick"): ModalDialogButtonResetClickEvent; /** * Event fired when the button to reset sorting is clicked. - * The handler function takes arguments evt and ui. - * Use ui.owner to get the reference to the GridSorting widget. - * Use ui.owner.grid to get the reference to the grid widget. - * Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. * * @optionValue Define event handler function. */ @@ -77522,49 +88631,21 @@ interface IgTreeGridTooltips { /** * Event fired when the mouse has hovered on an element long enough to display a tooltip - * use args.owner to get a reference to the widget - * use args.tooltip to get or set the string to be displayed - * use args.value to get the value of the cell the tooltip is displayed for - * use args.element to get a reference to the cell the tooltip is displayed for - * use args.index to get the row index of the cell the tooltip is displayed for - * use args.columnKey to get the column key of the cell the tooltip is displayed for - * use args.columnIndex to get the column index of the cell the tooltip is displayed for */ tooltipShowing?: TooltipShowingEvent; /** * Event fired after a tooltip is shown - * use args.owner to get a reference to the widget - * use args.tooltip to get the string displayed in the tooltip - * use args.value to get the value of the cell the tooltip is displayed for - * use args.element to get a reference to the cell the tooltip is displayed for - * use args.index to get the row index of the cell the tooltip is displayed for - * use args.columnKey to get the column key of the cell the tooltip is displayed for - * use args.columnIndex to get the column index of the cell the tooltip is displayed for */ tooltipShown?: TooltipShownEvent; /** * Event fired when the mouse has left an element and the tooltip is about to hide - * use args.owner to get a reference to the widget - * use args.tooltip to get the string displayed in the tooltip - * use args.value to get the value of the cell the tooltip is displayed for - * use args.element to get a reference to the cell the tooltip is displayed for - * use args.index to get the row index of the cell the tooltip is displayed for - * use args.columnKey to get the column key of the cell the tooltip is displayed for - * use args.columnIndex to get the column index of the cell the tooltip is displayed for */ tooltipHiding?: TooltipHidingEvent; /** * Event fired after a tooltip is hidden - * use args.owner to get a reference to the widget - * use args.tooltip to get the string displayed in the tooltip - * use args.value to get the value of the cell the tooltip was displayed for - * use args.element to get a reference to the cell the tooltip was displayed for - * use args.index to get the row index of the cell the tooltip was displayed for - * use args.columnKey to get the column key of the cell the tooltip was displayed for - * use args.columnIndex to get the column index of the cell the tooltip was displayed for */ tooltipHidden?: TooltipHiddenEvent; @@ -77719,25 +88800,11 @@ interface JQuery { /** * Event fired when the mouse has hovered on an element long enough to display a tooltip - * use args.owner to get a reference to the widget - * use args.tooltip to get or set the string to be displayed - * use args.value to get the value of the cell the tooltip is displayed for - * use args.element to get a reference to the cell the tooltip is displayed for - * use args.index to get the row index of the cell the tooltip is displayed for - * use args.columnKey to get the column key of the cell the tooltip is displayed for - * use args.columnIndex to get the column index of the cell the tooltip is displayed for */ igTreeGridTooltips(optionLiteral: 'option', optionName: "tooltipShowing"): TooltipShowingEvent; /** * Event fired when the mouse has hovered on an element long enough to display a tooltip - * use args.owner to get a reference to the widget - * use args.tooltip to get or set the string to be displayed - * use args.value to get the value of the cell the tooltip is displayed for - * use args.element to get a reference to the cell the tooltip is displayed for - * use args.index to get the row index of the cell the tooltip is displayed for - * use args.columnKey to get the column key of the cell the tooltip is displayed for - * use args.columnIndex to get the column index of the cell the tooltip is displayed for * * @optionValue Define event handler function. */ @@ -77745,25 +88812,11 @@ interface JQuery { /** * Event fired after a tooltip is shown - * use args.owner to get a reference to the widget - * use args.tooltip to get the string displayed in the tooltip - * use args.value to get the value of the cell the tooltip is displayed for - * use args.element to get a reference to the cell the tooltip is displayed for - * use args.index to get the row index of the cell the tooltip is displayed for - * use args.columnKey to get the column key of the cell the tooltip is displayed for - * use args.columnIndex to get the column index of the cell the tooltip is displayed for */ igTreeGridTooltips(optionLiteral: 'option', optionName: "tooltipShown"): TooltipShownEvent; /** * Event fired after a tooltip is shown - * use args.owner to get a reference to the widget - * use args.tooltip to get the string displayed in the tooltip - * use args.value to get the value of the cell the tooltip is displayed for - * use args.element to get a reference to the cell the tooltip is displayed for - * use args.index to get the row index of the cell the tooltip is displayed for - * use args.columnKey to get the column key of the cell the tooltip is displayed for - * use args.columnIndex to get the column index of the cell the tooltip is displayed for * * @optionValue Define event handler function. */ @@ -77771,25 +88824,11 @@ interface JQuery { /** * Event fired when the mouse has left an element and the tooltip is about to hide - * use args.owner to get a reference to the widget - * use args.tooltip to get the string displayed in the tooltip - * use args.value to get the value of the cell the tooltip is displayed for - * use args.element to get a reference to the cell the tooltip is displayed for - * use args.index to get the row index of the cell the tooltip is displayed for - * use args.columnKey to get the column key of the cell the tooltip is displayed for - * use args.columnIndex to get the column index of the cell the tooltip is displayed for */ igTreeGridTooltips(optionLiteral: 'option', optionName: "tooltipHiding"): TooltipHidingEvent; /** * Event fired when the mouse has left an element and the tooltip is about to hide - * use args.owner to get a reference to the widget - * use args.tooltip to get the string displayed in the tooltip - * use args.value to get the value of the cell the tooltip is displayed for - * use args.element to get a reference to the cell the tooltip is displayed for - * use args.index to get the row index of the cell the tooltip is displayed for - * use args.columnKey to get the column key of the cell the tooltip is displayed for - * use args.columnIndex to get the column index of the cell the tooltip is displayed for * * @optionValue Define event handler function. */ @@ -77797,25 +88836,11 @@ interface JQuery { /** * Event fired after a tooltip is hidden - * use args.owner to get a reference to the widget - * use args.tooltip to get the string displayed in the tooltip - * use args.value to get the value of the cell the tooltip was displayed for - * use args.element to get a reference to the cell the tooltip was displayed for - * use args.index to get the row index of the cell the tooltip was displayed for - * use args.columnKey to get the column key of the cell the tooltip was displayed for - * use args.columnIndex to get the column index of the cell the tooltip was displayed for */ igTreeGridTooltips(optionLiteral: 'option', optionName: "tooltipHidden"): TooltipHiddenEvent; /** * Event fired after a tooltip is hidden - * use args.owner to get a reference to the widget - * use args.tooltip to get the string displayed in the tooltip - * use args.value to get the value of the cell the tooltip was displayed for - * use args.element to get a reference to the cell the tooltip was displayed for - * use args.index to get the row index of the cell the tooltip was displayed for - * use args.columnKey to get the column key of the cell the tooltip was displayed for - * use args.columnIndex to get the column index of the cell the tooltip was displayed for * * @optionValue Define event handler function. */ @@ -77942,7 +88967,7 @@ interface IgTreeGridUpdating { enableDataDirtyException?: boolean; /** - * Specifies how end-users are able to start edit mode. Possible values: "click", "dblclick", "F2", "enter" and their combinations separated by comma 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. + * Specifies 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. * */ startEditTriggers?: string|Array; @@ -78003,215 +89028,102 @@ interface IgTreeGridUpdating { /** * Event fired before row editing begins. * Return false in order to cancel editing. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.rowAdding to check if the edit mode is for adding a new row. */ editRowStarting?: EditRowStartingEvent; /** * Event fired after row editing begins. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.rowAdding to check if the edit mode is for adding a new row. */ editRowStarted?: EditRowStartedEvent; /** * Event fired before row editing ends. * Return false in order to prevent the grid from exiting edit mode. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.update to check if any of the values is changed which will cause update in the data source. Can be manually set to false to prevent this update. - * Use ui.rowAdding to check if the edit mode is for adding a new row. - * Use ui.values[key] to get or set the new value for the column with the specified key. - * Use ui.oldValues[key] to get the old value for the column with the specified key. */ editRowEnding?: EditRowEndingEvent; /** * Event fired after row editing ends. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.update to check if any of the values is changed which will cause update in the data source. - * Use ui.rowAdding to check if the edit mode is for adding a new row. - * Use ui.values[key] to get the new value for the column with the specified key. - * Use ui.oldValues[key] to get the old value for the column with the specified key. */ editRowEnded?: EditRowEndedEvent; /** * Event fired before cell editing begins (including when row editing opens editing for a cell). * Return false in order to cancel editing. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.columnIndex to get the index of the column. - * Use ui.columnKey to get the key of the column. - * Use ui.editor to get a reference to the editor used for editing the column. - * Use ui.value to get or set the value of the editor. - * Use ui.rowAdding to check if the edit mode is for adding a new row. */ editCellStarting?: EditCellStartingEvent; /** * Event fired after cell editing begins (including when row editing opens editing for a cell). - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.columnIndex to get the index of the column. - * Use ui.columnKey to get the key of the column. - * Use ui.editor to get a reference to the editor used for editing the column. - * Use ui.value to get the value of the editor. - * Use ui.rowAdding to check if the edit mode is for adding a new row. */ editCellStarted?: EditCellStartedEvent; /** * Event fired before cell editing ends (including when row editing closes editing for a cell). * Return false in order to prevent the grid from exiting edit mode (only functions if [editMode](ui.iggridupdating#options:editMode) is 'cell'). - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.columnIndex to get the index of the column. - * Use ui.columnKey to get the key of the column. - * Use ui.editor to get a reference to the editor used for editing the column. - * Use ui.value to get or set the value to be used when updating the data source. - * Use ui.oldValue to get the old value. - * Use ui.update to check if the value is changed which will cause update in the data source. Can be manually set to false to prevent this update. - * Use ui.rowAdding to check if the edit mode is for adding a new row. */ editCellEnding?: EditCellEndingEvent; /** * Event fired after cell editing ends (including when row editing closes editing for a cell). - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.columnIndex to get the index of the column. - * Use ui.columnKey to get the key of the column. - * Use ui.editor to get a reference to the editor used for editing the column. - * Use ui.value to get the new value. - * Use ui.oldValue to get the old value. - * Use ui.update to check if the value is changed which will cause update in the data source. - * Use ui.rowAdding to check if the edit mode is for adding a new row. */ editCellEnded?: EditCellEndedEvent; /** * Event fired before adding a new row. * Return false in order to cancel the adding of the new row to the data source. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.values[key] to get the value for the column with the specified key. - * Use ui.oldValues[key] to get the default value (before editing) for the column with the specified key. */ rowAdding?: RowAddingEvent; /** * Event fired after adding a new row. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.values[key] to get the value for the column with the specified key. - * Use ui.oldValues[key] to get the default value (before editing) for the column with the specified key. */ rowAdded?: RowAddedEvent; /** * Event fired before deleting a row. * Return false in order to cancel the row's deletion. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.element to get a jQuery object containing the TR element of the row to delete. - * Use ui.rowID to get the row's PK value. */ rowDeleting?: RowDeletingEvent; /** * Event fired after a row is deleted. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.element to get a jQuery object containing the TR element of the deleted row. - * Use ui.rowID to get the row's PK value. */ rowDeleted?: RowDeletedEvent; /** * Event fired before the dataDirtyException is thrown. This can be controlled by the [enableDataDirtyException](ui.iggridupdating#options:enableDataDirtyException) property. Any pending changes may be committed in the handler of this event in order to prevent dataDirtyException from being thrown. * Return false in order to prevent the exception. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. */ dataDirty?: DataDirtyEvent; /** * Event fired before editing starts for adding a new row, when Updating generates an automatic primary key for it. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.value to get the auto-generated primary key (the number of records in the data source + 1) or set a custom unique primary key for the new row. */ generatePrimaryKeyValue?: GeneratePrimaryKeyValueEvent; /** * Event fired before the row edit dialog is opened. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.dialogElement to get reference to row edit dialog DOM element. */ rowEditDialogBeforeOpen?: RowEditDialogBeforeOpenEvent; /** * Event fired after the row edit dialog is opened. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.dialogElement to get reference to row edit dialog DOM element. */ rowEditDialogAfterOpen?: RowEditDialogAfterOpenEvent; /** * Event fired before the row edit dialog is closed. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.dialogElement to get reference to row edit dialog DOM element. */ rowEditDialogBeforeClose?: RowEditDialogBeforeCloseEvent; /** * Event fired after the row edit dialog is closed. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.dialogElement to get reference to row edit dialog DOM element. */ rowEditDialogAfterClose?: RowEditDialogAfterCloseEvent; /** * Event fired after the row edit dialog is rendered. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.dialogElement to get reference to row edit dialog DOM element. */ rowEditDialogContentsRendered?: RowEditDialogContentsRenderedEvent; @@ -78621,13 +89533,13 @@ interface JQuery { igTreeGridUpdating(optionLiteral: 'option', optionName: "enableDataDirtyException", optionValue: boolean): void; /** - * Gets how end-users are able to start edit mode. Possible values: "click", "dblclick", "F2", "enter" and their combinations separated by comma 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. + * 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; /** - * Sets how end-users are able to start edit mode. Possible values: "click", "dblclick", "F2", "enter" and their combinations separated by comma 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. + * Sets 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. * * * @optionValue New value to be set. @@ -78761,22 +89673,12 @@ interface JQuery { /** * Event fired before row editing begins. * Return false in order to cancel editing. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.rowAdding to check if the edit mode is for adding a new row. */ igTreeGridUpdating(optionLiteral: 'option', optionName: "editRowStarting"): EditRowStartingEvent; /** * Event fired before row editing begins. * Return false in order to cancel editing. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.rowAdding to check if the edit mode is for adding a new row. * * @optionValue Define event handler function. */ @@ -78784,21 +89686,11 @@ interface JQuery { /** * Event fired after row editing begins. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.rowAdding to check if the edit mode is for adding a new row. */ igTreeGridUpdating(optionLiteral: 'option', optionName: "editRowStarted"): EditRowStartedEvent; /** * Event fired after row editing begins. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.rowAdding to check if the edit mode is for adding a new row. * * @optionValue Define event handler function. */ @@ -78807,28 +89699,12 @@ interface JQuery { /** * Event fired before row editing ends. * Return false in order to prevent the grid from exiting edit mode. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.update to check if any of the values is changed which will cause update in the data source. Can be manually set to false to prevent this update. - * Use ui.rowAdding to check if the edit mode is for adding a new row. - * Use ui.values[key] to get or set the new value for the column with the specified key. - * Use ui.oldValues[key] to get the old value for the column with the specified key. */ igTreeGridUpdating(optionLiteral: 'option', optionName: "editRowEnding"): EditRowEndingEvent; /** * Event fired before row editing ends. * Return false in order to prevent the grid from exiting edit mode. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.update to check if any of the values is changed which will cause update in the data source. Can be manually set to false to prevent this update. - * Use ui.rowAdding to check if the edit mode is for adding a new row. - * Use ui.values[key] to get or set the new value for the column with the specified key. - * Use ui.oldValues[key] to get the old value for the column with the specified key. * * @optionValue Define event handler function. */ @@ -78836,27 +89712,11 @@ interface JQuery { /** * Event fired after row editing ends. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.update to check if any of the values is changed which will cause update in the data source. - * Use ui.rowAdding to check if the edit mode is for adding a new row. - * Use ui.values[key] to get the new value for the column with the specified key. - * Use ui.oldValues[key] to get the old value for the column with the specified key. */ igTreeGridUpdating(optionLiteral: 'option', optionName: "editRowEnded"): EditRowEndedEvent; /** * Event fired after row editing ends. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.update to check if any of the values is changed which will cause update in the data source. - * Use ui.rowAdding to check if the edit mode is for adding a new row. - * Use ui.values[key] to get the new value for the column with the specified key. - * Use ui.oldValues[key] to get the old value for the column with the specified key. * * @optionValue Define event handler function. */ @@ -78865,30 +89725,12 @@ interface JQuery { /** * Event fired before cell editing begins (including when row editing opens editing for a cell). * Return false in order to cancel editing. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.columnIndex to get the index of the column. - * Use ui.columnKey to get the key of the column. - * Use ui.editor to get a reference to the editor used for editing the column. - * Use ui.value to get or set the value of the editor. - * Use ui.rowAdding to check if the edit mode is for adding a new row. */ igTreeGridUpdating(optionLiteral: 'option', optionName: "editCellStarting"): EditCellStartingEvent; /** * Event fired before cell editing begins (including when row editing opens editing for a cell). * Return false in order to cancel editing. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.columnIndex to get the index of the column. - * Use ui.columnKey to get the key of the column. - * Use ui.editor to get a reference to the editor used for editing the column. - * Use ui.value to get or set the value of the editor. - * Use ui.rowAdding to check if the edit mode is for adding a new row. * * @optionValue Define event handler function. */ @@ -78896,29 +89738,11 @@ interface JQuery { /** * Event fired after cell editing begins (including when row editing opens editing for a cell). - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.columnIndex to get the index of the column. - * Use ui.columnKey to get the key of the column. - * Use ui.editor to get a reference to the editor used for editing the column. - * Use ui.value to get the value of the editor. - * Use ui.rowAdding to check if the edit mode is for adding a new row. */ igTreeGridUpdating(optionLiteral: 'option', optionName: "editCellStarted"): EditCellStartedEvent; /** * Event fired after cell editing begins (including when row editing opens editing for a cell). - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.columnIndex to get the index of the column. - * Use ui.columnKey to get the key of the column. - * Use ui.editor to get a reference to the editor used for editing the column. - * Use ui.value to get the value of the editor. - * Use ui.rowAdding to check if the edit mode is for adding a new row. * * @optionValue Define event handler function. */ @@ -78927,34 +89751,12 @@ interface JQuery { /** * Event fired before cell editing ends (including when row editing closes editing for a cell). * Return false in order to prevent the grid from exiting edit mode (only functions if [editMode](ui.iggridupdating#options:editMode) is 'cell'). - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.columnIndex to get the index of the column. - * Use ui.columnKey to get the key of the column. - * Use ui.editor to get a reference to the editor used for editing the column. - * Use ui.value to get or set the value to be used when updating the data source. - * Use ui.oldValue to get the old value. - * Use ui.update to check if the value is changed which will cause update in the data source. Can be manually set to false to prevent this update. - * Use ui.rowAdding to check if the edit mode is for adding a new row. */ igTreeGridUpdating(optionLiteral: 'option', optionName: "editCellEnding"): EditCellEndingEvent; /** * Event fired before cell editing ends (including when row editing closes editing for a cell). * Return false in order to prevent the grid from exiting edit mode (only functions if [editMode](ui.iggridupdating#options:editMode) is 'cell'). - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.columnIndex to get the index of the column. - * Use ui.columnKey to get the key of the column. - * Use ui.editor to get a reference to the editor used for editing the column. - * Use ui.value to get or set the value to be used when updating the data source. - * Use ui.oldValue to get the old value. - * Use ui.update to check if the value is changed which will cause update in the data source. Can be manually set to false to prevent this update. - * Use ui.rowAdding to check if the edit mode is for adding a new row. * * @optionValue Define event handler function. */ @@ -78962,33 +89764,11 @@ interface JQuery { /** * Event fired after cell editing ends (including when row editing closes editing for a cell). - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.columnIndex to get the index of the column. - * Use ui.columnKey to get the key of the column. - * Use ui.editor to get a reference to the editor used for editing the column. - * Use ui.value to get the new value. - * Use ui.oldValue to get the old value. - * Use ui.update to check if the value is changed which will cause update in the data source. - * Use ui.rowAdding to check if the edit mode is for adding a new row. */ igTreeGridUpdating(optionLiteral: 'option', optionName: "editCellEnded"): EditCellEndedEvent; /** * Event fired after cell editing ends (including when row editing closes editing for a cell). - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.rowID to get the row's PK value. - * Use ui.columnIndex to get the index of the column. - * Use ui.columnKey to get the key of the column. - * Use ui.editor to get a reference to the editor used for editing the column. - * Use ui.value to get the new value. - * Use ui.oldValue to get the old value. - * Use ui.update to check if the value is changed which will cause update in the data source. - * Use ui.rowAdding to check if the edit mode is for adding a new row. * * @optionValue Define event handler function. */ @@ -78997,22 +89777,12 @@ interface JQuery { /** * Event fired before adding a new row. * Return false in order to cancel the adding of the new row to the data source. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.values[key] to get the value for the column with the specified key. - * Use ui.oldValues[key] to get the default value (before editing) for the column with the specified key. */ igTreeGridUpdating(optionLiteral: 'option', optionName: "rowAdding"): RowAddingEvent; /** * Event fired before adding a new row. * Return false in order to cancel the adding of the new row to the data source. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.values[key] to get the value for the column with the specified key. - * Use ui.oldValues[key] to get the default value (before editing) for the column with the specified key. * * @optionValue Define event handler function. */ @@ -79020,21 +89790,11 @@ interface JQuery { /** * Event fired after adding a new row. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.values[key] to get the value for the column with the specified key. - * Use ui.oldValues[key] to get the default value (before editing) for the column with the specified key. */ igTreeGridUpdating(optionLiteral: 'option', optionName: "rowAdded"): RowAddedEvent; /** * Event fired after adding a new row. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.values[key] to get the value for the column with the specified key. - * Use ui.oldValues[key] to get the default value (before editing) for the column with the specified key. * * @optionValue Define event handler function. */ @@ -79043,22 +89803,12 @@ interface JQuery { /** * Event fired before deleting a row. * Return false in order to cancel the row's deletion. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.element to get a jQuery object containing the TR element of the row to delete. - * Use ui.rowID to get the row's PK value. */ igTreeGridUpdating(optionLiteral: 'option', optionName: "rowDeleting"): RowDeletingEvent; /** * Event fired before deleting a row. * Return false in order to cancel the row's deletion. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.element to get a jQuery object containing the TR element of the row to delete. - * Use ui.rowID to get the row's PK value. * * @optionValue Define event handler function. */ @@ -79066,21 +89816,11 @@ interface JQuery { /** * Event fired after a row is deleted. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.element to get a jQuery object containing the TR element of the deleted row. - * Use ui.rowID to get the row's PK value. */ igTreeGridUpdating(optionLiteral: 'option', optionName: "rowDeleted"): RowDeletedEvent; /** * Event fired after a row is deleted. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.element to get a jQuery object containing the TR element of the deleted row. - * Use ui.rowID to get the row's PK value. * * @optionValue Define event handler function. */ @@ -79089,18 +89829,12 @@ interface JQuery { /** * Event fired before the dataDirtyException is thrown. This can be controlled by the [enableDataDirtyException](ui.iggridupdating#options:enableDataDirtyException) property. Any pending changes may be committed in the handler of this event in order to prevent dataDirtyException from being thrown. * Return false in order to prevent the exception. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. */ igTreeGridUpdating(optionLiteral: 'option', optionName: "dataDirty"): DataDirtyEvent; /** * Event fired before the dataDirtyException is thrown. This can be controlled by the [enableDataDirtyException](ui.iggridupdating#options:enableDataDirtyException) property. Any pending changes may be committed in the handler of this event in order to prevent dataDirtyException from being thrown. * Return false in order to prevent the exception. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. * * @optionValue Define event handler function. */ @@ -79108,19 +89842,11 @@ interface JQuery { /** * Event fired before editing starts for adding a new row, when Updating generates an automatic primary key for it. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.value to get the auto-generated primary key (the number of records in the data source + 1) or set a custom unique primary key for the new row. */ igTreeGridUpdating(optionLiteral: 'option', optionName: "generatePrimaryKeyValue"): GeneratePrimaryKeyValueEvent; /** * Event fired before editing starts for adding a new row, when Updating generates an automatic primary key for it. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.value to get the auto-generated primary key (the number of records in the data source + 1) or set a custom unique primary key for the new row. * * @optionValue Define event handler function. */ @@ -79128,19 +89854,11 @@ interface JQuery { /** * Event fired before the row edit dialog is opened. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.dialogElement to get reference to row edit dialog DOM element. */ igTreeGridUpdating(optionLiteral: 'option', optionName: "rowEditDialogBeforeOpen"): RowEditDialogBeforeOpenEvent; /** * Event fired before the row edit dialog is opened. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.dialogElement to get reference to row edit dialog DOM element. * * @optionValue Define event handler function. */ @@ -79148,19 +89866,11 @@ interface JQuery { /** * Event fired after the row edit dialog is opened. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.dialogElement to get reference to row edit dialog DOM element. */ igTreeGridUpdating(optionLiteral: 'option', optionName: "rowEditDialogAfterOpen"): RowEditDialogAfterOpenEvent; /** * Event fired after the row edit dialog is opened. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.dialogElement to get reference to row edit dialog DOM element. * * @optionValue Define event handler function. */ @@ -79168,19 +89878,11 @@ interface JQuery { /** * Event fired before the row edit dialog is closed. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.dialogElement to get reference to row edit dialog DOM element. */ igTreeGridUpdating(optionLiteral: 'option', optionName: "rowEditDialogBeforeClose"): RowEditDialogBeforeCloseEvent; /** * Event fired before the row edit dialog is closed. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.dialogElement to get reference to row edit dialog DOM element. * * @optionValue Define event handler function. */ @@ -79188,19 +89890,11 @@ interface JQuery { /** * Event fired after the row edit dialog is closed. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.dialogElement to get reference to row edit dialog DOM element. */ igTreeGridUpdating(optionLiteral: 'option', optionName: "rowEditDialogAfterClose"): RowEditDialogAfterCloseEvent; /** * Event fired after the row edit dialog is closed. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.dialogElement to get reference to row edit dialog DOM element. * * @optionValue Define event handler function. */ @@ -79208,19 +89902,11 @@ interface JQuery { /** * Event fired after the row edit dialog is rendered. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.dialogElement to get reference to row edit dialog DOM element. */ igTreeGridUpdating(optionLiteral: 'option', optionName: "rowEditDialogContentsRendered"): RowEditDialogContentsRenderedEvent; /** * Event fired after the row edit dialog is rendered. - * Function takes arguments evt and ui. - * Use ui.owner to get a reference to GridUpdating. - * Use ui.owner.grid to get a reference to the grid. - * Use ui.dialogElement to get reference to row edit dialog DOM element. * * @optionValue Define event handler function. */ @@ -79285,10 +89971,6 @@ interface FileSelectingEvent { } interface FileSelectingEventUIParam { - /** - * Used to access the igUpload widget object. - */ - owner?: any; } interface FileSelectedEvent { @@ -79296,20 +89978,6 @@ interface FileSelectedEvent { } interface FileSelectedEventUIParam { - /** - * Used to get unique identifier of the file - */ - fileId?: any; - - /** - * Used to get the name of the uploaded file - */ - filePath?: any; - - /** - * Used to access the igUpload widget object. - */ - owner?: any; } interface FileUploadingEvent { @@ -79317,40 +89985,6 @@ interface FileUploadingEvent { } interface FileUploadingEventUIParam { - /** - * Used to get unique identifier of the file - */ - fileId?: any; - - /** - * Used to get the name of the uploaded file - */ - filePath?: any; - - /** - * Used totalSize to get the file size of the uploaded file - */ - totalSize?: any; - - /** - * Used to get uploaded bytes - */ - uploadedBytes?: any; - - /** - * Used to get current file status - */ - fileStatus?: any; - - /** - * Used to get reference to the fileInfo object - containing information for fileName, fileSize, serverMessage(if returned from server side), etc. - */ - fileInfo?: any; - - /** - * Used to access the igUpload widget object. - */ - owner?: any; } interface FileUploadedEvent { @@ -79358,30 +89992,6 @@ interface FileUploadedEvent { } interface FileUploadedEventUIParam { - /** - * Used to get unique identifier of the file - */ - fileId?: any; - - /** - * Used to get the name of the uploaded file - */ - filePath?: any; - - /** - * Used totalSize to get the file size of the uploaded file - */ - totalSize?: any; - - /** - * Used to get reference to the fileInfo object - containing information for fileName, fileSize, serverMessage(if returned from server side), etc. - */ - fileInfo?: any; - - /** - * Used to access the igUpload widget object. - */ - owner?: any; } interface FileUploadAbortedEvent { @@ -79389,35 +89999,6 @@ interface FileUploadAbortedEvent { } interface FileUploadAbortedEventUIParam { - /** - * Used to get unique identifier of the file - */ - fileId?: any; - - /** - * Used to get the name of the uploaded file - */ - filePath?: any; - - /** - * Used totalSize to get the file size of the uploaded file - */ - totalSize?: any; - - /** - * Used to get uploaded bytes - */ - uploadedBytes?: any; - - /** - * Used to get current file status - */ - fileStatus?: any; - - /** - * Used to access the igUpload widget object. - */ - owner?: any; } interface CancelAllClickedEvent { @@ -79425,10 +90006,6 @@ interface CancelAllClickedEvent { } interface CancelAllClickedEventUIParam { - /** - * Used to access the igUpload widget object. - */ - owner?: any; } interface OnErrorEvent { @@ -79436,35 +90013,6 @@ interface OnErrorEvent { } interface OnErrorEventUIParam { - /** - * Used to get current errorCode - */ - errorCode?: any; - - /** - * Used to get identifier of the file for which the event is fired(after that it can be used API function getFileInfo). NOTE: It is possible to be null in some cases: try to drop multiple files when mode is single , check maximum allowed uploading files fails or check for count of maximum allowed simultaneous files upload fails. - */ - fileId?: any; - - /** - * Used to get detailed error description - */ - errorMessage?: any; - - /** - * Used to get error type - it could be clientside or serverside - */ - errorType?: any; - - /** - * Used to get specific server message returned by server - if errorType is serverside - */ - serverMessage?: any; - - /** - * Used to access the igUpload widget object. - */ - owner?: any; } interface FileExtensionsValidatingEvent { @@ -79472,20 +90020,6 @@ interface FileExtensionsValidatingEvent { } interface FileExtensionsValidatingEventUIParam { - /** - * Used to get the full file name - */ - fileName?: any; - - /** - * Used to get file extension - */ - fileExtension?: any; - - /** - * Used to access the igUpload widget object. - */ - owner?: any; } interface OnXHRLoadEvent { @@ -79493,25 +90027,6 @@ interface OnXHRLoadEvent { } interface OnXHRLoadEventUIParam { - /** - * Used to get unique identifier of the file - */ - fileId?: any; - - /** - * Used to get reference to the original XMLHttpRequest object - */ - xhr?: any; - - /** - * Used to get reference to the fileInfo object - containing information for fileName, fileSize, serverMessage(if returned from the server-side), etc. - */ - fileInfo?: any; - - /** - * Used to access the igUpload widget object. - */ - owner?: any; } interface OnFormDataSubmitEvent { @@ -79519,30 +90034,6 @@ interface OnFormDataSubmitEvent { } interface OnFormDataSubmitEventUIParam { - /** - * Used to get unique identifier of the file - */ - fileId?: any; - - /** - * Used to get reference to the fileInfo object - containing information for the fileName, fileSize, serverMessage, etc. - */ - fileInfo?: any; - - /** - * Used to get reference to the original XMLHttpRequest object(if the browser supports HTML 5 file API - if not it is undefined) - */ - xhr?: any; - - /** - * Used to get reference to FormData object(if the browser supports HTML5 file API) OR reference to jQuery representation of
- */ - formData?: any; - - /** - * Used to access the igUpload widget object. - */ - owner?: any; } interface IgUpload { @@ -79787,104 +90278,53 @@ interface IgUpload { /** * Defines the name of the file upload selecting event. Fired when browse button is pressed. * Return false in order to cancel selecting file. - * Function takes arguments evt and ui. - * Use ui.owner in order to access the igUpload widget object. */ fileSelecting?: FileSelectingEvent; /** * Defines the name of the file upload selected event. Fired when file is selected from browse dialog. * Return false in order to cancel uploading file. - * Function takes arguments evt and ui. - * Use ui.fileId to get unique identifier of the file - * Use ui.filePath to get the name of the uploaded file - * Use ui.owner in order to access the igUpload widget object. */ fileSelected?: FileSelectedEvent; /** * Defines the name of the file uploading event. Fired every time when fileuploader get status for the upload. * Return false in order to cancel uploading file. - * Function takes arguments evt and ui. - * Use ui.fileId to get unique identifier of the file - * Use ui.filePath to get the name of the uploaded file - * Use ui.totalSize to get the file size of the uploaded file - * Use ui.uploadedBytes to get uploaded bytes - * Use ui.fileStatus to get current file status - * Use ui.fileInfo to get reference to the fileInfo object - containing information for fileName, fileSize, serverMessage(if returned from server side), etc. - * Use ui.owner in order to access the igUpload widget object. */ fileUploading?: FileUploadingEvent; /** * Defines the name of the uploaded event. Fired when the file is uploaded - * Function takes arguments evt and ui. - * Use ui.fileId to get unique identifier of the file - * Use ui.filePath to get the name of the uploaded file - * Use ui.totalSize to get the file size of the uploaded file - * Use ui.fileInfo to get reference to the fileInfo object - containing information for fileName, fileSize, serverMessage(if returned from server side), etc. - * Use ui.owner in order to access the igUpload widget object. */ fileUploaded?: FileUploadedEvent; /** * Defines the name of the file upload cancel event. Fired when the server responses that the file is canceled. - * Function takes arguments evt and ui. - * Use ui.fileId to get unique identifier of the file - * Use ui.filePath to get the name of the uploaded file - * Use ui.totalSize to get the file size of the uploaded file - * Use ui.uploadedBytes to get uploaded bytes - * Use ui.fileStatus to get current file status - * Use ui.owner in order to access the igUpload widget object. */ fileUploadAborted?: FileUploadAbortedEvent; /** * Defines the name of the cancel all button event click. Fired when cancel all button in summary is clicked. Fired only in multiple upload mode. - * Function takes arguments evt and ui. - * Use ui.owner in order to access the igUpload widget object. */ cancelAllClicked?: CancelAllClickedEvent; /** * Defines the name of the file upload error event. Fired when error is occurred. - * Function takes arguments evt and ui. - * Use ui.errorCode to get current errorCode - * Use ui.fileId to get identifier of the file for which the event is fired(after that it can be used API function getFileInfo). NOTE: It is possible to be null in some cases: try to drop multiple files when mode is single , check maximum allowed uploading files fails or check for count of maximum allowed simultaneous files upload fails. - * Use ui.errorMessage to get detailed error description - * Use ui.errorType to get error type - it could be clientside or serverside - * Use ui.serverMessage to get specific server message returned by server - if errorType is serverside - * Use ui.owner in order to access the igUpload widget object. */ onError?: OnErrorEvent; /** * It is fired when validating file extensions - * Function takes arguments evt and ui. - * Use ui.fileName to get the full file name - * Use ui.fileExtension to get file extension - * Use ui.owner in order to access the igUpload widget object. */ fileExtensionsValidating?: FileExtensionsValidatingEvent; /** * It is fired when event onload(of XmlHttpRequest) is fired. This event will be fired only if the browser supports HTML5 file API - * Function takes arguments evt and ui. - * Use ui.fileId to get unique identifier of the file - * Use ui.xhr to get reference to the original XMLHttpRequest object - * Use ui.fileInfo to get reference to the fileInfo object - containing information for fileName, fileSize, serverMessage(if returned from the server-side), etc. - * Use ui.owner in order to access the igUpload widget object. */ onXHRLoad?: OnXHRLoadEvent; /** * It is fired before submitting to the server the uploading file(and its additional data if any). It could be used to append additional data fields to the FormData object(if the browser supports HTML5 file API - like newest Chrome, Firefox, IE11+). If the browser does not support HTML5 file API(IE10 and older) it could be added these data fields(as hidden input fields) to the form. Use the public API function addDataFields. - * Function takes arguments evt and ui. - * Use ui.fileId to get unique identifier of the file - * Use ui.fileInfo to get reference to the fileInfo object - containing information for the fileName, fileSize, serverMessage, etc. - * Use ui.xhr to get reference to the original XMLHttpRequest object(if the browser supports HTML 5 file API - if not it is undefined) - * Use ui.formData to get reference to FormData object(if the browser supports HTML5 file API) OR reference to jQuery representation of - * Use ui.owner in order to access the igUpload widget object. */ onFormDataSubmit?: OnFormDataSubmitEvent; @@ -80576,16 +91016,12 @@ interface JQuery { /** * Defines the name of the file upload selecting event. Fired when browse button is pressed. * Return false in order to cancel selecting file. - * Function takes arguments evt and ui. - * Use ui.owner in order to access the igUpload widget object. */ igUpload(optionLiteral: 'option', optionName: "fileSelecting"): FileSelectingEvent; /** * Defines the name of the file upload selecting event. Fired when browse button is pressed. * Return false in order to cancel selecting file. - * Function takes arguments evt and ui. - * Use ui.owner in order to access the igUpload widget object. * * @optionValue New value to be set. */ @@ -80594,20 +91030,12 @@ interface JQuery { /** * Defines the name of the file upload selected event. Fired when file is selected from browse dialog. * Return false in order to cancel uploading file. - * Function takes arguments evt and ui. - * Use ui.fileId to get unique identifier of the file - * Use ui.filePath to get the name of the uploaded file - * Use ui.owner in order to access the igUpload widget object. */ igUpload(optionLiteral: 'option', optionName: "fileSelected"): FileSelectedEvent; /** * Defines the name of the file upload selected event. Fired when file is selected from browse dialog. * Return false in order to cancel uploading file. - * Function takes arguments evt and ui. - * Use ui.fileId to get unique identifier of the file - * Use ui.filePath to get the name of the uploaded file - * Use ui.owner in order to access the igUpload widget object. * * @optionValue New value to be set. */ @@ -80616,28 +91044,12 @@ interface JQuery { /** * Defines the name of the file uploading event. Fired every time when fileuploader get status for the upload. * Return false in order to cancel uploading file. - * Function takes arguments evt and ui. - * Use ui.fileId to get unique identifier of the file - * Use ui.filePath to get the name of the uploaded file - * Use ui.totalSize to get the file size of the uploaded file - * Use ui.uploadedBytes to get uploaded bytes - * Use ui.fileStatus to get current file status - * Use ui.fileInfo to get reference to the fileInfo object - containing information for fileName, fileSize, serverMessage(if returned from server side), etc. - * Use ui.owner in order to access the igUpload widget object. */ igUpload(optionLiteral: 'option', optionName: "fileUploading"): FileUploadingEvent; /** * Defines the name of the file uploading event. Fired every time when fileuploader get status for the upload. * Return false in order to cancel uploading file. - * Function takes arguments evt and ui. - * Use ui.fileId to get unique identifier of the file - * Use ui.filePath to get the name of the uploaded file - * Use ui.totalSize to get the file size of the uploaded file - * Use ui.uploadedBytes to get uploaded bytes - * Use ui.fileStatus to get current file status - * Use ui.fileInfo to get reference to the fileInfo object - containing information for fileName, fileSize, serverMessage(if returned from server side), etc. - * Use ui.owner in order to access the igUpload widget object. * * @optionValue New value to be set. */ @@ -80645,23 +91057,11 @@ interface JQuery { /** * Defines the name of the uploaded event. Fired when the file is uploaded - * Function takes arguments evt and ui. - * Use ui.fileId to get unique identifier of the file - * Use ui.filePath to get the name of the uploaded file - * Use ui.totalSize to get the file size of the uploaded file - * Use ui.fileInfo to get reference to the fileInfo object - containing information for fileName, fileSize, serverMessage(if returned from server side), etc. - * Use ui.owner in order to access the igUpload widget object. */ igUpload(optionLiteral: 'option', optionName: "fileUploaded"): FileUploadedEvent; /** * Defines the name of the uploaded event. Fired when the file is uploaded - * Function takes arguments evt and ui. - * Use ui.fileId to get unique identifier of the file - * Use ui.filePath to get the name of the uploaded file - * Use ui.totalSize to get the file size of the uploaded file - * Use ui.fileInfo to get reference to the fileInfo object - containing information for fileName, fileSize, serverMessage(if returned from server side), etc. - * Use ui.owner in order to access the igUpload widget object. * * @optionValue New value to be set. */ @@ -80669,25 +91069,11 @@ interface JQuery { /** * Defines the name of the file upload cancel event. Fired when the server responses that the file is canceled. - * Function takes arguments evt and ui. - * Use ui.fileId to get unique identifier of the file - * Use ui.filePath to get the name of the uploaded file - * Use ui.totalSize to get the file size of the uploaded file - * Use ui.uploadedBytes to get uploaded bytes - * Use ui.fileStatus to get current file status - * Use ui.owner in order to access the igUpload widget object. */ igUpload(optionLiteral: 'option', optionName: "fileUploadAborted"): FileUploadAbortedEvent; /** * Defines the name of the file upload cancel event. Fired when the server responses that the file is canceled. - * Function takes arguments evt and ui. - * Use ui.fileId to get unique identifier of the file - * Use ui.filePath to get the name of the uploaded file - * Use ui.totalSize to get the file size of the uploaded file - * Use ui.uploadedBytes to get uploaded bytes - * Use ui.fileStatus to get current file status - * Use ui.owner in order to access the igUpload widget object. * * @optionValue New value to be set. */ @@ -80695,15 +91081,11 @@ interface JQuery { /** * Defines the name of the cancel all button event click. Fired when cancel all button in summary is clicked. Fired only in multiple upload mode. - * Function takes arguments evt and ui. - * Use ui.owner in order to access the igUpload widget object. */ igUpload(optionLiteral: 'option', optionName: "cancelAllClicked"): CancelAllClickedEvent; /** * Defines the name of the cancel all button event click. Fired when cancel all button in summary is clicked. Fired only in multiple upload mode. - * Function takes arguments evt and ui. - * Use ui.owner in order to access the igUpload widget object. * * @optionValue New value to be set. */ @@ -80711,25 +91093,11 @@ interface JQuery { /** * Defines the name of the file upload error event. Fired when error is occurred. - * Function takes arguments evt and ui. - * Use ui.errorCode to get current errorCode - * Use ui.fileId to get identifier of the file for which the event is fired(after that it can be used API function getFileInfo). NOTE: It is possible to be null in some cases: try to drop multiple files when mode is single , check maximum allowed uploading files fails or check for count of maximum allowed simultaneous files upload fails. - * Use ui.errorMessage to get detailed error description - * Use ui.errorType to get error type - it could be clientside or serverside - * Use ui.serverMessage to get specific server message returned by server - if errorType is serverside - * Use ui.owner in order to access the igUpload widget object. */ igUpload(optionLiteral: 'option', optionName: "onError"): OnErrorEvent; /** * Defines the name of the file upload error event. Fired when error is occurred. - * Function takes arguments evt and ui. - * Use ui.errorCode to get current errorCode - * Use ui.fileId to get identifier of the file for which the event is fired(after that it can be used API function getFileInfo). NOTE: It is possible to be null in some cases: try to drop multiple files when mode is single , check maximum allowed uploading files fails or check for count of maximum allowed simultaneous files upload fails. - * Use ui.errorMessage to get detailed error description - * Use ui.errorType to get error type - it could be clientside or serverside - * Use ui.serverMessage to get specific server message returned by server - if errorType is serverside - * Use ui.owner in order to access the igUpload widget object. * * @optionValue New value to be set. */ @@ -80737,19 +91105,11 @@ interface JQuery { /** * It is fired when validating file extensions - * Function takes arguments evt and ui. - * Use ui.fileName to get the full file name - * Use ui.fileExtension to get file extension - * Use ui.owner in order to access the igUpload widget object. */ igUpload(optionLiteral: 'option', optionName: "fileExtensionsValidating"): FileExtensionsValidatingEvent; /** * It is fired when validating file extensions - * Function takes arguments evt and ui. - * Use ui.fileName to get the full file name - * Use ui.fileExtension to get file extension - * Use ui.owner in order to access the igUpload widget object. * * @optionValue New value to be set. */ @@ -80757,21 +91117,11 @@ interface JQuery { /** * It is fired when event onload(of XmlHttpRequest) is fired. This event will be fired only if the browser supports HTML5 file API - * Function takes arguments evt and ui. - * Use ui.fileId to get unique identifier of the file - * Use ui.xhr to get reference to the original XMLHttpRequest object - * Use ui.fileInfo to get reference to the fileInfo object - containing information for fileName, fileSize, serverMessage(if returned from the server-side), etc. - * Use ui.owner in order to access the igUpload widget object. */ igUpload(optionLiteral: 'option', optionName: "onXHRLoad"): OnXHRLoadEvent; /** * It is fired when event onload(of XmlHttpRequest) is fired. This event will be fired only if the browser supports HTML5 file API - * Function takes arguments evt and ui. - * Use ui.fileId to get unique identifier of the file - * Use ui.xhr to get reference to the original XMLHttpRequest object - * Use ui.fileInfo to get reference to the fileInfo object - containing information for fileName, fileSize, serverMessage(if returned from the server-side), etc. - * Use ui.owner in order to access the igUpload widget object. * * @optionValue New value to be set. */ @@ -80779,23 +91129,11 @@ interface JQuery { /** * It is fired before submitting to the server the uploading file(and its additional data if any). It could be used to append additional data fields to the FormData object(if the browser supports HTML5 file API - like newest Chrome, Firefox, IE11+). If the browser does not support HTML5 file API(IE10 and older) it could be added these data fields(as hidden input fields) to the form. Use the public API function addDataFields. - * Function takes arguments evt and ui. - * Use ui.fileId to get unique identifier of the file - * Use ui.fileInfo to get reference to the fileInfo object - containing information for the fileName, fileSize, serverMessage, etc. - * Use ui.xhr to get reference to the original XMLHttpRequest object(if the browser supports HTML 5 file API - if not it is undefined) - * Use ui.formData to get reference to FormData object(if the browser supports HTML5 file API) OR reference to jQuery representation of - * Use ui.owner in order to access the igUpload widget object. */ igUpload(optionLiteral: 'option', optionName: "onFormDataSubmit"): OnFormDataSubmitEvent; /** * It is fired before submitting to the server the uploading file(and its additional data if any). It could be used to append additional data fields to the FormData object(if the browser supports HTML5 file API - like newest Chrome, Firefox, IE11+). If the browser does not support HTML5 file API(IE10 and older) it could be added these data fields(as hidden input fields) to the form. Use the public API function addDataFields. - * Function takes arguments evt and ui. - * Use ui.fileId to get unique identifier of the file - * Use ui.fileInfo to get reference to the fileInfo object - containing information for the fileName, fileSize, serverMessage, etc. - * Use ui.xhr to get reference to the original XMLHttpRequest object(if the browser supports HTML 5 file API - if not it is undefined) - * Use ui.formData to get reference to FormData object(if the browser supports HTML5 file API) OR reference to jQuery representation of - * Use ui.owner in order to access the igUpload widget object. * * @optionValue New value to be set. */ @@ -81594,368 +91932,368 @@ interface JQuery { } declare namespace Infragistics { - class IgValidatorBaseRule { - constructor(name: string); - constructor(formatItems: any[]); +class IgValidatorBaseRule { + constructor(name: string); + constructor(formatItems: any[]); - /** - * Gets the error message type to get from locale settings (matching as "Message>"). Returns the rule name by default. - * Only used when there's no errorMessage option available through getRuleMessage. - * - * @param options - */ - getMessageType(options: Object): string; + /** + * Gets the error message type to get from locale settings (matching as "Message>"). Returns the rule name by default. + * Only used when there's no errorMessage option available through getRuleMessage. + * + * @param options + */ + getMessageType(options: Object): string; - /** - * Gets an errorMessage from either the rule or field/global options. - * - * @param options - */ - getRuleMessage(options: Object): string; + /** + * Gets an errorMessage from either the rule or field/global options. + * + * @param options + */ + getRuleMessage(options: Object): string; - /** - * Formats an error message using rule-specific values (usually from formatItems). - * - * @param message The unformatted error message the validator intends to display. - */ - formatMessage(message: string): string; + /** + * Formats an error message using rule-specific values (usually from formatItems). + * + * @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. - */ - isValid(options: Object, value: Object): boolean; - } + /** + * 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. + */ + isValid(options: Object, value: Object): boolean; +} } interface IgniteUIStatic { - IgValidatorBaseRule: typeof Infragistics.IgValidatorBaseRule; +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; +class IgValidatorRequiredRule { + constructor(name: string); + constructor(groupTypes: any[]); + constructor(groupMessageName: string); + constructor(formatItems: any[]); + getMessageType(options: Object): void; + isValid(options: Object, value: Object): void; - /** - * Gets an errorMessage from either the rule or field/global options. - * - * @param options - */ - getRuleMessage(options: Object): string; + /** + * Gets an errorMessage from either the rule or field/global options. + * + * @param options + */ + getRuleMessage(options: Object): string; - /** - * Formats an error message using rule-specific values (usually from formatItems). - * - * @param message The unformatted error message the validator intends to display. - */ - formatMessage(message: string): string; - } + /** + * Formats an error message using rule-specific values (usually from formatItems). + * + * @param message The unformatted error message the validator intends to display. + */ + formatMessage(message: string): string; +} } interface IgniteUIStatic { - IgValidatorRequiredRule: typeof Infragistics.IgValidatorRequiredRule; +IgValidatorRequiredRule: typeof Infragistics.IgValidatorRequiredRule; } declare namespace Infragistics { - class IgValidatorControlRule { - constructor(name: string); - constructor(formatItems: any[]); - getMessageType(): void; +class IgValidatorControlRule { + constructor(name: string); + constructor(formatItems: any[]); + getMessageType(): void; - /** - * Returns an error message for the rule from options - * - * @param options - */ - getRuleMessage(options: Object): void; - isValid(options: Object): void; + /** + * Returns an error message for the rule from options + * + * @param options + */ + getRuleMessage(options: Object): void; + isValid(options: Object): void; - /** - * Formats an error message using rule-specific values (usually from formatItems). - * - * @param message The unformatted error message the validator intends to display. - */ - formatMessage(message: string): string; - } + /** + * Formats an error message using rule-specific values (usually from formatItems). + * + * @param message The unformatted error message the validator intends to display. + */ + formatMessage(message: string): string; +} } interface IgniteUIStatic { - IgValidatorControlRule: typeof Infragistics.IgValidatorControlRule; +IgValidatorControlRule: typeof Infragistics.IgValidatorControlRule; } declare namespace Infragistics { - class IgValidatorNumberRule { - constructor(name: string); - constructor(formatItems: any[]); - isValid(options: Object, value: Object): void; +class IgValidatorNumberRule { + constructor(name: string); + constructor(formatItems: any[]); + isValid(options: Object, value: Object): void; - /** - * Gets the error message type to get from locale settings (matching as "Message>"). Returns the rule name by default. - * Only used when there's no errorMessage option available through getRuleMessage. - * - * @param options - */ - getMessageType(options: Object): string; + /** + * Gets the error message type to get from locale settings (matching as "Message>"). Returns the rule name by default. + * Only used when there's no errorMessage option available through getRuleMessage. + * + * @param options + */ + getMessageType(options: Object): string; - /** - * Gets an errorMessage from either the rule or field/global options. - * - * @param options - */ - getRuleMessage(options: Object): string; + /** + * Gets an errorMessage from either the rule or field/global options. + * + * @param options + */ + getRuleMessage(options: Object): string; - /** - * Formats an error message using rule-specific values (usually from formatItems). - * - * @param message The unformatted error message the validator intends to display. - */ - formatMessage(message: string): string; - } + /** + * Formats an error message using rule-specific values (usually from formatItems). + * + * @param message The unformatted error message the validator intends to display. + */ + formatMessage(message: string): string; +} } interface IgniteUIStatic { - IgValidatorNumberRule: typeof Infragistics.IgValidatorNumberRule; +IgValidatorNumberRule: typeof Infragistics.IgValidatorNumberRule; } declare namespace Infragistics { - class IgValidatorDateRule { - constructor(name: string); - constructor(formatItems: any[]); - isValid(options: Object, value: Object): void; +class IgValidatorDateRule { + constructor(name: string); + constructor(formatItems: any[]); + isValid(options: Object, value: Object): void; - /** - * Gets the error message type to get from locale settings (matching as "Message>"). Returns the rule name by default. - * Only used when there's no errorMessage option available through getRuleMessage. - * - * @param options - */ - getMessageType(options: Object): string; + /** + * Gets the error message type to get from locale settings (matching as "Message>"). Returns the rule name by default. + * Only used when there's no errorMessage option available through getRuleMessage. + * + * @param options + */ + getMessageType(options: Object): string; - /** - * Gets an errorMessage from either the rule or field/global options. - * - * @param options - */ - getRuleMessage(options: Object): string; + /** + * Gets an errorMessage from either the rule or field/global options. + * + * @param options + */ + getRuleMessage(options: Object): string; - /** - * Formats an error message using rule-specific values (usually from formatItems). - * - * @param message The unformatted error message the validator intends to display. - */ - formatMessage(message: string): string; - } + /** + * Formats an error message using rule-specific values (usually from formatItems). + * + * @param message The unformatted error message the validator intends to display. + */ + formatMessage(message: string): string; +} } interface IgniteUIStatic { - IgValidatorDateRule: typeof Infragistics.IgValidatorDateRule; +IgValidatorDateRule: typeof Infragistics.IgValidatorDateRule; } declare namespace Infragistics { - class IgValidatorLengthRule { - constructor(name: string); - constructor(formatItems: any[]); - getMessageType(): void; - isValid(options: Object, value: Object): void; +class IgValidatorLengthRule { + constructor(name: string); + constructor(formatItems: any[]); + getMessageType(): void; + isValid(options: Object, value: Object): void; - /** - * Gets an errorMessage from either the rule or field/global options. - * - * @param options - */ - getRuleMessage(options: Object): string; + /** + * Gets an errorMessage from either the rule or field/global options. + * + * @param options + */ + getRuleMessage(options: Object): string; - /** - * Formats an error message using rule-specific values (usually from formatItems). - * - * @param message The unformatted error message the validator intends to display. - */ - formatMessage(message: string): string; - } + /** + * Formats an error message using rule-specific values (usually from formatItems). + * + * @param message The unformatted error message the validator intends to display. + */ + formatMessage(message: string): string; +} } interface IgniteUIStatic { - IgValidatorLengthRule: typeof Infragistics.IgValidatorLengthRule; +IgValidatorLengthRule: typeof Infragistics.IgValidatorLengthRule; } declare namespace Infragistics { - class IgValidatorValueRule { - constructor(name: string); - constructor(formatItems: any[]); - getMessageType(): void; - isValid(options: Object, value: Object): void; - } +class IgValidatorValueRule { + constructor(name: string); + constructor(formatItems: any[]); + getMessageType(): void; + isValid(options: Object, value: Object): void; +} } interface IgniteUIStatic { - IgValidatorValueRule: typeof Infragistics.IgValidatorValueRule; +IgValidatorValueRule: typeof Infragistics.IgValidatorValueRule; } declare namespace Infragistics { - class IgValidatorEqualToRule { - constructor(name: string); - constructor(formatItems: any[]); - isValid(options: Object, value: Object): void; +class IgValidatorEqualToRule { + constructor(name: string); + constructor(formatItems: any[]); + isValid(options: Object, value: Object): void; - /** - * Gets the error message type to get from locale settings (matching as "Message>"). Returns the rule name by default. - * Only used when there's no errorMessage option available through getRuleMessage. - * - * @param options - */ - getMessageType(options: Object): string; + /** + * Gets the error message type to get from locale settings (matching as "Message>"). Returns the rule name by default. + * Only used when there's no errorMessage option available through getRuleMessage. + * + * @param options + */ + getMessageType(options: Object): string; - /** - * Gets an errorMessage from either the rule or field/global options. - * - * @param options - */ - getRuleMessage(options: Object): string; + /** + * Gets an errorMessage from either the rule or field/global options. + * + * @param options + */ + getRuleMessage(options: Object): string; - /** - * Formats an error message using rule-specific values (usually from formatItems). - * - * @param message The unformatted error message the validator intends to display. - */ - formatMessage(message: string): string; - } + /** + * Formats an error message using rule-specific values (usually from formatItems). + * + * @param message The unformatted error message the validator intends to display. + */ + formatMessage(message: string): string; +} } interface IgniteUIStatic { - IgValidatorEqualToRule: typeof Infragistics.IgValidatorEqualToRule; +IgValidatorEqualToRule: typeof Infragistics.IgValidatorEqualToRule; } declare namespace Infragistics { - class IgValidatorEmailRule { - constructor(name: string); - constructor(formatItems: any[]); - isValid(options: Object, value: Object): void; +class IgValidatorEmailRule { + constructor(name: string); + constructor(formatItems: any[]); + isValid(options: Object, value: Object): void; - /** - * Gets the error message type to get from locale settings (matching as "Message>"). Returns the rule name by default. - * Only used when there's no errorMessage option available through getRuleMessage. - * - * @param options - */ - getMessageType(options: Object): string; + /** + * Gets the error message type to get from locale settings (matching as "Message>"). Returns the rule name by default. + * Only used when there's no errorMessage option available through getRuleMessage. + * + * @param options + */ + getMessageType(options: Object): string; - /** - * Gets an errorMessage from either the rule or field/global options. - * - * @param options - */ - getRuleMessage(options: Object): string; + /** + * Gets an errorMessage from either the rule or field/global options. + * + * @param options + */ + getRuleMessage(options: Object): string; - /** - * Formats an error message using rule-specific values (usually from formatItems). - * - * @param message The unformatted error message the validator intends to display. - */ - formatMessage(message: string): string; - } + /** + * Formats an error message using rule-specific values (usually from formatItems). + * + * @param message The unformatted error message the validator intends to display. + */ + formatMessage(message: string): string; +} } interface IgniteUIStatic { - IgValidatorEmailRule: typeof Infragistics.IgValidatorEmailRule; +IgValidatorEmailRule: typeof Infragistics.IgValidatorEmailRule; } declare namespace Infragistics { - class IgValidatorPatternRule { - constructor(name: string); - constructor(formatItems: any[]); - isValid(options: Object, value: Object): void; +class IgValidatorPatternRule { + constructor(name: string); + constructor(formatItems: any[]); + isValid(options: Object, value: Object): void; - /** - * Gets the error message type to get from locale settings (matching as "Message>"). Returns the rule name by default. - * Only used when there's no errorMessage option available through getRuleMessage. - * - * @param options - */ - getMessageType(options: Object): string; + /** + * Gets the error message type to get from locale settings (matching as "Message>"). Returns the rule name by default. + * Only used when there's no errorMessage option available through getRuleMessage. + * + * @param options + */ + getMessageType(options: Object): string; - /** - * Gets an errorMessage from either the rule or field/global options. - * - * @param options - */ - getRuleMessage(options: Object): string; + /** + * Gets an errorMessage from either the rule or field/global options. + * + * @param options + */ + getRuleMessage(options: Object): string; - /** - * Formats an error message using rule-specific values (usually from formatItems). - * - * @param message The unformatted error message the validator intends to display. - */ - formatMessage(message: string): string; - } + /** + * Formats an error message using rule-specific values (usually from formatItems). + * + * @param message The unformatted error message the validator intends to display. + */ + formatMessage(message: string): string; +} } interface IgniteUIStatic { - IgValidatorPatternRule: typeof Infragistics.IgValidatorPatternRule; +IgValidatorPatternRule: typeof Infragistics.IgValidatorPatternRule; } declare namespace Infragistics { - class IgValidatorCustomRule { - constructor(name: string); - constructor(formatItems: any[]); - getMessageType(): void; - isValid(options: Object, value: Object): void; +class IgValidatorCustomRule { + constructor(name: string); + constructor(formatItems: any[]); + getMessageType(): void; + isValid(options: Object, value: Object): void; - /** - * Gets an errorMessage from either the rule or field/global options. - * - * @param options - */ - getRuleMessage(options: Object): string; + /** + * Gets an errorMessage from either the rule or field/global options. + * + * @param options + */ + getRuleMessage(options: Object): string; - /** - * Formats an error message using rule-specific values (usually from formatItems). - * - * @param message The unformatted error message the validator intends to display. - */ - formatMessage(message: string): string; - } + /** + * Formats an error message using rule-specific values (usually from formatItems). + * + * @param message The unformatted error message the validator intends to display. + */ + formatMessage(message: string): string; +} } interface IgniteUIStatic { - IgValidatorCustomRule: typeof Infragistics.IgValidatorCustomRule; +IgValidatorCustomRule: typeof Infragistics.IgValidatorCustomRule; } declare namespace Infragistics { - class IgValidatorCreditCardRule { - constructor(name: string); - constructor(formatItems: any[]); +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 - * - * @param options - * @param value - */ - isValid(options: Object, value: Object): void; + /** + * 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 + * + * @param options + * @param value + */ + isValid(options: Object, value: Object): void; - /** - * Gets the error message type to get from locale settings (matching as "Message>"). Returns the rule name by default. - * Only used when there's no errorMessage option available through getRuleMessage. - * - * @param options - */ - getMessageType(options: Object): string; + /** + * Gets the error message type to get from locale settings (matching as "Message>"). Returns the rule name by default. + * Only used when there's no errorMessage option available through getRuleMessage. + * + * @param options + */ + getMessageType(options: Object): string; - /** - * Gets an errorMessage from either the rule or field/global options. - * - * @param options - */ - getRuleMessage(options: Object): string; + /** + * Gets an errorMessage from either the rule or field/global options. + * + * @param options + */ + getRuleMessage(options: Object): string; - /** - * Formats an error message using rule-specific values (usually from formatItems). - * - * @param message The unformatted error message the validator intends to display. - */ - formatMessage(message: string): string; - } + /** + * Formats an error message using rule-specific values (usually from formatItems). + * + * @param message The unformatted error message the validator intends to display. + */ + formatMessage(message: string): string; +} } interface IgniteUIStatic { - IgValidatorCreditCardRule: typeof Infragistics.IgValidatorCreditCardRule; +IgValidatorCreditCardRule: typeof Infragistics.IgValidatorCreditCardRule; } interface JQuery { @@ -83221,7 +93559,7 @@ interface IgVideoPlayer { loop?: boolean; /** - * Gets/Sets whether if you want to use the built in browser controls. By default player uses Infragistics playback controls. Note that you may have different look and feel across different browsers if you use the built in browser controls. + * Gets/Sets whether if you want to use the built in browser controls. By default player uses Infragistics playback controls. Note that you may have different look and feel across different browsers if you use the built in browser controls. When this option is set to true, no [commercials](ui.igvideoplayer#options:commercials) will be displayed as they are not supported. * */ browserControls?: boolean; @@ -83281,7 +93619,7 @@ interface IgVideoPlayer { banners?: IgVideoPlayerBanner[]; /** - * Gets/Sets an array of commercials objects that will be displayed when the video is playing. + * Gets/Sets an array of commercials objects that will be displayed when the video is playing. Note that [broswerControls](ui.igvideoplayer#options:browserControls) doesn't support commercials. * */ commercials?: IgVideoPlayerCommercials; @@ -83702,13 +94040,13 @@ interface JQuery { igVideoPlayer(optionLiteral: 'option', optionName: "loop", optionValue: boolean): void; /** - * Gets/Sets whether if you want to use the built in browser controls. By default player uses Infragistics playback controls. Note that you may have different look and feel across different browsers if you use the built in browser controls. + * Gets/Sets whether if you want to use the built in browser controls. By default player uses Infragistics playback controls. Note that you may have different look and feel across different browsers if you use the built in browser controls. When this option is set to true, no [commercials](ui.igvideoplayer#options:commercials) will be displayed as they are not supported. * */ igVideoPlayer(optionLiteral: 'option', optionName: "browserControls"): boolean; /** - * /Sets whether if you want to use the built in browser controls. By default player uses Infragistics playback controls. Note that you may have different look and feel across different browsers if you use the built in browser controls. + * /Sets whether if you want to use the built in browser controls. By default player uses Infragistics playback controls. Note that you may have different look and feel across different browsers if you use the built in browser controls. When this option is set to true, no [commercials](ui.igvideoplayer#options:commercials) will be displayed as they are not supported. * * * @optionValue New value to be set. @@ -83842,13 +94180,13 @@ interface JQuery { igVideoPlayer(optionLiteral: 'option', optionName: "banners", optionValue: IgVideoPlayerBanner[]): void; /** - * Gets/Sets an array of commercials objects that will be displayed when the video is playing. + * Gets/Sets an array of commercials objects that will be displayed when the video is playing. Note that [broswerControls](ui.igvideoplayer#options:browserControls) doesn't support commercials. * */ igVideoPlayer(optionLiteral: 'option', optionName: "commercials"): IgVideoPlayerCommercials; /** - * /Sets an array of commercials objects that will be displayed when the video is playing. + * /Sets an array of commercials objects that will be displayed when the video is playing. Note that [broswerControls](ui.igvideoplayer#options:browserControls) doesn't support commercials. * * * @optionValue New value to be set. @@ -84180,10 +94518,6 @@ interface ZoomChangingEvent { } interface ZoomChangingEventUIParam { - /** - * Used to get reference to igZoombar. - */ - owner?: any; } interface ZoomChangedEvent { @@ -84191,10 +94525,6 @@ interface ZoomChangedEvent { } interface ZoomChangedEventUIParam { - /** - * Used to get reference to igZoombar. - */ - owner?: any; } interface ProviderCreatedEvent { @@ -84202,15 +94532,6 @@ interface ProviderCreatedEvent { } interface ProviderCreatedEventUIParam { - /** - * Used to get the reference the created provider - */ - provider?: any; - - /** - * Used to get reference to igZoombar - */ - owner?: any; } interface WindowDragStartingEvent { @@ -84218,10 +94539,6 @@ interface WindowDragStartingEvent { } interface WindowDragStartingEventUIParam { - /** - * Used to get reference to igZoombar. - */ - owner?: any; } interface WindowDragStartedEvent { @@ -84229,10 +94546,6 @@ interface WindowDragStartedEvent { } interface WindowDragStartedEventUIParam { - /** - * Used to get reference to igZoombar. - */ - owner?: any; } interface WindowDraggingEvent { @@ -84240,10 +94553,6 @@ interface WindowDraggingEvent { } interface WindowDraggingEventUIParam { - /** - * Used to get reference to igZoombar. - */ - owner?: any; } interface WindowDragEndingEvent { @@ -84251,10 +94560,6 @@ interface WindowDragEndingEvent { } interface WindowDragEndingEventUIParam { - /** - * Used to get reference to igZoombar. - */ - owner?: any; } interface WindowDragEndedEvent { @@ -84262,10 +94567,6 @@ interface WindowDragEndedEvent { } interface WindowDragEndedEventUIParam { - /** - * Used to get reference to igZoombar. - */ - owner?: any; } interface WindowResizingEvent { @@ -84273,10 +94574,6 @@ interface WindowResizingEvent { } interface WindowResizingEventUIParam { - /** - * Used to get reference to igZoombar. - */ - owner?: any; } interface IgZoombar { @@ -84371,95 +94668,52 @@ interface IgZoombar { /** * Event fired before a zoom action is applied - * Function takes arguments evt and ui. - * Use ui.previousZoom.left to get the previous zoom window left position as a fraction of the absolute width of the target - * Use ui.previousZoom.width to get the previous zoom window width as a fraction of the absolute width of the target - * Use ui.newZoom.left to get the new zoom window left position as a fraction of the absolute width of the target - * Use ui.newZoom.width to get the new zoom window width as a fraction of the absolute width of the target - * Use ui.owner to get reference to igZoombar. */ zoomChanging?: ZoomChangingEvent; /** * Event fired after a zoom action is applied. - * Function takes arguments evt and ui. - * Use ui.previousZoom.left to get the previous zoom window left position as a fraction of the absolute width of the target - * Use ui.previousZoom.width to get the previous zoom window width as a fraction of the absolute width of the target - * Use ui.newZoom.left to get the new zoom window left position as a fraction of the absolute width of the target - * Use ui.newZoom.width to get the new zoom window width as a fraction of the absolute width of the target - * Use ui.owner to get reference to igZoombar. */ zoomChanged?: ZoomChangedEvent; /** * Event fired after a provider is created based on the options.provider value. If an instance is passed as a value for the option the event won't fire. * Use the event when utilizing a custom provider to assign options such as the zoomed widget's instance so that the provider's API is usable when igZoombar initializes its rendering. - * Function takes arguments evt and ui. - * Use ui.provider to get the reference the created provider - * Use ui.owner to get reference to igZoombar */ providerCreated?: ProviderCreatedEvent; /** * Event fired when the user attempts to drag the zoom window. - * Function takes arguments evt and ui. - * Use ui.zoomWindow.left to get the current zoom window left position as a fraction of the absolute width of the target - * Use ui.zoomWindow.width to get the current zoom window width as a fraction of the absolute width of the target - * Use ui.owner to get reference to igZoombar. */ windowDragStarting?: WindowDragStartingEvent; /** * Event fired when the user starts dragging the zoom window. - * Function takes arguments evt and ui. - * Use ui.zoomWindow.left to get the current zoom window left position as a fraction of the absolute width of the target - * Use ui.zoomWindow.width to get the current zoom window width as a fraction of the absolute width of the target - * Use ui.owner to get reference to igZoombar. */ windowDragStarted?: WindowDragStartedEvent; /** * Event fired when the user drags the zoom window. - * Function takes arguments evt and ui. - * Use ui.zoomWindow.left to get the current zoom window left position as a fraction of the absolute width of the target - * Use ui.zoomWindow.width to get the current zoom window width as a fraction of the absolute width of the target - * Use ui.owner to get reference to igZoombar. */ windowDragging?: WindowDraggingEvent; /** * Event fired when the user attemtps to stop dragging the zoom window. - * Function takes arguments evt and ui. - * Use ui.zoomWindow.left to get the current zoom window left position as a fraction of the absolute width of the target - * Use ui.zoomWindow.width to get the current zoom window width as a fraction of the absolute width of the target - * Use ui.owner to get reference to igZoombar. */ windowDragEnding?: WindowDragEndingEvent; /** * Event fired when the user stops dragging the zoom window. - * Function takes arguments evt and ui. - * Use ui.zoomWindow.left to get the current zoom window left position as a fraction of the absolute width of the target - * Use ui.zoomWindow.width to get the current zoom window width as a fraction of the absolute width of the target - * Use ui.owner to get reference to igZoombar. */ windowDragEnded?: WindowDragEndedEvent; /** * Event fired when the user resizes the zoom window with the window"s handles. - * Function takes arguments evt and ui. - * Use ui.zoomWindow.left to get the current zoom window left position as a fraction of the absolute width of the target - * Use ui.zoomWindow.width to get the current zoom window width as a fraction of the absolute width of the target - * Use ui.owner to get reference to igZoombar. */ windowResizing?: WindowResizingEvent; /** * Event fired after the user resizes the zoom window with the window"s handles. - * Function takes arguments evt and ui. - * Use ui.zoomWindow.left to get the current zoom window left position as a fraction of the absolute width of the target - * Use ui.zoomWindow.width to get the current zoom window width as a fraction of the absolute width of the target - * Use ui.owner to get reference to igZoombar. */ windowResized?: WindowResizedEvent; @@ -84533,98 +94787,98 @@ interface ZoombarProviderDefaultSettings { } declare namespace Infragistics { - class ZoombarProviderDefault { - constructor(settings: ZoombarProviderDefaultSettings); +class ZoombarProviderDefault { + constructor(settings: ZoombarProviderDefaultSettings); - /** - * Will be called before the provider instance is deleted (to unbind jQuery events, etc.) - */ - clean(): void; + /** + * Will be called before the provider instance is deleted (to unbind jQuery events, etc.) + */ + clean(): void; - /** - * 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 - */ - getBaseOpts(options: Object): void; + /** + * 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 + */ + 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 - */ - cleanOptsForZoom(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 + */ + 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 - */ - createClone(container: Object, 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 + */ + createClone(container: Object, options: Object): void; - /** - * Returns the provider"s widget name - */ - widgetName(): void; + /** + * Returns the provider"s widget name + */ + widgetName(): void; - /** - * Returns the target widget width property - */ - targetWidth(): void; + /** + * Returns the target widget width property + */ + targetWidth(): void; - /** - * 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 - */ - syncMinWidth(minWidth: number): void; + /** + * 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 + */ + 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). - */ - setSize(width: Object, height: Object): 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). + */ + setSize(width: Object, height: Object): void; - /** - * Gets/sets the target object - * - * @param obj the new target component instance to set - */ - targetObject(obj?: Object): void; + /** + * Gets/sets the target object + * + * @param obj the new target component instance to set + */ + targetObject(obj?: Object): void; - /** - * Jshint ignore:line - * - * @param a - * @param b - */ - update(a: Object, b: Object): void; - } + /** + * Jshint ignore:line + * + * @param a + * @param b + */ + update(a: Object, b: Object): void; +} } interface IgniteUIStatic { - ZoombarProviderDefault: typeof Infragistics.ZoombarProviderDefault; +ZoombarProviderDefault: typeof Infragistics.ZoombarProviderDefault; } declare namespace Infragistics { - class ZoombarProviderDataChart { - constructor(settings: ZoombarProviderDefaultSettings); - clean(): void; - getBaseOpts(options: Object): void; - cleanOptsForZoom(options: Object): void; - createClone(container: Object, options: Object): void; - widgetName(): void; - targetWidth(): void; - targetObject(obj: Object): void; - syncMinWidth(minWidth: Object): void; - setSize(width: Object, height: Object): void; - update(a: Object, b: Object): void; - } +class ZoombarProviderDataChart { + constructor(settings: ZoombarProviderDefaultSettings); + clean(): void; + getBaseOpts(options: Object): void; + cleanOptsForZoom(options: Object): void; + createClone(container: Object, options: Object): void; + widgetName(): void; + targetWidth(): void; + targetObject(obj: Object): void; + syncMinWidth(minWidth: Object): void; + setSize(width: Object, height: Object): void; + update(a: Object, b: Object): void; +} } interface IgniteUIStatic { - ZoombarProviderDataChart: typeof Infragistics.ZoombarProviderDataChart; +ZoombarProviderDataChart: typeof Infragistics.ZoombarProviderDataChart; } interface JQuery { @@ -84809,23 +95063,11 @@ interface JQuery { /** * Event fired before a zoom action is applied - * Function takes arguments evt and ui. - * Use ui.previousZoom.left to get the previous zoom window left position as a fraction of the absolute width of the target - * Use ui.previousZoom.width to get the previous zoom window width as a fraction of the absolute width of the target - * Use ui.newZoom.left to get the new zoom window left position as a fraction of the absolute width of the target - * Use ui.newZoom.width to get the new zoom window width as a fraction of the absolute width of the target - * Use ui.owner to get reference to igZoombar. */ igZoombar(optionLiteral: 'option', optionName: "zoomChanging"): ZoomChangingEvent; /** * Event fired before a zoom action is applied - * Function takes arguments evt and ui. - * Use ui.previousZoom.left to get the previous zoom window left position as a fraction of the absolute width of the target - * Use ui.previousZoom.width to get the previous zoom window width as a fraction of the absolute width of the target - * Use ui.newZoom.left to get the new zoom window left position as a fraction of the absolute width of the target - * Use ui.newZoom.width to get the new zoom window width as a fraction of the absolute width of the target - * Use ui.owner to get reference to igZoombar. * * @optionValue Define event handler function. */ @@ -84833,23 +95075,11 @@ interface JQuery { /** * Event fired after a zoom action is applied. - * Function takes arguments evt and ui. - * Use ui.previousZoom.left to get the previous zoom window left position as a fraction of the absolute width of the target - * Use ui.previousZoom.width to get the previous zoom window width as a fraction of the absolute width of the target - * Use ui.newZoom.left to get the new zoom window left position as a fraction of the absolute width of the target - * Use ui.newZoom.width to get the new zoom window width as a fraction of the absolute width of the target - * Use ui.owner to get reference to igZoombar. */ igZoombar(optionLiteral: 'option', optionName: "zoomChanged"): ZoomChangedEvent; /** * Event fired after a zoom action is applied. - * Function takes arguments evt and ui. - * Use ui.previousZoom.left to get the previous zoom window left position as a fraction of the absolute width of the target - * Use ui.previousZoom.width to get the previous zoom window width as a fraction of the absolute width of the target - * Use ui.newZoom.left to get the new zoom window left position as a fraction of the absolute width of the target - * Use ui.newZoom.width to get the new zoom window width as a fraction of the absolute width of the target - * Use ui.owner to get reference to igZoombar. * * @optionValue Define event handler function. */ @@ -84858,18 +95088,12 @@ interface JQuery { /** * Event fired after a provider is created based on the options.provider value. If an instance is passed as a value for the option the event won't fire. * Use the event when utilizing a custom provider to assign options such as the zoomed widget's instance so that the provider's API is usable when igZoombar initializes its rendering. - * Function takes arguments evt and ui. - * Use ui.provider to get the reference the created provider - * Use ui.owner to get reference to igZoombar */ igZoombar(optionLiteral: 'option', optionName: "providerCreated"): ProviderCreatedEvent; /** * Event fired after a provider is created based on the options.provider value. If an instance is passed as a value for the option the event won't fire. * Use the event when utilizing a custom provider to assign options such as the zoomed widget's instance so that the provider's API is usable when igZoombar initializes its rendering. - * Function takes arguments evt and ui. - * Use ui.provider to get the reference the created provider - * Use ui.owner to get reference to igZoombar * * @optionValue Define event handler function. */ @@ -84877,19 +95101,11 @@ interface JQuery { /** * Event fired when the user attempts to drag the zoom window. - * Function takes arguments evt and ui. - * Use ui.zoomWindow.left to get the current zoom window left position as a fraction of the absolute width of the target - * Use ui.zoomWindow.width to get the current zoom window width as a fraction of the absolute width of the target - * Use ui.owner to get reference to igZoombar. */ igZoombar(optionLiteral: 'option', optionName: "windowDragStarting"): WindowDragStartingEvent; /** * Event fired when the user attempts to drag the zoom window. - * Function takes arguments evt and ui. - * Use ui.zoomWindow.left to get the current zoom window left position as a fraction of the absolute width of the target - * Use ui.zoomWindow.width to get the current zoom window width as a fraction of the absolute width of the target - * Use ui.owner to get reference to igZoombar. * * @optionValue Define event handler function. */ @@ -84897,19 +95113,11 @@ interface JQuery { /** * Event fired when the user starts dragging the zoom window. - * Function takes arguments evt and ui. - * Use ui.zoomWindow.left to get the current zoom window left position as a fraction of the absolute width of the target - * Use ui.zoomWindow.width to get the current zoom window width as a fraction of the absolute width of the target - * Use ui.owner to get reference to igZoombar. */ igZoombar(optionLiteral: 'option', optionName: "windowDragStarted"): WindowDragStartedEvent; /** * Event fired when the user starts dragging the zoom window. - * Function takes arguments evt and ui. - * Use ui.zoomWindow.left to get the current zoom window left position as a fraction of the absolute width of the target - * Use ui.zoomWindow.width to get the current zoom window width as a fraction of the absolute width of the target - * Use ui.owner to get reference to igZoombar. * * @optionValue Define event handler function. */ @@ -84917,19 +95125,11 @@ interface JQuery { /** * Event fired when the user drags the zoom window. - * Function takes arguments evt and ui. - * Use ui.zoomWindow.left to get the current zoom window left position as a fraction of the absolute width of the target - * Use ui.zoomWindow.width to get the current zoom window width as a fraction of the absolute width of the target - * Use ui.owner to get reference to igZoombar. */ igZoombar(optionLiteral: 'option', optionName: "windowDragging"): WindowDraggingEvent; /** * Event fired when the user drags the zoom window. - * Function takes arguments evt and ui. - * Use ui.zoomWindow.left to get the current zoom window left position as a fraction of the absolute width of the target - * Use ui.zoomWindow.width to get the current zoom window width as a fraction of the absolute width of the target - * Use ui.owner to get reference to igZoombar. * * @optionValue Define event handler function. */ @@ -84937,19 +95137,11 @@ interface JQuery { /** * Event fired when the user attemtps to stop dragging the zoom window. - * Function takes arguments evt and ui. - * Use ui.zoomWindow.left to get the current zoom window left position as a fraction of the absolute width of the target - * Use ui.zoomWindow.width to get the current zoom window width as a fraction of the absolute width of the target - * Use ui.owner to get reference to igZoombar. */ igZoombar(optionLiteral: 'option', optionName: "windowDragEnding"): WindowDragEndingEvent; /** * Event fired when the user attemtps to stop dragging the zoom window. - * Function takes arguments evt and ui. - * Use ui.zoomWindow.left to get the current zoom window left position as a fraction of the absolute width of the target - * Use ui.zoomWindow.width to get the current zoom window width as a fraction of the absolute width of the target - * Use ui.owner to get reference to igZoombar. * * @optionValue Define event handler function. */ @@ -84957,19 +95149,11 @@ interface JQuery { /** * Event fired when the user stops dragging the zoom window. - * Function takes arguments evt and ui. - * Use ui.zoomWindow.left to get the current zoom window left position as a fraction of the absolute width of the target - * Use ui.zoomWindow.width to get the current zoom window width as a fraction of the absolute width of the target - * Use ui.owner to get reference to igZoombar. */ igZoombar(optionLiteral: 'option', optionName: "windowDragEnded"): WindowDragEndedEvent; /** * Event fired when the user stops dragging the zoom window. - * Function takes arguments evt and ui. - * Use ui.zoomWindow.left to get the current zoom window left position as a fraction of the absolute width of the target - * Use ui.zoomWindow.width to get the current zoom window width as a fraction of the absolute width of the target - * Use ui.owner to get reference to igZoombar. * * @optionValue Define event handler function. */ @@ -84977,19 +95161,11 @@ interface JQuery { /** * Event fired when the user resizes the zoom window with the window"s handles. - * Function takes arguments evt and ui. - * Use ui.zoomWindow.left to get the current zoom window left position as a fraction of the absolute width of the target - * Use ui.zoomWindow.width to get the current zoom window width as a fraction of the absolute width of the target - * Use ui.owner to get reference to igZoombar. */ igZoombar(optionLiteral: 'option', optionName: "windowResizing"): WindowResizingEvent; /** * Event fired when the user resizes the zoom window with the window"s handles. - * Function takes arguments evt and ui. - * Use ui.zoomWindow.left to get the current zoom window left position as a fraction of the absolute width of the target - * Use ui.zoomWindow.width to get the current zoom window width as a fraction of the absolute width of the target - * Use ui.owner to get reference to igZoombar. * * @optionValue Define event handler function. */ @@ -84997,19 +95173,11 @@ interface JQuery { /** * Event fired after the user resizes the zoom window with the window"s handles. - * Function takes arguments evt and ui. - * Use ui.zoomWindow.left to get the current zoom window left position as a fraction of the absolute width of the target - * Use ui.zoomWindow.width to get the current zoom window width as a fraction of the absolute width of the target - * Use ui.owner to get reference to igZoombar. */ igZoombar(optionLiteral: 'option', optionName: "windowResized"): WindowResizedEvent; /** * Event fired after the user resizes the zoom window with the window"s handles. - * Function takes arguments evt and ui. - * Use ui.zoomWindow.left to get the current zoom window left position as a fraction of the absolute width of the target - * Use ui.zoomWindow.width to get the current zoom window width as a fraction of the absolute width of the target - * Use ui.owner to get reference to igZoombar. * * @optionValue Define event handler function. */