diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 1fc8897d23..3e8c430b55 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,19 +1,17 @@ Please fill in this template. -- [ ] Make your PR against the `master` branch. - [ ] Use a meaningful title for the pull request. Include the name of the package modified. - [ ] Test the change in your own code. (Compile and run.) - [ ] Follow the advice from the [readme](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/README.md#make-a-pull-request). - [ ] Avoid [common mistakes](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/README.md#common-mistakes). -- [ ] Run `tsc` without errors. -- [ ] Run `npm run lint package-name` if a `tslint.json` is present. +- [ ] Run `npm run lint package-name` (or `tsc` if no `tslint.json` is present). Select one of these and delete the others: If adding a new definition: - [ ] The package does not provide its own types, and you can not add them. - [ ] If this is for an NPM package, match the name. If not, do not conflict with the name of an NPM package. -- [ ] Create it with `npm run new-package package-name`, not by basing it on an existing project. +- [ ] Create it with `dts-gen --dt`, not by basing it on an existing project. - [ ] `tslint.json` should be present, and `tsconfig.json` should have `noImplicitAny`, `noImplicitThis`, and `strictNullChecks` set to `true`. If changing an existing definition: diff --git a/README.md b/README.md index 9dbb809b57..6868d116cf 100644 --- a/README.md +++ b/README.md @@ -110,9 +110,8 @@ Your package should have this structure: | tsconfig.json | This allows you to run `tsc` within the package. | | tslint.json | Enables linting. | -Generate these by running `npm run new-package -- --name my-package-name --template module`. -(Other templates are `module-class`, `module-function`, `module-plugin`, `global`, `global-plugin`, and `global-modifying-module`. -This just wraps [dts-gen](https://github.com/Microsoft/dts-gen), so it supports all options from that.) +Generate these by running `npm install -g dts-gen` and `dts-gen --dt --name my-package-name --template module`. +See all options at [dts-gen](https://github.com/Microsoft/dts-gen). You may edit the `tsconfig.json` to add new files, to add `"target": "es6"` (needed for async functions), to add to `"lib"`, or to add the `"jsx"` compiler option. @@ -167,9 +166,11 @@ If a `tslint.json` turns rules off, this is because that hasn't been fixed yet. } ``` -(To indicate that a lint rule truly does not apply, use `// tslint:disable:rule-name` or better, `//tslint:disable-next-line:rule-name`.) +(To indicate that a lint rule truly does not apply, use `// tslint:disable rule-name` or better, `//tslint:disable-next-line rule-name`.) + +Test by running `npm run lint package-name` where `package-name` is the name of your package. +This script uses [dtslint](https://github.com/Microsoft/dtslint). -Test the linter by running `npm run lint -- package-name`. Do not use a globally installed tslint. ## FAQ diff --git a/package.json b/package.json index 1dad46394d..77e57cbb44 100644 --- a/package.json +++ b/package.json @@ -16,13 +16,12 @@ }, "scripts": { "compile-scripts": "tsc -p scripts", - "new-package": "dts-gen --dt", "not-needed": "node scripts/not-needed.js", - "lint": "node scripts/lint.js", - "test": "node node_modules/types-publisher/bin/tester/test.js --run-from-definitely-typed --nProcesses 1" + "test": "node node_modules/types-publisher/bin/tester/test.js --run-from-definitely-typed --nProcesses 1", + "lint": "dtslint --dt types" }, "devDependencies": { - "types-publisher": "Microsoft/types-publisher#production", - "dts-gen": "latest" + "dtslint": "Microsoft/dtslint#production", + "types-publisher": "Microsoft/types-publisher#production" } } diff --git a/react-onsenui/index.d.ts b/react-onsenui/index.d.ts deleted file mode 100644 index d8404e8f6c..0000000000 --- a/react-onsenui/index.d.ts +++ /dev/null @@ -1,314 +0,0 @@ -// Type definitions for React OnSenui (react-onsenui) 2.1 -// Project: https://onsen.io/v2/docs/guide/react/ -// Definitions by: Ozytis -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -// TypeScript Version: 2.1 -import { Component } from 'react'; - -declare interface Modifiers_string { - default?: string, - material?: string -} - -declare interface Modifiers_number { - default?: number, - material?: number -} - -declare interface AnimationOptions { - duration?: number, - delay?: number, - timing?: string -} - -/*** splitter ***/ -declare class SplitterSide extends Component<{ - side?: "left" | "right", - collapse?: "portrait" | "landscape" | boolean, - isOpen?: boolean, - onOpen?: (e?: Event) => void, - onPreOpen?: (e?: Event) => void, - onPreClose?: (e?: Event) => void, - onModeChange?: (e?: Event) => void, - onClose?: (e?: Event) => void, - isSwipeable?: boolean, - swipeTargetWidth?: number, - width?: number, - animation?: "overlay" | "default" - animationOptions?: AnimationOptions, - openThreshold?: number, - mode?: "collapse" | "split" -}, any>{ } - - -declare class SplitterContent extends Component<{}, any> { } - -declare class Splitter extends Component<{}, any> { } - -/*** toolbar ***/ - -declare class Toolbar extends Component<{}, any>{} - - -declare class BottomToolbar extends Component<{ - modifier?: string -}, any>{} - - -declare class ToolbarButton extends Component<{ - modifier?: string, - disabled?: boolean, - onClick?: (e?: Event) => void -}, any>{} - -/*** icon ***/ -declare class Icon extends Component<{ - modifier?: string, - icon?: string | Modifiers_string, - size?: number | Modifiers_number, - rotate?: 90 | 180 | 270, - fixedWidth?: boolean, - spin?: boolean -}, any>{} - -/*** page ***/ - -declare class Page extends Component<{ - contentStyle?: any, - modifier?: string, - renderModal?: () => void, - renderToolbar?: () => void, - renderBottomToolbar?: () => void, - renderFixed?: () => void, - onInit?: () => void, - onShow?: () => void, - onHide?: () => void -}, any>{} - -/*** Grid ***/ -declare class Col extends Component<{ - verticalAlign?: "top" | "bottom" | "center", - width?: string -}, any>{} - -declare class Row extends Component<{ - verticalAlign?: "top" | "bottom" | "center", -}, any>{} - -/*** Navigation ***/ -declare class BackButton extends Component<{ - modifier?: string, - onClick?: (navigator: Navigator) => void -}, any>{} - -declare class Navigator extends Component<{ - renderPage: () => any, - initialRouteStack?: string[], - initialRoute?: any, - onPrePush?: () => void, - onPostPush?: () => void, - onPrePop?: () => void, - onPostPop?: () => void, - animation?: "slide" | "lift" | "fade" | "none" | string, - animationOptions?: AnimationOptions -}, any>{ - resetPage(route: any, options: any): void; - resetPageStack(route: any, options: any): void; - pushPage(route: any, options: any): void; - popPage(route: any, options: any): void; -} - -/*** Carousel ***/ -declare class Carousel extends Component<{ - direction?: "horizontal" | "vertical", - fullscreen?: boolean, - overscrollable?: boolean, - centered?: boolean, - itemWidth?: number, - itemHeight?: number, - autoScroll?: boolean, - autoScrollRatio?: number, - swipeable?: boolean, - disabled?: boolean, - index?: number, - autoRefresh?: boolean, - onPostChange?: () => void, - onRefresh?: () => void, - onOverscroll?: () => void - animationOptions?: AnimationOptions -}, any>{} - -declare class CarouselItem extends Component<{ - modifier: string -}, any>{} - -/*** AlertDialog ***/ -declare class AlertDialog extends Component<{ - onCancel?: () => void, - isOpen?: boolean, - isCancelable?: boolean, - isDisabled?: boolean, - animation?: "none" | "default", - modifier?: string, - maskColor?: string, - animationOptions?: AnimationOptions, - onPreShow?: () => void, - onPostShow?: () => void, - onPreHide?: () => void, - onPostHide?: () => void, -}, any>{} - -declare class Dialog extends Component<{ - onCancel?: () => void, - isOpen?: boolean, - isCancelable?: boolean, - isDisabled?: boolean, - animation?: "none" | "default", - modifier?: string, - maskColor?: string, - animationOptions?: AnimationOptions, - onPreShow?: () => void, - onPostShow?: () => void, - onPreHide?: () => void, - onPostHide?: () => void, -}, any>{} - -declare class Modal extends Component<{ - animation?: "fade" | "none", - animationOptions?: AnimationOptions - onShow?: () => void, - onHide?: () => void, - isOpen?: boolean -}, any>{} - -declare class Popover extends Component<{ - getTarget?: () => Component | HTMLElement, - onCancel?: () => void, - isOpen?: boolean, - isCancelable?: boolean, - isDisabled?: boolean, - animation?: "none" | "default", - modifier?: string, - maskColor?: string, - animationOptions?: AnimationOptions, - onPreShow?: () => void, - onPostShow?: () => void, - onPreHide?: () => void, - onPostHide?: () => void, -}, any>{} - -declare class ProgressBar extends Component<{ - modifier?: string, - value?: number, - secondaryValue?: boolean, - intermediate?: boolean, -}, any> {} - -declare class ProgressCircular extends Component<{ - modifier?: string, - value?: number, - secondaryValue?: boolean, - intermediate?: boolean, -}, any>{} - -declare class Ripple extends Component<{ - color?: string, - background?: string, - disabled?: boolean, -}, any>{} - -/*** Forms ***/ -declare class Fab extends Component<{ - modifier?: string, - ripple?: boolean, - position?: string, - disabled?: boolean, - onClick?: () => void, -}, any>{} - -declare class Button extends Component<{ - modifier?: string, - disabled?: boolean, - ripple?: boolean, - onClick?: (e?: Event) => void -}, any>{} - -declare class Input extends Component<{ - modifier?: string, - disabled?: boolean, - onChange?: (e: Event) => void, - value?: string, - checked?: boolean, - placehoder?: string, - type?: string, - inputId?: string, - float?: boolean, -}, any> {} - -declare class Range extends Component<{ - modifier?: string, - onChange?: (e: Event) => void, - value?: number, - disabled?: boolean, -}, any>{} - -declare class Switch extends Component<{ - onChange?: (e: Event) => void, - checked?: boolean, - disabled?: boolean, - inputId?: string -}, any>{} - -/** -* Tabs -*/ - -declare class Tab extends Component<{}, any>{ } - -declare class TabActive extends Component<{}, any>{ } - -declare class TabInactive extends Component<{}, any>{ } - -declare class Tabbar extends Component<{ - index?: number, - renderTabs?: () => any, - position?: "bottom" | "top" | "auto", - animation: "none" | "slide" | "fade", - animationOptions?: AnimationOptions, - onPreChange?: () => void, - onPostChange?: () => void, - onReactive?: () => void, -}, any> { } - - -/** -* Lists -*/ - -declare class LazyList extends Component<{ - modifier?: string, - length?: number, - renderRow: (rowIndex: number) => any, - calculateItemHeight: (rowIndex: number) => any, -}, any>{ } - -declare class List extends Component<{ - modifier?: string, - dataSource?: string[], - renderRow?: () => void, - renderHeader?: () => void, - renderFooter?: () => void, -}, any>{} - -declare class ListHeader extends Component<{ - modifier?: string, -}, any>{} - -declare class ListItem extends Component<{ - modifier?: string, - tappable?: boolean, - tapBackgroundColor?: string, - lockOnDrag?: boolean, -}, any>{} - - diff --git a/react-onsenui/react-onsenui-tests.tsx b/react-onsenui/react-onsenui-tests.tsx deleted file mode 100644 index b72e8c3a37..0000000000 --- a/react-onsenui/react-onsenui-tests.tsx +++ /dev/null @@ -1,49 +0,0 @@ -import * as React from "react"; -import * as ReactDOM from "react-dom"; -import { SplitterSide, Splitter, SplitterContent, Page } from "react-onsenui"; - -class AppState { - isOpen: boolean = false; -} - -interface AppProps { -} - -export class App extends React.Component{ - - constructor(props?: AppProps) { - super(props); - this.state = new AppState(); - } - - hide() { - this.setState({ isOpen: false }); - } - - render() { - - return ( - - this.hide()} - isSwipeable={true}> - - Menu content - - - - - Test page - - - - ); - } - -} - - -ReactDOM.render(, document.getElementById('react-body')); \ No newline at end of file diff --git a/react-onsenui/tsconfig.json b/react-onsenui/tsconfig.json deleted file mode 100644 index 2b4e079fd1..0000000000 --- a/react-onsenui/tsconfig.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "compilerOptions": { - "sourceMap": true, - "noImplicitAny": true, - "noImplicitThis": true, - "strictNullChecks": true, - "module": "commonjs", - "target": "es5", - "jsx": "react", - "experimentalDecorators": true, - "baseUrl": "../", - "typeRoots": [ "../" ], - "noEmit": true, - "forceConsistentCasingInFileNames": true, - "lib": [ - "es6", - "dom" - ], - "types": [] - }, - "files": [ - "index.d.ts", - "react-onsenui-tests.tsx" - ] -} \ No newline at end of file diff --git a/scripts/lint.js b/scripts/lint.js deleted file mode 100644 index 84ef71259d..0000000000 --- a/scripts/lint.js +++ /dev/null @@ -1,25 +0,0 @@ -// Usage: npm run lint -- my-package-name -const pkg = process.argv[2]; -const execSync = require("child_process").execSync; -const existsSync = require("fs").existsSync; -const path = require("path"); - -const pkgPath = path.join("types", pkg); - -// Path of tslint when `types-publisher` is symlinked -const symlinkedTslintPath = "../../node_modules/types-publisher/node_modules/tslint" -let tslintPath = existsSync(path.join(pkgPath, symlinkedTslintPath)) ? symlinkedTslintPath : "../node_modules/tslint"; -// An older version (e.g. abs/v0) is in a nested directory, so needs to look one more level up for tslint. -if (pkg.includes("/") && pkg[pkg.length - 1] !== "/") { - tslintPath = path.join("..", tslintPath); -} - -const cmd = `node ${tslintPath}/lib/tslint-cli --format stylish "**/*.ts"`; -console.log(cmd); - -try { - // Child process writes directly to our own stdout - execSync(cmd, { cwd: pkgPath, stdio: "inherit" }); -} catch (_) { - // Process should have printed out error info -} diff --git a/types/amplify-deferred/tslint.json b/types/amplify-deferred/tslint.json index f05741c59b..b0e7084e94 100644 --- a/types/amplify-deferred/tslint.json +++ b/types/amplify-deferred/tslint.json @@ -1,6 +1,6 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false + "ban-types": false } } diff --git a/types/amplify/amplify-tests.ts b/types/amplify/amplify-tests.ts index 8cce567960..ab4a9bf1bd 100644 --- a/types/amplify/amplify-tests.ts +++ b/types/amplify/amplify-tests.ts @@ -16,7 +16,6 @@ amplify.subscribe("dataexample", data => { alert(data.foo); // bar }); - amplify.publish("dataexample", { foo: "bar" }); amplify.subscribe("dataexample2", (param1, param2) => { @@ -47,7 +46,6 @@ amplify.subscribe("priorityexample", data => { } }, 1); - // Store data with amplify storage picking the default storage technology: amplify.publish("priorityexample", { foo: "bar" }); @@ -56,9 +54,9 @@ amplify.publish("priorityexample", { foo: "oops" }); amplify.store("storeExample1", { foo: "bar" }); amplify.store("storeExample2", "baz"); // retrieve the data later via the key -var myStoredValue = amplify.store("storeExample1"), - myStoredValue2 = amplify.store("storeExample2"), - myStoredValues = amplify.store(); +const myStoredValue = amplify.store("storeExample1"); +let myStoredValue2 = amplify.store("storeExample2"); +const myStoredValues = amplify.store(); myStoredValue.foo; // bar myStoredValue2; // baz myStoredValues.storeExample1.foo; // bar @@ -68,15 +66,13 @@ myStoredValues.storeExample2; // baz amplify.store.sessionStorage("explicitExample", { foo2: "baz" }); // retrieve the data later via the key -var myStoredValue2 = amplify.store.sessionStorage("explicitExample"); +myStoredValue2 = amplify.store.sessionStorage("explicitExample"); myStoredValue2.foo2; // baz - // REQUEST // Set up and use a request utilizing Ajax - amplify.request.define("ajaxExample1", "ajax", { url: "/myApiUrl", dataType: "json", @@ -175,7 +171,7 @@ amplify.request("twitter-mentions", { user: "amplifyjs" }); // Example: -var appEnvelopeDecoder: amplify.Decoder = (data, status, xhr, success, error) => { +const appEnvelopeDecoder: amplify.Decoder = (data, status, xhr, success, error) => { if (data.status === "success") { success(data.data); } else if (data.status === "fail" || data.status === "error") { @@ -197,7 +193,6 @@ amplify.request.decoders.appEnvelope = appEnvelopeDecoder; // but you can also just add it via an index amplify.request.decoders['appEnvelopeStr'] = appEnvelopeDecoder; - amplify.request.define("decoderExample", "ajax", { url: "/myAjaxUrl", type: "POST", diff --git a/types/amplify/index.d.ts b/types/amplify/index.d.ts index 5cb03e5b1d..f88c754264 100644 --- a/types/amplify/index.d.ts +++ b/types/amplify/index.d.ts @@ -9,8 +9,8 @@ declare namespace amplify { interface RequestSettings { resourceId: string; data?: any; - success?: (...args: any[]) => void; - error?: (...args: any[]) => void; + success?(...args: any[]): void; + error?(...args: any[]): void; } type Decoder = diff --git a/types/amplify/tslint.json b/types/amplify/tslint.json index fe03bea79d..6e33505955 100644 --- a/types/amplify/tslint.json +++ b/types/amplify/tslint.json @@ -1,7 +1,7 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false, + "ban-types": false, "unified-signatures": false } } diff --git a/types/angular-gridster/angular-gridster-tests.ts b/types/angular-gridster/angular-gridster-tests.ts index 7af4908d2d..f8c5a93c81 100644 --- a/types/angular-gridster/angular-gridster-tests.ts +++ b/types/angular-gridster/angular-gridster-tests.ts @@ -3,11 +3,10 @@ import * as angular from "angular"; import gridster from "angular-gridster"; -var myApp = angular.module("testModule", ["gridster"]); +const myApp = angular.module("testModule", ["gridster"]); // configure gridster's global options myApp.run(["gridsterConfig", (gridsterConfig: angular.gridster.GridsterConfig) => { - gridsterConfig.mobileBreakPoint = 697; gridsterConfig.colWidth = "100"; gridsterConfig.rowHeight = "100"; @@ -24,4 +23,4 @@ myApp.run(["gridsterConfig", (gridsterConfig: angular.gridster.GridsterConfig) = gridsterConfig.resizable = { enabled: true, handles: ["n", "s", "e", "w", "ne", "se", "sw", "nw"]}; } -]); \ No newline at end of file +]); diff --git a/types/angular-oauth2/angular-oauth2-tests.ts b/types/angular-oauth2/angular-oauth2-tests.ts index 042fe537aa..89dd51b4aa 100644 --- a/types/angular-oauth2/angular-oauth2-tests.ts +++ b/types/angular-oauth2/angular-oauth2-tests.ts @@ -7,4 +7,4 @@ angular.module('angular-oauth2-test', ['angular-oauth2']) clientId: 'CLIENT_ID', clientSecret: 'CLIENT_SECRET' // optional }); - }]); \ No newline at end of file + }]); diff --git a/types/angular/angular-tests.ts b/types/angular/angular-tests.ts index b4e394aa37..637ebda708 100644 --- a/types/angular/angular-tests.ts +++ b/types/angular/angular-tests.ts @@ -62,7 +62,6 @@ angular.module('http-auth-interceptor', []) * On 401 response - it stores the request and broadcasts 'event:angular-auth-loginRequired'. */ .config(['$httpProvider', 'authServiceProvider', ($httpProvider: ng.IHttpProvider, authServiceProvider: any) => { - $httpProvider.defaults.headers.common = {Authorization: 'Bearer token'}; $httpProvider.defaults.headers.get['Authorization'] = 'Bearer token'; $httpProvider.defaults.headers.post['Authorization'] = (config: ng.IRequestConfig) => 'Bearer token'; @@ -108,7 +107,7 @@ namespace HttpAndRegularPromiseTests { $http.get('http://somewhere/some/resource') .then((response: ng.IHttpPromiseCallbackArg) => { // typing lost, so something like - // var i: number = response.data + // const i: number = response.data // would type check $scope.person = response.data; }); @@ -116,7 +115,7 @@ namespace HttpAndRegularPromiseTests { $http.get('http://somewhere/some/resource') .then((response: ng.IHttpPromiseCallbackArg) => { // typing lost, so something like - // var i: number = response.data + // const i: number = response.data // would NOT type check $scope.person = response.data; }); @@ -153,7 +152,13 @@ namespace HttpAndRegularPromiseTests { // Test for AngularJS Syntax namespace My.Namespace { - export var x: any; // need to export something for module to kick in + export const x: any = null; // need to export something for module to kick in +} + +class TestProvider implements ng.IServiceProvider { + constructor(private $scope: ng.IScope) {} + + $get() {} } // IModule Registering Test @@ -229,14 +234,6 @@ mod.value(My.Namespace); mod.decorator('name', ($scope: ng.IScope) => {}); mod.decorator('name', ['$scope', ($scope: ng.IScope) => {}]); -class TestProvider implements ng.IServiceProvider { - constructor(private $scope: ng.IScope) { - } - - $get() { - } -} - // QProvider tests angular.module('qprovider-test', []) .config(['$qProvider', ($qProvider: ng.IQProvider) => { @@ -276,8 +273,8 @@ foo.then((x) => { // Object is inferred here x.a = 123; // Try a promise - var y: ng.IPromise; - var condition: boolean; + const y: ng.IPromise = null; + const condition: boolean = null; return condition ? y : x.a; // IPromise | T, both are good for the 1st arg of .then() }).then((x) => { // x is infered to be a number, which is the resolved value of a promise @@ -299,15 +296,15 @@ namespace TestQ { g: string; h: number; } - var tResult: TResult; - var promiseTResult: angular.IPromise; - var tValue: TValue; - var promiseTValue: angular.IPromise; - var tOther: TOther; - var promiseTOther: angular.IPromise; + const tResult: TResult = null; + const promiseTResult: angular.IPromise = null; + const tValue: TValue = null; + const promiseTValue: angular.IPromise = null; + const tOther: TOther = null; + const promiseTOther: angular.IPromise = null; - var $q: angular.IQService; - var promiseAny: angular.IPromise; + const $q: angular.IQService = null; + const promiseAny: angular.IPromise = null; const assertPromiseType = (arg: angular.IPromise) => arg; @@ -346,7 +343,7 @@ namespace TestQ { let result: angular.IDeferred; result = $q.defer(); result.resolve(tResult); - var anyValue: any; + const anyValue: any = null; result.reject(anyValue); result.promise.then(result => { return $q.resolve(result); @@ -411,7 +408,7 @@ namespace TestQ { let httpFoo: ng.IHttpPromise; httpFoo.then((x) => { // When returning a promise the generic type must be inferred. - var innerPromise: ng.IPromise; + const innerPromise: ng.IPromise = null; return innerPromise; }).then((x) => { // must still be number. @@ -427,16 +424,16 @@ httpFoo.then((response: ng.IHttpPromiseCallbackArg) => { // Deferred signature tests namespace TestDeferred { - var any: any; + const any: any = null; interface TResult { a: number; b: string; c: boolean; } - var tResult: TResult; + const tResult: TResult = null; - var deferred: angular.IDeferred; + const deferred: angular.IDeferred = null; // deferred.resolve { @@ -467,7 +464,7 @@ namespace TestDeferred { } namespace TestInjector { - var $injector: angular.auto.IInjectorService; + const $injector: angular.auto.IInjectorService = null; $injector.strictDi = true; @@ -477,7 +474,7 @@ namespace TestInjector { // Promise signature tests namespace TestPromise { - var any: any; + const any: any = null; interface TResult { kind: 'result'; @@ -497,16 +494,16 @@ namespace TestPromise { return x.kind === 'result'; } - var tresult: TResult; - var tresultPromise: ng.IPromise; - var tresultHttpPromise: ng.IHttpPromise; + const tresult: TResult = null; + const tresultPromise: ng.IPromise = null; + const tresultHttpPromise: ng.IHttpPromise = null; - var tother: TOther; - var totherPromise: ng.IPromise; - var totherHttpPromise: ng.IHttpPromise; + const tother: TOther = null; + const totherPromise: ng.IPromise = null; + const totherHttpPromise: ng.IHttpPromise = null; - var promise: angular.IPromise; - var $q: angular.IQService; + const promise: angular.IPromise = null; + const $q: angular.IQService = null; const assertPromiseType = (arg: angular.IPromise) => arg; const reject = $q.reject(); @@ -608,9 +605,9 @@ namespace TestTimeout { b: string; c: boolean; } - var fnTResult: (...args: any[]) => TResult; - var promiseAny: angular.IPromise; - var $timeout: angular.ITimeoutService; + const fnTResult: (...args: any[]) => TResult = null; + const promiseAny: angular.IPromise = null; + const $timeout: angular.ITimeoutService = null; // $timeout { @@ -670,9 +667,7 @@ class SampleDirective implements ng.IDirective { return new SampleDirective(); } - link(scope: ng.IScope) { - - } + link(scope: ng.IScope) {} } class SampleDirective2 implements ng.IDirective { @@ -688,9 +683,7 @@ class SampleDirective2 implements ng.IDirective { return new SampleDirective2(); } - link(scope: ng.IScope) { - - } + link(scope: ng.IScope) {} } angular.module('SameplDirective', []).directive('sampleDirective', SampleDirective.instance).directive('sameplDirective2', SampleDirective2.instance); @@ -825,7 +818,6 @@ angular.module('docsTimeDirective', []) $scope.format = 'M/d/yy h:mm:ss a'; }]) .directive('myCurrentTime', ['$interval', 'dateFilter', ($interval: any, dateFilter: any) => { - return { link(scope: ng.IScope, element: ng.IAugmentedJQuery, attrs: ng.IAttributes) { let format: any, @@ -1030,11 +1022,10 @@ interface ICopyExampleUser { } interface ICopyExampleScope { - user: ICopyExampleUser; master: ICopyExampleUser; - update: (copyExampleUser: ICopyExampleUser) => any; - reset: () => any; + update(copyExampleUser: ICopyExampleUser): any; + reset(): any; } angular.module('copyExample', []) @@ -1055,8 +1046,7 @@ angular.module('copyExample', []) }]); namespace locationTests { - - var $location: ng.ILocationService; + const $location: ng.ILocationService = null; /* * From https://docs.angularjs.org/api/ng/service/$location @@ -1114,9 +1104,9 @@ namespace locationTests { // NgModelController function NgModelControllerTyping() { - var ngModel: angular.INgModelController; - var $http: angular.IHttpService; - var $q: angular.IQService; + const ngModel: angular.INgModelController = null; + const $http: angular.IHttpService = null; + const $q: angular.IQService = null; // See https://docs.angularjs.org/api/ng/type/ngModel.NgModelController#$validators ngModel.$validators['validCharacters'] = (modelValue, viewValue) => { @@ -1141,8 +1131,7 @@ function NgModelControllerTyping() { let $filter: angular.IFilterService; function testFilter() { - - var items: string[]; + const items: string[] = null; $filter('filter')(items, 'test'); $filter('filter')(items, {name: 'test'}); $filter('filter')(items, (val, index, array) => { @@ -1224,7 +1213,7 @@ function testCustomFilter() { } function parseTyping() { - var $parse: angular.IParseService; + const $parse: angular.IParseService = null; const compiledExp = $parse('a.b.c'); if (compiledExp.constant) { return compiledExp({}); @@ -1234,7 +1223,7 @@ function parseTyping() { } function parseWithParams() { - var $parse: angular.IParseService; + const $parse: angular.IParseService = null; const compiledExp1 = $parse('a.b.c', () => null); const compiledExp2 = $parse('a.b.c', null, false); } @@ -1255,7 +1244,7 @@ function doBootstrap(element: Element | JQuery, mode: string): ng.auto.IInjector } function testIHttpParamSerializerJQLikeProvider() { - var serializer: angular.IHttpParamSerializer; + const serializer: angular.IHttpParamSerializer = null; serializer({ a: 'b' }); @@ -1271,6 +1260,6 @@ function anyOf3(v1: T1, v2: T2, v3: T3) { } function toPromise(val: T): ng.IPromise { - var p: ng.IPromise; + const p: ng.IPromise = null; return p; } diff --git a/types/angular/index.d.ts b/types/angular/index.d.ts index 485ad9ebb3..6ff43a5290 100644 --- a/types/angular/index.d.ts +++ b/types/angular/index.d.ts @@ -782,7 +782,7 @@ declare namespace angular { // Check angular's i18n files for exemples NUMBER_FORMATS: ILocaleNumberFormatDescriptor; DATETIME_FORMATS: ILocaleDateTimeFormatDescriptor; - pluralCat: (num: any) => string; + pluralCat(num: any): string; } interface ILocaleNumberFormatDescriptor { @@ -1591,10 +1591,10 @@ declare namespace angular { } interface IHttpInterceptor { - request?: (config: IRequestConfig) => IRequestConfig|IPromise; - requestError?: (rejection: any) => any; - response?: (response: IHttpPromiseCallbackArg) => IPromise>|IHttpPromiseCallbackArg; - responseError?: (rejection: any) => any; + request?(config: IRequestConfig): IRequestConfig|IPromise; + requestError?(rejection: any): any; + response?(response: IHttpPromiseCallbackArg): IPromise>|IHttpPromiseCallbackArg; + responseError?(rejection: any): any; } interface IHttpInterceptorFactory { @@ -2025,7 +2025,6 @@ declare namespace angular { service(name: string, inlineAnnotatedFunction: any[]): IServiceProvider; value(name: string, value: any): IServiceProvider; } - } /** diff --git a/types/angular/tslint.json b/types/angular/tslint.json index 7ba374959e..196218148d 100644 --- a/types/angular/tslint.json +++ b/types/angular/tslint.json @@ -2,32 +2,16 @@ "extends": "../tslint.json", "rules": { "class-name": true, - "curly": true, - "max-line-length": false, - "no-consecutive-blank-lines": true, - "no-shadowed-variable": true, - "quotemark": [ - true, - "single" - ], - "align": true, + "indent": [true, "spaces"], + "quotemark": [true, "single"], + "variable-name": [true, "check-format"], + "callable-types": false, - "forbidden-types": false, - "indent": [ - true, - "spaces" - ], + "ban-types": false, "interface-name": false, - "linebreak-style": [ - true, - "LF" - ], "no-empty-interface": false, + "max-line-length": false, "unified-signatures": false, - "variable-name": [ - true, - "check-format" - ], "void-return": false } } diff --git a/types/auth0-lock/package.json b/types/auth0-lock/package.json deleted file mode 100644 index 2d730992af..0000000000 --- a/types/auth0-lock/package.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "dependencies": { - "@types/auth0-js": "latest" - } -} diff --git a/types/auth0.widget/package.json b/types/auth0.widget/package.json deleted file mode 100644 index 2d730992af..0000000000 --- a/types/auth0.widget/package.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "dependencies": { - "@types/auth0-js": "latest" - } -} diff --git a/types/aws-lambda-mock-context/aws-lambda-mock-context-tests.ts b/types/aws-lambda-mock-context/aws-lambda-mock-context-tests.ts index f6bcfad5bc..09e121a776 100644 --- a/types/aws-lambda-mock-context/aws-lambda-mock-context-tests.ts +++ b/types/aws-lambda-mock-context/aws-lambda-mock-context-tests.ts @@ -1,4 +1,4 @@ -import { context } from "aws-lambda-mock-context"; +import context = require("aws-lambda-mock-context"); import * as Alexa from "alexa-sdk"; const launchRequestJson: any = { diff --git a/types/aws-lambda-mock-context/index.d.ts b/types/aws-lambda-mock-context/index.d.ts index 250dc9b681..0ccd43c876 100644 --- a/types/aws-lambda-mock-context/index.d.ts +++ b/types/aws-lambda-mock-context/index.d.ts @@ -5,6 +5,8 @@ declare function context(options?: Options): Context; +export = context; + interface Context { Promise: Promise; callbackWaitsForEmptyEventLoop: boolean; @@ -30,5 +32,3 @@ interface Options { memoryLimitInMB: string; alias?: string; } - -export { context }; \ No newline at end of file diff --git a/types/base64-js/base64-js-tests.ts b/types/base64-js/base64-js-tests.ts index 13c3f705b5..402ce43e88 100644 --- a/types/base64-js/base64-js-tests.ts +++ b/types/base64-js/base64-js-tests.ts @@ -1,5 +1,5 @@ import * as base64js from "base64-js"; -const length: number = base64js.byteLength(""); -const bytes: Uint8Array = base64js.toByteArray(""); -const decoded: string = base64js.fromByteArray(new Uint8Array(0)); +base64js.byteLength(""); // $ExpectType number +base64js.toByteArray(""); // $ExpectType Uint8Array +base64js.fromByteArray(new Uint8Array(0)); // $ExpectTpe string diff --git a/types/bluebird-global/bluebird-global-tests.ts b/types/bluebird-global/bluebird-global-tests.ts index 43d5fee050..0464b188cd 100644 --- a/types/bluebird-global/bluebird-global-tests.ts +++ b/types/bluebird-global/bluebird-global-tests.ts @@ -7,7 +7,6 @@ function testSomeStaticMethods() { function testFunctionReturningPromise() { function functionReturningPromise(): Promise { return new Promise((resolve, reject, onCancel) => { - if (onCancel) { onCancel(() => { console.log("onCancel cleanup"); @@ -40,5 +39,4 @@ function testPromiseRejection() { .then((value) => { return value.toUpperCase(); }); - } diff --git a/types/bluebird-global/tslint.json b/types/bluebird-global/tslint.json index b03221674a..37c90f2397 100644 --- a/types/bluebird-global/tslint.json +++ b/types/bluebird-global/tslint.json @@ -5,6 +5,6 @@ "no-empty-interface": false, "array-type": false, "unified-signatures": false, - "forbidden-types": false + "ban-types": false } } diff --git a/types/charm/charm-tests.ts b/types/charm/charm-tests.ts index afc8cbc3b6..d87a360084 100644 --- a/types/charm/charm-tests.ts +++ b/types/charm/charm-tests.ts @@ -3,15 +3,15 @@ const charm = getCharm(); charm.pipe(process.stdout); charm.reset(); -var colors: getCharm.CharmColor[] = [ 'red', 'cyan', 'yellow', 'green', 'blue' ]; -var text = 'Always after me lucky charms.'; +const colors: getCharm.CharmColor[] = [ 'red', 'cyan', 'yellow', 'green', 'blue' ]; +const text = 'Always after me lucky charms.'; -var offset = 0; -var iv = setInterval(() => { - var y = 0, dy = 1; - for (var i = 0; i < 40; i++) { - var color = colors[(i + offset) % colors.length]; - var c = text[(i + offset) % text.length]; +let offset = 0; +const iv = setInterval(() => { + let y = 0, dy = 1; + for (let i = 0; i < 40; i++) { + const color = colors[(i + offset) % colors.length]; + const c = text[(i + offset) % text.length]; charm .move(1, dy) .foreground(color) diff --git a/types/charm/tslint.json b/types/charm/tslint.json index f05741c59b..b0e7084e94 100644 --- a/types/charm/tslint.json +++ b/types/charm/tslint.json @@ -1,6 +1,6 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false + "ban-types": false } } diff --git a/types/co-views/tslint.json b/types/co-views/tslint.json index f05741c59b..b0e7084e94 100644 --- a/types/co-views/tslint.json +++ b/types/co-views/tslint.json @@ -1,6 +1,6 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false + "ban-types": false } } diff --git a/types/core-decorators/index.d.ts b/types/core-decorators/index.d.ts index d0a51009eb..4af9fd5fa5 100644 --- a/types/core-decorators/index.d.ts +++ b/types/core-decorators/index.d.ts @@ -49,87 +49,68 @@ export interface Console { * Forces invocations of this function to always have this refer to the class instance, * even if the function is passed around or would otherwise lose its this context. e.g. var fn = context.method; */ -declare var autobind: Function; +export const autobind: Function; /** * Marks a property or method as not being writable. */ -declare var readonly: PropertyOrMethodDecorator; +export const readonly: PropertyOrMethodDecorator; /** * Checks that the marked method indeed overrides a function with the same signature somewhere on the prototype chain. */ -declare var override: MethodDecorator; +export const override: MethodDecorator; /** * Calls console.warn() with a deprecation message. Provide a custom message to override the default one. You can also provide an options hash with a url, for further reading. */ -declare var deprecate: Deprecate; +export const deprecate: Deprecate; /** * Calls console.warn() with a deprecation message. Provide a custom message to override the default one. You can also provide an options hash with a url, for further reading. */ -declare var deprecated: Deprecate; +export const deprecated: Deprecate; /** * Creates a new debounced function which will be invoked after wait milliseconds since the time it was invoked. Default timeout is 300 ms. */ -declare var debounce: (wait: number) => MethodDecorator; +export function debounce(wait: number): MethodDecorator; /** * Creates a new throttled function which will be invoked in every wait milliseconds. Default timeout is 300 ms. */ -declare var throttle: (wait: number, options?: ThrottleOptions) => MethodDecorator; +export function throttle(wait: number, options?: ThrottleOptions): MethodDecorator; /** * Suppresses any JavaScript console.warn() call while the decorated function is called. (i.e. on the stack) */ -declare var suppressWarnings: MethodDecorator; +export const suppressWarnings: MethodDecorator; /** * Marks a property or method as not being enumerable. */ -declare var nonenumerable: PropertyOrMethodDecorator; +export const nonenumerable: PropertyOrMethodDecorator; /** * Marks a property or method as not being writable. */ -declare var nonconfigurable: PropertyOrMethodDecorator; +export const nonconfigurable: PropertyOrMethodDecorator; /** * Initial implementation included, likely slow. WIP. */ -declare var memoize: MethodDecorator; +export const memoize: MethodDecorator; /** * Immediately applies the provided function and arguments to the method, allowing you to wrap methods with arbitrary helpers like those provided by lodash. * The first argument is the function to apply, all further arguments will be passed to that decorating function. */ -declare var decorate: (func: Function, ...args: any[]) => MethodDecorator; +export function decorate(func: Function, ...args: any[]): MethodDecorator; /** * Prevents a property initializer from running until the decorated property is actually looked up. * Useful to prevent excess allocations that might otherwise not be used, but be careful not to over-optimize things. */ -declare var lazyInitialize: PropertyDecorator; +export const lazyInitialize: PropertyDecorator; /** * Mixes in all property descriptors from the provided Plain Old JavaScript Objects (aka POJOs) as arguments. * Mixins are applied in the order they are passed, but do not override descriptors already on the class, including those inherited traditionally. */ -declare var mixin: (...mixins: any[]) => ClassDecorator; +export function mixin(...mixins: any[]): ClassDecorator; /** * Mixes in all property descriptors from the provided Plain Old JavaScript Objects (aka POJOs) as arguments. * Mixins are applied in the order they are passed, but do not override descriptors already on the class, including those inherited traditionally. */ -declare var mixins: (...mixins: any[]) => ClassDecorator; +export function mixins(...mixins: any[]): ClassDecorator; /** * Uses console.time and console.timeEnd to provide function timings with a unique label whose default prefix is ClassName.method. Supply a first argument to override the prefix: */ -declare var time: (label: string, console?: Console) => MethodDecorator; - -export { -autobind, -readonly, -override, -deprecate, -deprecated, -debounce, -throttle, -suppressWarnings, -nonenumerable, -nonconfigurable, -memoize, -decorate, -lazyInitialize, -mixin, -mixins, -time, -}; +export function time(label: string, console?: Console): MethodDecorator; diff --git a/types/core-decorators/tslint.json b/types/core-decorators/tslint.json index 0332a8383e..caa1fde509 100644 --- a/types/core-decorators/tslint.json +++ b/types/core-decorators/tslint.json @@ -2,6 +2,6 @@ "extends": "../tslint.json", "rules": { "callable-types": false, - "forbidden-types": false + "ban-types": false } } diff --git a/types/core-js/index.d.ts b/types/core-js/index.d.ts index 0bbe4974ae..dc37560d4d 100644 --- a/types/core-js/index.d.ts +++ b/types/core-js/index.d.ts @@ -927,7 +927,7 @@ declare module "core-js/fn/function" { export = Function; } declare module "core-js/fn/function/has-instance" { - const hasInstance: (value: any) => boolean; + function hasInstance(value: any): boolean; export = hasInstance; } declare module "core-js/fn/function/name" { @@ -1706,7 +1706,7 @@ declare module "core-js/library/fn/function" { export = Function; } declare module "core-js/library/fn/function/has-instance" { - const hasInstance: (value: any) => boolean; + function hasInstance(value: any): boolean; export = hasInstance; } declare module "core-js/library/fn/function/name" { diff --git a/types/core-js/tslint.json b/types/core-js/tslint.json index 0f47deabb4..3bfbe8c142 100644 --- a/types/core-js/tslint.json +++ b/types/core-js/tslint.json @@ -1,6 +1,6 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false + "ban-types": false } } \ No newline at end of file diff --git a/types/ember/tslint.json b/types/ember/tslint.json index fcd9410184..c91d42f0b2 100644 --- a/types/ember/tslint.json +++ b/types/ember/tslint.json @@ -2,7 +2,7 @@ "extends": "../tslint.json", "rules": { // Heavy use of Function type in this older package. - "forbidden-types": false, + "ban-types": false, "no-misused-new": false, // not sure what this means "no-single-declare-module": false diff --git a/types/fabric/index.d.ts b/types/fabric/index.d.ts index 27a4188f52..18b9c41e82 100644 --- a/types/fabric/index.d.ts +++ b/types/fabric/index.d.ts @@ -933,7 +933,7 @@ interface IStaticCanvasOptions { * Function that determines clipping of entire canvas area * Being passed context as first argument. See clipping canvas area */ - clipTo?: (context: CanvasRenderingContext2D) => void; + clipTo?(context: CanvasRenderingContext2D): void; /** * Indicates whether object controls (borders/controls) are rendered above overlay image diff --git a/types/fabric/tslint.json b/types/fabric/tslint.json index 525190cf34..4702666135 100644 --- a/types/fabric/tslint.json +++ b/types/fabric/tslint.json @@ -2,7 +2,7 @@ "extends": "../tslint.json", "rules": { "adjacent-overload-signatures": false, - "forbidden-types": false, + "ban-types": false, "interface-name": false, "no-empty-interface": false, "unified-signatures": false diff --git a/types/fs-promise/fs-promise-tests.ts b/types/fs-promise/fs-promise-tests.ts index 43decbd256..51da06bb05 100644 --- a/types/fs-promise/fs-promise-tests.ts +++ b/types/fs-promise/fs-promise-tests.ts @@ -1,19 +1,19 @@ import * as fs from "fs-promise"; -var src: string; -var dst: string; -var dir: string; -var path: string; -var data: any; -var writeOptions: fs.WriteOptions; -var writeJsonOptions: fs.WriteJsonOptions = { +let src: string; +let dst: string; +let dir: string; +let path: string; +let data: any; +let writeOptions: fs.WriteOptions; +const writeJsonOptions: fs.WriteJsonOptions = { spaces: 2, replacer(key, value) { src = key; return value; } }; -var readJsonOptions: fs.ReadJsonOptions; +let readJsonOptions: fs.ReadJsonOptions; async function test() { await fs.copy(src, dst); diff --git a/types/fs-promise/index.d.ts b/types/fs-promise/index.d.ts index 2038190ca1..6455018e5c 100644 --- a/types/fs-promise/index.d.ts +++ b/types/fs-promise/index.d.ts @@ -27,7 +27,7 @@ export interface WriteJsonOptions extends WriteOptions { export interface ReadJsonOptions { encoding: string; flag?: string; - reviver: (key: any, value: any) => any; + reviver(key: any, value: any): any; } export function copy(src: string, dst: string): Promise; diff --git a/types/fullcalendar/index.d.ts b/types/fullcalendar/index.d.ts index 5d6401b9df..76a5de13f3 100644 --- a/types/fullcalendar/index.d.ts +++ b/types/fullcalendar/index.d.ts @@ -55,10 +55,10 @@ export interface Options extends AgendaOptions, EventDraggingResizingOptions, Dr aspectRatio?: number; handleWindowResize?: boolean; views?: ViewSpecificOptions; - viewRender?: (view: ViewObject, element: JQuery) => void; - viewDestroy?: (view: ViewObject, element: JQuery) => void; - dayRender?: (date: Date, cell: HTMLTableDataCellElement) => void; - windowResize?: (view: ViewObject) => void; + viewRender?(view: ViewObject, element: JQuery): void; + viewDestroy?(view: ViewObject, element: JQuery): void; + dayRender?(date: Date, cell: HTMLTableDataCellElement): void; + windowResize?(view: ViewObject): void; // Timezone timezone?: string | boolean; @@ -90,10 +90,10 @@ export interface Options extends AgendaOptions, EventDraggingResizingOptions, Dr // Clicking & Hovering - http://fullcalendar.io/docs/mouse/ - dayClick?: (date: Date, allDay: boolean, jsEvent: MouseEvent, view: ViewObject) => void; - eventClick?: (event: EventObject, jsEvent: MouseEvent, view: ViewObject) => any; // return type boolean or void - eventMouseover?: (event: EventObject, jsEvent: MouseEvent, view: ViewObject) => void; - eventMouseout?: (event: EventObject, jsEvent: MouseEvent, view: ViewObject) => void; + dayClick?(date: Date, allDay: boolean, jsEvent: MouseEvent, view: ViewObject): void; + eventClick?(event: EventObject, jsEvent: MouseEvent, view: ViewObject): any; // return type boolean or void + eventMouseover?(event: EventObject, jsEvent: MouseEvent, view: ViewObject): void; + eventMouseout?(event: EventObject, jsEvent: MouseEvent, view: ViewObject): void; // Event Data - http://fullcalendar.io/docs/event_data/ @@ -120,8 +120,8 @@ export interface Options extends AgendaOptions, EventDraggingResizingOptions, Dr startParam?: string; endParam?: string; lazyFetching?: boolean; - eventDataTransform?: (eventData: any) => EventObject; - loading?: (isLoading: boolean, view: ViewObject) => void; + eventDataTransform?(eventData: any): EventObject; + loading?(isLoading: boolean, view: ViewObject): void; eventLimit?: boolean; // Event Rendering - http://fullcalendar.io/docs/event_rendering/ @@ -130,10 +130,10 @@ export interface Options extends AgendaOptions, EventDraggingResizingOptions, Dr eventBackgroundColor?: string; eventBorderColor?: string; eventTextColor?: string; - eventRender?: (event: EventObject, element: HTMLDivElement, view: ViewObject) => void; - eventAfterRender?: (event: EventObject, element: HTMLDivElement, view: ViewObject) => void; - eventAfterAllRender?: (view: ViewObject) => void; - eventDestroy?: (event: EventObject, element: JQuery, view: ViewObject) => void; + eventRender?(event: EventObject, element: HTMLDivElement, view: ViewObject): void; + eventAfterRender?(event: EventObject, element: HTMLDivElement, view: ViewObject): void; + eventAfterAllRender?(view: ViewObject): void; + eventDestroy?(event: EventObject, element: JQuery, view: ViewObject): void; // scheduler options resourceAreaWidth?: number; @@ -172,12 +172,12 @@ export interface EventDraggingResizingOptions { dragScroll?: boolean; eventOverlap?: boolean | ((stillEvent: EventObject, movingEvent: EventObject) => boolean); eventConstraint?: "businessHours" | BusinessHours | Timespan; - eventDragStart?: (event: EventObject, jsEvent: MouseEvent, ui: any, view: ViewObject) => void; - eventDragStop?: (event: EventObject, jsEvent: MouseEvent, ui: any, view: ViewObject) => void; - eventDrop?: (event: EventObject, delta: moment.Duration, revertFunc: Function, jsEvent: Event, ui: any, view: ViewObject) => void; - eventResizeStart?: (event: EventObject, jsEvent: MouseEvent, ui: any, view: ViewObject) => void; - eventResizeStop?: (event: EventObject, jsEvent: MouseEvent, ui: any, view: ViewObject) => void; - eventResize?: (event: EventObject, delta: moment.Duration, revertFunc: Function, jsEvent: Event, ui: any, view: ViewObject) => void; + eventDragStart?(event: EventObject, jsEvent: MouseEvent, ui: any, view: ViewObject): void; + eventDragStop?(event: EventObject, jsEvent: MouseEvent, ui: any, view: ViewObject): void; + eventDrop?(event: EventObject, delta: moment.Duration, revertFunc: Function, jsEvent: Event, ui: any, view: ViewObject): void; + eventResizeStart?(event: EventObject, jsEvent: MouseEvent, ui: any, view: ViewObject): void; + eventResizeStop?(event: EventObject, jsEvent: MouseEvent, ui: any, view: ViewObject): void; + eventResize?(event: EventObject, delta: moment.Duration, revertFunc: Function, jsEvent: Event, ui: any, view: ViewObject): void; } /* * Selection - http://fullcalendar.io/docs/selection/ @@ -189,15 +189,15 @@ export interface SelectionOptions { unselectCancel?: string; selectOverlap?: boolean | ((event: EventObject) => boolean); selectConstraint?: Timespan | BusinessHours; - select?: (start: moment.Moment, end: moment.Moment, jsEvent: MouseEvent, view: ViewObject, resource?: any) => void; - unselect?: (view: ViewObject, jsEvent: Event) => void; + select?(start: moment.Moment, end: moment.Moment, jsEvent: MouseEvent, view: ViewObject, resource?: any): void; + unselect?(view: ViewObject, jsEvent: Event): void; } export interface DroppingExternalElementsOptions { droppable?: boolean; dropAccept?: string | ((draggable: any) => boolean); - drop?: (date: moment.Moment, jsEvent: MouseEvent, ui: any) => void; - eventReceive?: (event: EventObject) => void; + drop?(date: moment.Moment, jsEvent: MouseEvent, ui: any): void; + eventReceive?(event: EventObject): void; } export interface ButtonTextObject { diff --git a/types/fullcalendar/tslint.json b/types/fullcalendar/tslint.json index fe03bea79d..6e33505955 100644 --- a/types/fullcalendar/tslint.json +++ b/types/fullcalendar/tslint.json @@ -1,7 +1,7 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false, + "ban-types": false, "unified-signatures": false } } diff --git a/types/fullcalendar/v1/index.d.ts b/types/fullcalendar/v1/index.d.ts index 4fcb41731b..4c8a5dc65a 100644 --- a/types/fullcalendar/v1/index.d.ts +++ b/types/fullcalendar/v1/index.d.ts @@ -71,10 +71,10 @@ declare global { contentHeight?: number; aspectRatio?: number; handleWindowResize?: boolean; - viewRender?: (view: ViewObject, element: JQuery) => void; - viewDestroy?: (view: ViewObject, element: JQuery) => void; - dayRender?: (date: Date, cell: HTMLTableDataCellElement) => void; - windowResize?: (view: ViewObject) => void; + viewRender?(view: ViewObject, element: JQuery): void; + viewDestroy?(view: ViewObject, element: JQuery): void; + dayRender?(date: Date, cell: HTMLTableDataCellElement): void; + windowResize?(view: ViewObject): void; // Timezone timezone?: string | boolean; @@ -106,10 +106,10 @@ declare global { // Clicking & Hovering - http://arshaw.com/fullcalendar/docs/mouse/ - dayClick?: (date: Date, allDay: boolean, jsEvent: MouseEvent, view: ViewObject) => void; - eventClick?: (event: EventObject, jsEvent: MouseEvent, view: ViewObject) => any; // return type boolean or void - eventMouseover?: (event: EventObject, jsEvent: MouseEvent, view: ViewObject) => void; - eventMouseout?: (event: EventObject, jsEvent: MouseEvent, view: ViewObject) => void; + dayClick?(date: Date, allDay: boolean, jsEvent: MouseEvent, view: ViewObject): void; + eventClick?(event: EventObject, jsEvent: MouseEvent, view: ViewObject): any; // return type boolean or void + eventMouseover?(event: EventObject, jsEvent: MouseEvent, view: ViewObject): void; + eventMouseout?(event: EventObject, jsEvent: MouseEvent, view: ViewObject): void; // Event Data - http://arshaw.com/fullcalendar/docs/event_data/ @@ -137,8 +137,8 @@ declare global { startParam?: string; endParam?: string; lazyFetching?: boolean; - eventDataTransform?: (eventData: any) => EventObject; - loading?: (isLoading: boolean, view: ViewObject) => void; + eventDataTransform?(eventData: any): EventObject; + loading?(isLoading: boolean, view: ViewObject): void; // Event Rendering - http://arshaw.com/fullcalendar/docs/event_rendering/ @@ -146,10 +146,10 @@ declare global { eventBackgroundColor?: string; eventBorderColor?: string; eventTextColor?: string; - eventRender?: (event: EventObject, element: HTMLDivElement, view: ViewObject) => void; - eventAfterRender?: (event: EventObject, element: HTMLDivElement, view: ViewObject) => void; - eventAfterAllRender?: (view: ViewObject) => void; - eventDestroy?: (event: EventObject, element: JQuery, view: ViewObject) => void; + eventRender?(event: EventObject, element: HTMLDivElement, view: ViewObject): void; + eventAfterRender?(event: EventObject, element: HTMLDivElement, view: ViewObject): void; + eventAfterAllRender?(view: ViewObject): void; + eventDestroy?(event: EventObject, element: JQuery, view: ViewObject): void; } interface ViewOptionHash { @@ -193,12 +193,12 @@ declare global { dragScroll?: boolean; eventOverlap?: boolean | ((stillEvent: EventObject, movingEvent: EventObject) => boolean); eventConstraint?: BusinessHours | Timespan; - eventDragStart?: (event: EventObject, jsEvent: MouseEvent, ui: any, view: ViewObject) => void; - eventDragStop?: (event: EventObject, jsEvent: MouseEvent, ui: any, view: ViewObject) => void; - eventDrop?: (event: EventObject, delta: moment.Duration, revertFunc: Function, jsEvent: Event, ui: any, view: ViewObject) => void; - eventResizeStart?: (event: EventObject, jsEvent: MouseEvent, ui: any, view: ViewObject) => void; - eventResizeStop?: (event: EventObject, jsEvent: MouseEvent, ui: any, view: ViewObject) => void; - eventResize?: (event: EventObject, delta: moment.Duration, revertFunc: Function, jsEvent: Event, ui: any, view: ViewObject) => void; + eventDragStart?(event: EventObject, jsEvent: MouseEvent, ui: any, view: ViewObject): void; + eventDragStop?(event: EventObject, jsEvent: MouseEvent, ui: any, view: ViewObject): void; + eventDrop?(event: EventObject, delta: moment.Duration, revertFunc: Function, jsEvent: Event, ui: any, view: ViewObject): void; + eventResizeStart?(event: EventObject, jsEvent: MouseEvent, ui: any, view: ViewObject): void; + eventResizeStop?(event: EventObject, jsEvent: MouseEvent, ui: any, view: ViewObject): void; + eventResize?(event: EventObject, delta: moment.Duration, revertFunc: Function, jsEvent: Event, ui: any, view: ViewObject): void; } /* * Selection - http://arshaw.com/fullcalendar/docs/selection/ @@ -210,15 +210,15 @@ declare global { unselectCancel?: string; selectOverlap?: boolean | ((event: EventObject) => boolean); selectConstraint?: Timespan | BusinessHours; - select?: (start: moment.Moment, end: moment.Moment, jsEvent: MouseEvent, view: ViewObject, resource?: any) => void; - unselect?: (view: ViewObject, jsEvent: Event) => void; + select?(start: moment.Moment, end: moment.Moment, jsEvent: MouseEvent, view: ViewObject, resource?: any): void; + unselect?(view: ViewObject, jsEvent: Event): void; } interface DroppingExternalElementsOptions { droppable?: boolean; dropAccept?: string | ((draggable: any) => boolean); - drop?: (date: moment.Moment, jsEvent: MouseEvent, ui: any) => void; - eventReceive?: (event: EventObject) => void; + drop?(date: moment.Moment, jsEvent: MouseEvent, ui: any): void; + eventReceive?(event: EventObject): void; } interface ButtonTextObject { diff --git a/types/fullcalendar/v1/tslint.json b/types/fullcalendar/v1/tslint.json index fe03bea79d..6e33505955 100644 --- a/types/fullcalendar/v1/tslint.json +++ b/types/fullcalendar/v1/tslint.json @@ -1,7 +1,7 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false, + "ban-types": false, "unified-signatures": false } } diff --git a/types/google.analytics/index.d.ts b/types/google.analytics/index.d.ts index c8bf91fd74..088ce364e1 100644 --- a/types/google.analytics/index.d.ts +++ b/types/google.analytics/index.d.ts @@ -292,7 +292,7 @@ declare namespace UniversalAnalytics { expVar?: string; flashVersion?: string; forceSSL?: boolean; - hitCallback?: () => void; + hitCallback?(): void; hitType?: string; hostname?: string; id?: string; diff --git a/types/google.analytics/tslint.json b/types/google.analytics/tslint.json index e8bc207e33..de20a402c4 100644 --- a/types/google.analytics/tslint.json +++ b/types/google.analytics/tslint.json @@ -2,7 +2,7 @@ "extends": "../tslint.json", "rules": { "dt-header": false, - "forbidden-types": false, + "ban-types": false, "unified-signatures": false } } diff --git a/types/googlemaps/index.d.ts b/types/googlemaps/index.d.ts index 5f25ea0cab..41da96d754 100644 --- a/types/googlemaps/index.d.ts +++ b/types/googlemaps/index.d.ts @@ -835,24 +835,52 @@ declare namespace google.maps { getVisible(): boolean; setDraggable(draggable: boolean): void; setEditable(editable: boolean): void; - setMap(map: Map | null): void; + setMap(map: Map | null): void; setOptions(options: PolylineOptions): void; setPath(path: MVCArray|LatLng[]|LatLngLiteral[]): void; // MVCArray|Array setVisible(visible: boolean): void; } export interface PolylineOptions { + /** Indicates whether this Polyline handles mouse events. Defaults to true. */ clickable?: boolean; + /** + * If set to true, the user can drag this shape over the map. + * The geodesic property defines the mode of dragging. Defaults to false. + */ draggable?: boolean; + /** + * If set to true, the user can edit this shape by dragging the control points shown at the vertices and on + * each segment. Defaults to false. + */ editable?: boolean; + /** + * When true, edges of the polygon are interpreted as geodesic and will follow the curvature of the Earth. + * When false, edges of the polygon are rendered as straight lines in screen space. Note that the shape of a + * geodesic polygon may appear to change when dragged, as the dimensions are maintained relative to the + * surface of the earth. Defaults to false. + */ geodesic?: boolean; + /** The icons to be rendered along the polyline. */ icons?: IconSequence[]; + /** Map on which to display Polyline. */ map?: Map; + /** + * The ordered sequence of coordinates of the Polyline. + * This path may be specified using either a simple array of LatLngs, or an MVCArray of LatLngs. + * Note that if you pass a simple array, it will be converted to an MVCArray Inserting or removing LatLngs + * in the MVCArray will automatically update the polyline on the map. + */ path?: MVCArray|LatLng[]|LatLngLiteral[]; // MVCArray|Array + /** The stroke color. All CSS3 colors are supported except for extended named colors. */ strokeColor?: string; + /** The stroke opacity between 0.0 and 1.0. */ strokeOpacity?: number; + /** The stroke width in pixels. */ strokeWeight?: number; + /** Whether this polyline is visible on the map. Defaults to true. */ visible?: boolean; + /** The zIndex compared to other polys. */ zIndex?: number; } @@ -873,7 +901,7 @@ declare namespace google.maps { getVisible(): boolean; setDraggable(draggable: boolean): void; setEditable(editable: boolean): void; - setMap(map: Map | null): void; + setMap(map: Map | null): void; setOptions(options: PolygonOptions): void; setPath(path: MVCArray|LatLng[]|LatLngLiteral[]): void; setPaths(paths: MVCArray): void; @@ -959,7 +987,7 @@ declare namespace google.maps { setBounds(bounds: LatLngBounds|LatLngBoundsLiteral): void; setDraggable(draggable: boolean): void; setEditable(editable: boolean): void; - setMap(map: Map | null): void; + setMap(map: Map | null): void; setOptions(options: RectangleOptions): void; setVisible(visible: boolean): void; } @@ -980,38 +1008,75 @@ declare namespace google.maps { zIndex?: number; } + /** A circle on the Earth's surface; also known as a "spherical cap". */ export class Circle extends MVCObject { + /** Create a circle using the passed CircleOptions, which specify the center, radius, and style. */ constructor(opts?: CircleOptions); + /** Gets the LatLngBounds of this Circle. */ getBounds(): LatLngBounds; + /** Returns the center of this circle. */ getCenter(): LatLng; + /** Returns whether this circle can be dragged by the user. */ getDraggable(): boolean; + /** Returns whether this circle can be edited by the user. */ getEditable(): boolean; + /** Returns the map on which this circle is displayed. */ getMap(): Map; + /** Returns the radius of this circle (in meters). */ getRadius(): number; + /** Returns whether this circle is visible on the map. */ getVisible(): boolean; + /** Sets the center of this circle. */ setCenter(center: LatLng|LatLngLiteral): void; + /** If set to true, the user can drag this circle over the map. */ setDraggable(draggable: boolean): void; + /** + * If set to true, the user can edit this circle by dragging the control points shown at the center and around + * the circumference of the circle. + */ setEditable(editable: boolean): void; - setMap(map: Map | null): void; + /** Renders the circle on the specified map. If map is set to null, the circle will be removed. */ + setMap(map: Map | null): void; setOptions(options: CircleOptions): void; + /** Sets the radius of this circle (in meters). */ setRadius(radius: number): void; + /** Hides this circle if set to false. */ setVisible(visible: boolean): void; } export interface CircleOptions { + /** The center */ center?: LatLng|LatLngLiteral; + /** Indicates whether this Circle handles mouse events. Defaults to true. */ clickable?: boolean; + /** If set to true, the user can drag this circle over the map. Defaults to false. */ draggable?: boolean; + /** + * If set to true, the user can edit this circle by dragging the control points shown at the center and around + * the circumference of the circle. Defaults to false. + */ editable?: boolean; + /** The fill color. All CSS3 colors are supported except for extended named colors. */ fillColor?: string; + /** The fill opacity between 0.0 and 1.0 */ fillOpacity?: number; + /** Map on which to display Circle. */ map?: Map; + /** The radius in meters on the Earth's surface */ radius?: number; + /** The stroke color. All CSS3 colors are supported except for extended named colors. */ strokeColor?: string; + /** The stroke opacity between 0.0 and 1.0 */ strokeOpacity?: number; + /** + * The stroke position. Defaults to CENTER. This property is not supported on Internet Explorer 8 and earlier. + */ strokePosition?: StrokePosition; + /** The stroke width in pixels. */ strokeWeight?: number; + /** Whether this circle is visible on the map. Defaults to true. */ visible?: boolean; + /** The zIndex compared to other polys. */ zIndex?: number; } @@ -1036,7 +1101,7 @@ declare namespace google.maps { getMap(): Map; getOpacity(): number; getUrl(): string; - setMap(map: Map | null): void; + setMap(map: Map | null): void; setOpacity(opacity: number): void; } @@ -1053,7 +1118,7 @@ declare namespace google.maps { getProjection(): MapCanvasProjection; onAdd(): void; onRemove(): void; - setMap(map: Map | StreetViewPanorama | null): void; + setMap(map: Map | StreetViewPanorama | null): void; } export interface MapPanes { @@ -1144,7 +1209,7 @@ declare namespace google.maps { getPanel(): Element; getRouteIndex(): number; setDirections(directions: DirectionsResult): void; - setMap(map: Map | null): void; + setMap(map: Map | null): void; setOptions(options: DirectionsRendererOptions): void; setPanel(panel: Element): void; setRouteIndex(routeIndex: number): void; @@ -1171,20 +1236,59 @@ declare namespace google.maps { route(request: DirectionsRequest, callback: (result: DirectionsResult, status: DirectionsStatus) => void ): void; } + /** A directions query to be sent to the DirectionsService. */ export interface DirectionsRequest { + /** If true, instructs the Directions service to avoid ferries where possible. Optional. */ avoidFerries?: boolean; + /** If true, instructs the Directions service to avoid highways where possible. Optional. */ avoidHighways?: boolean; + /** If true, instructs the Directions service to avoid toll roads where possible. Optional. */ avoidTolls?: boolean; + /** + * Location of destination. This can be specified as either a string to be geocoded, or a LatLng, + * or a Place. Required. + */ destination?: string|LatLng|Place; - durationInTraffic?: boolean; /* Deprecated. Use drivingOptions field instead */ + /** Deprecated. Use drivingOptions field instead */ + durationInTraffic?: boolean; + /** + * Settings that apply only to requests where travelMode is DRIVING. This object will have no effect + * for other travel modes. + */ drivingOptions?: DrivingOptions; + /** + * If set to true, the DirectionService will attempt to re-order the supplied intermediate waypoints + * to minimize overall cost of the route. If waypoints are optimized, inspect DirectionsRoute.waypoint_order + * in the response to determine the new ordering. + */ optimizeWaypoints?: boolean; + /** + * Location of origin. This can be specified as either a string to be geocoded, or a LatLng, or a Place. + * Required. + */ origin?: string|LatLng|Place; + /** Whether or not route alternatives should be provided. Optional. */ provideRouteAlternatives?: boolean; + /** Region code used as a bias for geocoding requests. Optional. */ region?: string; + /** + * Settings that apply only to requests where travelMode is TRANSIT. This object will have no effect for + * other travel modes. + */ transitOptions?: TransitOptions; + /** Type of routing requested. Required. */ travelMode?: TravelMode; + /** + * Preferred unit system to use when displaying distance. Defaults to the unit system used + * in the country of origin. + */ unitSystem?: UnitSystem; + /** + * Array of intermediate waypoints. Directions will be calculated from the origin to the destination by way + * of each waypoint in this array. The maximum allowed waypoints is 8, plus the origin, and destination. + * Premium Plan customers are allowed 23 waypoints, plus the origin, and destination. + * Waypoints are not supported for transit directions. Optional. + */ waypoints?: DirectionsWaypoint[]; } @@ -1235,8 +1339,20 @@ declare namespace google.maps { PESSIMISTIC } + /** + * A DirectionsWaypoint represents a location between origin and destination + * through which the trip should be routed. + */ export interface DirectionsWaypoint { + /** Waypoint location. Can be an address string, a LatLng, or a Place. Optional. */ location: LatLng|LatLngLiteral|string; + /** + * If true, indicates that this waypoint is a stop between the origin and destination. + * This has the effect of splitting the route into two legs. If false, indicates that the route + * should be biased to go through this waypoint, but not split into two legs. This is useful + * if you want to create a route in response to the user dragging waypoints on a map. + * This value is true by default. Optional. + */ stopover: boolean; } @@ -1255,14 +1371,50 @@ declare namespace google.maps { routes: DirectionsRoute[]; } + /** + * A single route containing a set of legs in a DirectionsResult. + * Note that though this object is "JSON-like," it is not strictly JSON, + * as it directly and indirectly includes LatLng objects. + */ export interface DirectionsRoute { + /** The bounds for this route. */ bounds: LatLngBounds; + /** Copyrights text to be displayed for this route. */ copyrights: string; + /** The total fare for the whole transit trip. Only applicable to transit requests. */ fare: TransitFare; + /** + * An array of DirectionsLegs, each of which contains information about the steps of which it is composed. + * There will be one leg for each stopover waypoint or destination specified. So a route with no stopover + * waypoints will contain one DirectionsLeg and a route with one stopover waypoint will contain two. + */ legs: DirectionsLeg[]; + /** + * An array of LatLngs representing the entire course of this route. The path is simplified in order to make + * it suitable in contexts where a small number of vertices is required (such as Static Maps API URLs). + */ overview_path: LatLng[]; + /** + * An encoded polyline representation of the route in overview_path. + * This polyline is an approximate (smoothed) path of the resulting directions. + */ overview_polyline: string; + /** Warnings to be displayed when showing these directions. */ warnings: string[]; + /** + * If optimizeWaypoints was set to true, this field will contain the re-ordered permutation + * of the input waypoints. For example, if the input was: + * Origin: Los Angeles + * Waypoints: Dallas, Bangor, Phoenix + * Destination: New York + * and the optimized output was ordered as follows: + * Origin: Los Angeles + * Waypoints: Phoenix, Dallas, Bangor + * Destination: New York + * then this field will be an Array containing the values [2, 0, 1]. Note that the numbering of waypoints + * is zero-based. If any of the input waypoints has stopover set to false, this field will be empty, + * since route optimization is not available for such queries. + */ waypoint_order: number[]; } @@ -1624,13 +1776,13 @@ declare namespace google.maps { export class BicyclingLayer extends MVCObject { constructor(); getMap(): Map; - setMap(map: Map | null): void; + setMap(map: Map | null): void; } export class FusionTablesLayer extends MVCObject { constructor(options: FusionTablesLayerOptions); getMap(): Map; - setMap(map: Map | null): void; + setMap(map: Map | null): void; setOptions(options: FusionTablesLayerOptions): void; } @@ -1701,7 +1853,7 @@ declare namespace google.maps { getStatus(): KmlLayerStatus; getUrl(): string; getZIndex(): number; - setMap(map: Map | null): void; + setMap(map: Map | null): void; setUrl(url: string): void; setZIndez(zIndex: number): void; } @@ -1772,7 +1924,7 @@ declare namespace google.maps { export class TransitLayer extends MVCObject { constructor(); getMap(): void; - setMap(map: Map | null): void; + setMap(map: Map | null): void; } /***** Street View *****/ @@ -1904,7 +2056,7 @@ declare namespace google.maps { export class StreetViewCoverageLayer extends MVCObject { getMap(): Map; - setMap(map: Map | null): void; + setMap(map: Map | null): void; } /***** Events *****/ @@ -1953,11 +2105,31 @@ declare namespace google.maps { static trigger(instance: any, eventName: string, ...args: any[]): void; } + /** + * This object is returned from various mouse events on the map and overlays, + * and contains all the fields shown below. + */ export interface MouseEvent { + /** Prevents this event from propagating further. */ stop(): void; + /** The latitude/longitude that was below the cursor when the event occurred. */ latLng: LatLng; } + /** + * This object is sent in an event when a user clicks on an icon on the map. + * The place ID of this place is stored in the placeId member. + * To prevent the default info window from showing up, call the stop() method on this event to prevent it being + * propagated. Learn more about place IDs in the Places API developer guide. + */ + export interface IconMouseEvent extends MouseEvent { + /** + * The place ID of the place that was clicked. + * This place ID can be used to query more information about the feature that was clicked. + */ + placeId: string; + } + /* **** Base **** */ /** @@ -2005,20 +2177,41 @@ declare namespace google.maps { export type LatLngLiteral = { lat: number; lng: number } export type LatLngBoundsLiteral = { east: number; north: number; south: number; west: number } + /** + * A LatLngBounds instance represents a rectangle in geographical coordinates, including one + * that crosses the 180 degrees longitudinal meridian. + */ export class LatLngBounds { + /** Constructs a rectangle from the points at its south-west and north-east corners. */ constructor(sw?: LatLng|LatLngLiteral, ne?: LatLng|LatLngLiteral); + /** Returns true if the given lat/lng is in this bounds. */ contains(latLng: LatLng|LatLngLiteral): boolean; + /** Returns true if this bounds approximately equals the given bounds. */ equals(other: LatLngBounds|LatLngBoundsLiteral): boolean; + /** Extends this bounds to contain the given point. */ extend(point: LatLng|LatLngLiteral): LatLngBounds; + /** Computes the center of this LatLngBounds */ getCenter(): LatLng; + /** Returns the north-east corner of this bounds. */ getNorthEast(): LatLng; + /** Returns the south-west corner of this bounds. */ getSouthWest(): LatLng; + /** Returns true if this bounds shares any points with the other bounds. */ intersects(other: LatLngBounds|LatLngBoundsLiteral): boolean; + /** Returns if the bounds are empty. */ isEmpty(): boolean; + /** Converts to JSON representation. This function is intended to be used via JSON.stringify. */ toJSON(): LatLngBoundsLiteral; + /** Converts the given map bounds to a lat/lng span. */ toSpan(): LatLng; + /** Converts to string. */ toString(): string; + /** + * Returns a string of the form "lat_lo,lng_lo,lat_hi,lng_hi" for this bounds, where "lo" corresponds to the + * southwest corner of the bounding box, while "hi" corresponds to the northeast corner of that box. + */ toUrlValue(precision?: number): string; + /** Extends this bounds to contain the union of this and the given bounds. */ union(other: LatLngBounds|LatLngBoundsLiteral): LatLngBounds; } @@ -2044,16 +2237,39 @@ declare namespace google.maps { } /***** MVC *****/ + /** Base class implementing KVO. */ export class MVCObject { + /** + * The MVCObject constructor is guaranteed to be an empty function, and so you may inherit from MVCObject + * by simply writing MySubclass.prototype = new google.maps.MVCObject();. Unless otherwise noted, + * this is not true of other classes in the API, and inheriting from other classes in the API is not supported. + */ constructor(); + /** + * Adds the given listener function to the given event name. Returns an identifier for this listener + * that can be used with google.maps.event.removeListener. + */ addListener(eventName: string, handler: (...args: any[]) => void): MapsEventListener; + /** Binds a View to a Model. */ bindTo(key: string, target: MVCObject, targetKey?: string, noNotify?: boolean): void; changed(key: string): void; + /** Gets a value. */ get(key: string): any; + /** + * Notify all observers of a change on this property. This notifies both objects that are bound + * to the object's property as well as the object that it is bound to. + */ notify(key: string): void; + /** Sets a value. */ set(key: string, value: any): void; + /** Sets a collection of key-value pairs. */ setValues(values: any): void; + /** + * Removes a binding. Unbinding will set the unbound property to the current value. + * The object will not be notified, as the value has not changed. + */ unbind(key: string): void; + /** Removes all bindings. */ unbindAll(): void; } @@ -2155,7 +2371,7 @@ declare namespace google.maps { setBorderColor(borderColor: string): void; setChannelNumber(channelNumber: string): void; setFormat(format: AdFormat): void; - setMap(map: Map | null): void; + setMap(map: Map | null): void; setPosition(position: ControlPosition): void; setTextColor(textColor: string): void; setTitleColor(titleColor: string): void; @@ -2421,19 +2637,51 @@ declare namespace google.maps { getDrawingMode(): OverlayType; getMap(): Map; setDrawingMode(drawingMode: OverlayType): void; - setMap(map: Map | null): void; + setMap(map: Map | null): void; setOptions(options: DrawingManagerOptions): void; } + /** Options for the drawing manager. */ export interface DrawingManagerOptions { + /** + * Options to apply to any new circles created with this DrawingManager. The center and radius properties + * are ignored, and the map property of a new circle is always set to the DrawingManager's map. + */ circleOptions?: CircleOptions; + /** The enabled/disabled state of the drawing control. Defaults to true. */ drawingControl?: boolean; + /** The display options for the drawing control. */ drawingControlOptions?: DrawingControlOptions; + /** + * The DrawingManager's drawing mode, which defines the type of overlay to be added on the map. + * Accepted values are 'marker', 'polygon', 'polyline', 'rectangle', 'circle', or null. A drawing mode + * of null means that the user can interact with the map as normal, and clicks do not draw anything. + */ drawingMode?: OverlayType; + /** + * The Map to which the DrawingManager is attached, which is the Map on which the overlays created + * will be placed. + */ map?: Map; + /** + * Options to apply to any new markers created with this DrawingManager. The position property is ignored, + * and the map property of a new marker is always set to the DrawingManager's map. + */ markerOptions?: MarkerOptions; + /** + * Options to apply to any new polygons created with this DrawingManager. The paths property is ignored, + * and the map property of a new polygon is always set to the DrawingManager's map. + */ polygonOptions?: PolygonOptions; + /** + * Options to apply to any new polylines created with this DrawingManager. The path property is ignored, + * and the map property of a new polyline is always set to the DrawingManager's map. + */ polylineOptions?: PolylineOptions; + /** + * Options to apply to any new rectangles created with this DrawingManager. The bounds property is ignored, + * and the map property of a new rectangle is always set to the DrawingManager's map. + */ rectangleOptions?: RectangleOptions; } @@ -2442,16 +2690,43 @@ declare namespace google.maps { position?: ControlPosition; } + /** The properties of an overlaycomplete event on a DrawingManager.. */ export interface OverlayCompleteEvent { + /** The completed overlay. */ overlay: Marker|Polygon|Polyline|Rectangle|Circle; + /** The completed overlay's type. */ type: OverlayType; } + /** + * The types of overlay that may be created by the DrawingManager. Specify these by value, or by using the + * constant's name. For example, 'polygon' or google.maps.drawing.OverlayType.POLYGON. + */ export enum OverlayType { + /** + * Specifies that the DrawingManager creates circles, and that the overlay given in the overlaycomplete + * event is a circle. + */ CIRCLE, + /** + * Specifies that the DrawingManager creates markers, and that the overlay given in the overlaycomplete + * event is a marker. + */ MARKER, + /** + * Specifies that the DrawingManager creates polygons, and that the overlay given in the overlaycomplete + * event is a polygon. + */ POLYGON, + /** + * Specifies that the DrawingManager creates polylines, and that the overlay given in the overlaycomplete + * event is a polyline. + */ POLYLINE, + /** + * Specifies that the DrawingManager creates rectangles, and that the overlay given in the overlaycomplete + * event is a rectangle. + */ RECTANGLE } } @@ -2470,7 +2745,7 @@ declare namespace google.maps { getZIndex(): number; setLayerId(layerId: string): void; setLayerKey(layerKey: string): void; - setMap(map: Map | null): void; + setMap(map: Map | null): void; setMapId(mapId: string): void; setOpacity(opacity: number): void; setOptions(options: MapsEngineLayerOptions): void; @@ -2514,7 +2789,7 @@ declare namespace google.maps { setData(data: MVCArray): void; setData(data: LatLng[]): void; setData(data: WeightedLocation[]): void; - setMap(map: Map | null): void; + setMap(map: Map | null): void; } export interface HeatmapLayerOptions { diff --git a/types/handsontable/index.d.ts b/types/handsontable/index.d.ts index ed2f0db27f..ea57730f93 100644 --- a/types/handsontable/index.d.ts +++ b/types/handsontable/index.d.ts @@ -122,90 +122,90 @@ declare namespace ht { visibleRows?: number; width?: number|Function; wordWrap?: boolean; - isEmptyCol?: (col: number) => boolean; - isEmptyRow?: (row: number) => boolean; + isEmptyCol?(col: number): boolean; + isEmptyRow?(row: number): boolean; // hooks - afterAutofillApplyValues?: (startArea: any[], entireArea: any[]) => void; - afterCellMetaReset?: () => void; - afterChange?: (changes: any[], source: string) => void; - afterChangesObserved?: () => void; - afterColumnMove?: (startColumn: number, endColumn: number) => void; - afterColumnResize?: (currentColumn: number, newSize: number, isDoubleClick: boolean) => void; - afterColumnSort?: (column: number, order: boolean) => void; - afterContextMenuDefaultOptions?: (predefinedItems: any[]) => void; - afterContextMenuHide?: (context: Object) => void; - afterContextMenuShow?: (context: Object) => void; - afterCopyLimit?: (selectedRows: number, selectedColumnds: number, copyRowsLimit: number, copyColumnsLimit: number) => void; - afterCreateCol?: (index: number, amount: number) => void; - afterCreateRow?: (index: number, amount: number) => void; - afterDeselect?: () => void; - afterDestroy?: () => void; - afterDocumentKeyDown?: (event: Event) => void; - afterFilter?: (formulasStack: any[]) => void; - afterGetCellMeta?: (row: number, col: number, cellProperties: Object) => void; - afterGetColHeader?: (col: number, TH: Element) => void; - afterGetColumnHeaderRenderers?: (array: any[]) => void; - afterGetRowHeader?: (row: number, TH: Element) => void; - afterGetRowHeaderRenderers?: (array: any[]) => void; - afterInit?: () => void; - afterLoadData?: (firstTime: boolean) => void; - afterMomentumScroll?: () => void; - afterOnCellCornerMouseDown?: (event: Object) => void; - afterOnCellMouseDown?: (event: Object, coords: Object, TD: Element) => void; - afterOnCellMouseOver?: (event: Object, coords: Object, TD: Element) => void; - afterRemoveCol?: (index: number, amount: number) => void; - afterRemoveRow?: (index: number, amount: number) => void; - afterRender?: (isForced: boolean) => void; - afterRenderer?: (TD: Element, row: number, col: number, prop: string|number, value: string, cellProperties: Object) => void; - afterRowMove?: (startRow: number, endRow: number) => void; - afterRowResize?: (currentRow: number, newSize: number, isDoubleClick: boolean) => void; - afterScrollHorizontally?: () => void; - afterScrollVertically?: () => void; - afterSelection?: (r: number, c: number, r2: number, c2: number) => void; - afterSelectionByProp?: (r: number, p: string, r2: number, p2: string) => void; - afterSelectionEnd?: (r: number, c: number, r2: number, c2: number) => void; - afterSelectionEndByProp?: (r: number, p: string, r2: number, p2: string) => void; - afterSetCellMeta?: (row: number, col: number, key: string, value: any) => void; - afterUpdateSettings?: () => void; - afterValidate?: (isValid: boolean, value: any, row: number, prop: string|number, source: string) => void|boolean; - beforeAutofill?: (start: Object, end: Object, data: any[]) => void; - beforeCellAlignment?: (stateBefore: any, range: any, type: string, alignmentClass: string) => void; - beforeChange?: (changes: any[], source: string) => void; - beforeChangeRender?: (changes: any[], source: string) => void; - beforeColumnMove?: (startColumn: number, endColumn: number) => void; - beforeColumnResize?: (currentColumn: number, newSize: number, isDoubleClick: boolean) => void; - beforeColumnSort?: (column: number, order: boolean) => void; - beforeDrawBorders?: (corners: any[], borderClassName: string) => void; - beforeFilter?: (formulasStack: any[]) => void; - beforeGetCellMeta?: (row: number, col: number, cellProperties: Object) => void; - beforeInit?: () => void; - beforeInitWalkontable?: (walkontableConfig: Object) => void; - beforeKeyDown?: (event: Event) => void; - beforeOnCellMouseDown?: (event: Event, coords: Object, TD: Element) => void; - beforeRemoveCol?: (index: number, amount: number, logicalCols?: any[]) => void; - beforeRemoveRow?: (index: number, amount: number, logicalRows?: any[]) => void; - beforeRender?: (isForced: boolean) => void; - beforeRenderer?: (TD: Element, row: number, col: number, prop: string|number, value: string, cellProperties: Object) => void; - beforeRowMove?: (startRow: number, endRow: number) => void; - beforeRowResize?: (currentRow: number, newSize: number, isDoubleClick: boolean) => any; - beforeSetRangeEnd?: (coords: any[]) => void; - beforeStretchingColumnWidth?: (stretchedWidth: number, column: number) => void; - beforeTouchScroll?: () => void; - beforeValidate?: (value: any, row: number, prop: string|number, source: string) => void; - construct?: () => void; - init?: () => void; - modifyCol?: (col: number) => void; - modifyColHeader?: (column: number) => void; - modifyColWidth?: (width: number, col: number) => void; - modifyCopyableRange?: (copyableRanges: any[]) => void; - modifyRow?: (row: number) => void; - modifyRowHeader?: (row: number) => void; - modifyRowHeight?: (height: number, row: number) => void; - persistentStateLoad?: (key: string, valuePlaceholder: Object) => void; - persistentStateReset?: (key: string) => void; - persistentStateSave?: (key: string, value: any) => void; - unmodifyCol?: (col: number) => void; + afterAutofillApplyValues?(startArea: any[], entireArea: any[]): void; + afterCellMetaReset?(): void; + afterChange?(changes: any[], source: string): void; + afterChangesObserved?(): void; + afterColumnMove?(startColumn: number, endColumn: number): void; + afterColumnResize?(currentColumn: number, newSize: number, isDoubleClick: boolean): void; + afterColumnSort?(column: number, order: boolean): void; + afterContextMenuDefaultOptions?(predefinedItems: any[]): void; + afterContextMenuHide?(context: Object): void; + afterContextMenuShow?(context: Object): void; + afterCopyLimit?(selectedRows: number, selectedColumnds: number, copyRowsLimit: number, copyColumnsLimit: number): void; + afterCreateCol?(index: number, amount: number): void; + afterCreateRow?(index: number, amount: number): void; + afterDeselect?(): void; + afterDestroy?(): void; + afterDocumentKeyDown?(event: Event): void; + afterFilter?(formulasStack: any[]): void; + afterGetCellMeta?(row: number, col: number, cellProperties: Object): void; + afterGetColHeader?(col: number, TH: Element): void; + afterGetColumnHeaderRenderers?(array: any[]): void; + afterGetRowHeader?(row: number, TH: Element): void; + afterGetRowHeaderRenderers?(array: any[]): void; + afterInit?(): void; + afterLoadData?(firstTime: boolean): void; + afterMomentumScroll?(): void; + afterOnCellCornerMouseDown?(event: Object): void; + afterOnCellMouseDown?(event: Object, coords: Object, TD: Element): void; + afterOnCellMouseOver?(event: Object, coords: Object, TD: Element): void; + afterRemoveCol?(index: number, amount: number): void; + afterRemoveRow?(index: number, amount: number): void; + afterRender?(isForced: boolean): void; + afterRenderer?(TD: Element, row: number, col: number, prop: string|number, value: string, cellProperties: Object): void; + afterRowMove?(startRow: number, endRow: number): void; + afterRowResize?(currentRow: number, newSize: number, isDoubleClick: boolean): void; + afterScrollHorizontally?(): void; + afterScrollVertically?(): void; + afterSelection?(r: number, c: number, r2: number, c2: number): void; + afterSelectionByProp?(r: number, p: string, r2: number, p2: string): void; + afterSelectionEnd?(r: number, c: number, r2: number, c2: number): void; + afterSelectionEndByProp?(r: number, p: string, r2: number, p2: string): void; + afterSetCellMeta?(row: number, col: number, key: string, value: any): void; + afterUpdateSettings?(): void; + afterValidate?(isValid: boolean, value: any, row: number, prop: string|number, source: string): void|boolean; + beforeAutofill?(start: Object, end: Object, data: any[]): void; + beforeCellAlignment?(stateBefore: any, range: any, type: string, alignmentClass: string): void; + beforeChange?(changes: any[], source: string): void; + beforeChangeRender?(changes: any[], source: string): void; + beforeColumnMove?(startColumn: number, endColumn: number): void; + beforeColumnResize?(currentColumn: number, newSize: number, isDoubleClick: boolean): void; + beforeColumnSort?(column: number, order: boolean): void; + beforeDrawBorders?(corners: any[], borderClassName: string): void; + beforeFilter?(formulasStack: any[]): void; + beforeGetCellMeta?(row: number, col: number, cellProperties: Object): void; + beforeInit?(): void; + beforeInitWalkontable?(walkontableConfig: Object): void; + beforeKeyDown?(event: Event): void; + beforeOnCellMouseDown?(event: Event, coords: Object, TD: Element): void; + beforeRemoveCol?(index: number, amount: number, logicalCols?: any[]): void; + beforeRemoveRow?(index: number, amount: number, logicalRows?: any[]): void; + beforeRender?(isForced: boolean): void; + beforeRenderer?(TD: Element, row: number, col: number, prop: string|number, value: string, cellProperties: Object): void; + beforeRowMove?(startRow: number, endRow: number): void; + beforeRowResize?(currentRow: number, newSize: number, isDoubleClick: boolean): any; + beforeSetRangeEnd?(coords: any[]): void; + beforeStretchingColumnWidth?(stretchedWidth: number, column: number): void; + beforeTouchScroll?(): void; + beforeValidate?(value: any, row: number, prop: string|number, source: string): void; + construct?(): void; + init?(): void; + modifyCol?(col: number): void; + modifyColHeader?(column: number): void; + modifyColWidth?(width: number, col: number): void; + modifyCopyableRange?(copyableRanges: any[]): void; + modifyRow?(row: number): void; + modifyRowHeader?(row: number): void; + modifyRowHeight?(height: number, row: number): void; + persistentStateLoad?(key: string, valuePlaceholder: Object): void; + persistentStateReset?(key: string): void; + persistentStateSave?(key: string, value: any): void; + unmodifyCol?(col: number): void; } interface Methods { addHook(key: string, callback: Function|any[]): void; diff --git a/types/handsontable/tslint.json b/types/handsontable/tslint.json index 14c6526bd1..6efbba674b 100644 --- a/types/handsontable/tslint.json +++ b/types/handsontable/tslint.json @@ -1,7 +1,7 @@ -{ +{ "extends": "../tslint.json", "rules": { - "forbidden-types": false, + "ban-types": false, "no-single-declare-module": false } } \ No newline at end of file diff --git a/types/heatmap.js/index.d.ts b/types/heatmap.js/index.d.ts index d6907abe7b..60ee16c4f0 100644 --- a/types/heatmap.js/index.d.ts +++ b/types/heatmap.js/index.d.ts @@ -3,138 +3,140 @@ // Definitions by: Yang Guan // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -/// +import * as Leaflet from "leaflet"; -/* - * Configuration object of a heatmap - */ -interface HeatmapConfiguration { +declare global { + /* + * Configuration object of a heatmap + */ + interface HeatmapConfiguration { + + /* + * A background color string in form of hexcode, color name, or rgb(a) + */ + backgroundColor?: string; + + /* + * The blur factor that will be applied to all datapoints. The higher the + * blur factor is, the smoother the gradients will be + * Default value: 0.85 + */ + blur?: number; + + /* + * An object that represents the gradient + */ + gradient?: any; + + /* + * The property name of your latitude coordinate in a datapoint + * Default value: 'x' + */ + latField?: string; + + /* + * The property name of your longitude coordinate in a datapoint + * Default value: 'y' + */ + lngField?: string; + + /* + * The maximal opacity the highest value in the heatmap will have. (will be + * overridden if opacity set) + * Default value: 0.6 + */ + maxOpacity?: number; + + /* + * The minimum opacity the lowest value in the heatmap will have (will be + * overridden if opacity set) + */ + minOpacity?: number; + + /* + * A global opacity for the whole heatmap. This overrides maxOpacity and + * minOpacity if set + */ + opacity?: number; + + /* + * The radius each datapoint will have (if not specified on the datapoint + * itself) + */ + radius?: number; + + /** + * Scales the radius based on map zoom. + */ + scaleRadius?: boolean; + + /* + * Indicate whether the heatmap should use a global extrema or a local + * extrema (the maximum and minimum of the currently displayed viewport) + */ + useLocalExtrema?: boolean; + + /* + * The property name of the value/weight in a datapoint + * Default value: 'value' + */ + valueField?: string; + } /* - * A background color string in form of hexcode, color name, or rgb(a) - */ - backgroundColor?: string; + * A single data point on a heatmap. The keys are specified by + * HeatmapConfig.latField, HeatmapConfig.lngField and HeatmapConfig.valueField + */ + interface HeatmapDataPoint { + [index: string]: number; + } /* - * The blur factor that will be applied to all datapoints. The higher the - * blur factor is, the smoother the gradients will be - * Default value: 0.85 - */ - blur?: number; + * An object representing the set of data points on a heatmap + */ + interface HeatmapData { + + /* + * An array of HeatmapDataPoints + */ + data: HeatmapDataPoint[]; + + /* + * Max value of the valueField + */ + max?: number; + + /* + * Min value of the valueField + */ + min?: number; + } /* - * An object that represents the gradient - */ - gradient?: any; + * The overlay layer to be added onto leaflet map + */ + class HeatmapOverlay { - /* - * The property name of your latitude coordinate in a datapoint - * Default value: 'x' - */ - latField?: string; + /* + * Initialization function + */ + constructor(configuration: HeatmapConfiguration) - /* - * The property name of your longitude coordinate in a datapoint - * Default value: 'y' - */ - lngField?: string; + /* + * Create DOM elements for an overlay, adding them to map panes and puts + * listeners on relevant map events + */ + onAdd(map: Leaflet.Map): void; - /* - * The maximal opacity the highest value in the heatmap will have. (will be - * overridden if opacity set) - * Default value: 0.6 - */ - maxOpacity?: number; + /* + * Remove the overlay's elements from the DOM and remove listeners + * previously added by onAdd() + */ + onRemove(map: Leaflet.Map): void; - /* - * The minimum opacity the lowest value in the heatmap will have (will be - * overridden if opacity set) - */ - minOpacity?: number; - - /* - * A global opacity for the whole heatmap. This overrides maxOpacity and - * minOpacity if set - */ - opacity?: number; - - /* - * The radius each datapoint will have (if not specified on the datapoint - * itself) - */ - radius?: number; - - /** - * Scales the radius based on map zoom. - */ - scaleRadius?: boolean; - - /* - * Indicate whether the heatmap should use a global extrema or a local - * extrema (the maximum and minimum of the currently displayed viewport) - */ - useLocalExtrema?: boolean; - - /* - * The property name of the value/weight in a datapoint - * Default value: 'value' - */ - valueField?: string; -} - -/* - * A single data point on a heatmap. The keys are specified by - * HeatmapConfig.latField, HeatmapConfig.lngField and HeatmapConfig.valueField - */ -interface HeatmapDataPoint { - [index: string]: number; -} - -/* - * An object representing the set of data points on a heatmap - */ -interface HeatmapData { - - /* - * An array of HeatmapDataPoints - */ - data: HeatmapDataPoint[]; - - /* - * Max value of the valueField - */ - max?: number; - - /* - * Min value of the valueField - */ - min?: number; -} - -/* - * The overlay layer to be added onto leaflet map - */ -declare class HeatmapOverlay { - - /* - * Initialization function - */ - constructor(configuration: HeatmapConfiguration) - - /* - * Create DOM elements for an overlay, adding them to map panes and puts - * listeners on relevant map events - */ - onAdd(map: L.Map): void; - - /* - * Remove the overlay's elements from the DOM and remove listeners - * previously added by onAdd() - */ - onRemove(map: L.Map): void; - - /* - * Initialize a heatmap instance with the given dataset - */ - setData(data: HeatmapData): void; + /* + * Initialize a heatmap instance with the given dataset + */ + setData(data: HeatmapData): void; + } } diff --git a/types/heatmap.js/package.json b/types/heatmap.js/package.json deleted file mode 100644 index 711ba15e43..0000000000 --- a/types/heatmap.js/package.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "dependencies": { - "@types/leaflet": "^0.7" - } -} \ No newline at end of file diff --git a/types/heatmap.js/tsconfig.json b/types/heatmap.js/tsconfig.json index 1fd9be0a9c..055cfad536 100644 --- a/types/heatmap.js/tsconfig.json +++ b/types/heatmap.js/tsconfig.json @@ -9,7 +9,15 @@ "noImplicitThis": true, "strictNullChecks": false, "baseUrl": "../", + "typeRoots": [ + "../" + ], "types": [], + "paths": { + "leaflet": [ + "leaflet/v0" + ] + }, "noEmit": true, "forceConsistentCasingInFileNames": true }, diff --git a/types/highcharts/highcharts-more.d.ts b/types/highcharts/highcharts-more.d.ts index 14f4940784..6bd8693409 100644 --- a/types/highcharts/highcharts-more.d.ts +++ b/types/highcharts/highcharts-more.d.ts @@ -5,6 +5,6 @@ import * as Highcharts from "highcharts"; -declare var HighchartsMore: (H: Highcharts.Static) => Highcharts.Static; +declare function HighchartsMore(H: Highcharts.Static): Highcharts.Static; export = HighchartsMore; export as namespace HighchartsMore; diff --git a/types/highcharts/highstock.d.ts b/types/highcharts/highstock.d.ts index 35c1179ff1..f67a83ba37 100644 --- a/types/highcharts/highstock.d.ts +++ b/types/highcharts/highstock.d.ts @@ -46,7 +46,7 @@ declare namespace Highstock { inputBoxHeight?: number; inputBoxWidth?: number; inputDateFormat?: string; - inputDateParser?: (date: string) => number; + inputDateParser?(date: string): number; inputEditDateFormat?: string; inputEnabled?: boolean; inputPosition?: { diff --git a/types/highcharts/index.d.ts b/types/highcharts/index.d.ts index 9fe60ef542..952de318b0 100644 --- a/types/highcharts/index.d.ts +++ b/types/highcharts/index.d.ts @@ -96,7 +96,7 @@ declare namespace Highcharts { * this are axis, chart, isFirst and isLast. * @default function() {return this.value;} */ - formatter?: () => string; + formatter?(): string; /** * Horizontal axis only. When staggerLines is not set, maxStaggerLines defines how many lines the axis is allowed to * add to automatically avoid overlapping X labels. Set to 1 to disable overlap detection. @@ -173,10 +173,10 @@ declare namespace Highcharts { } interface MousePlotEvents { - click?: (event: Event) => void; - mouseover?: (event: Event) => void; - mouseout?: (event: Event) => void; - mousemove?: (event: Event) => void; + click?(event: Event): void; + mouseover?(event: Event): void; + mouseout?(event: Event): void; + mousemove?(event: Event): void; } /** @@ -491,19 +491,19 @@ declare namespace Highcharts { * An event fired after the breaks have rendered. * @since 4.1.0 */ - afterBreaks?: (event: Event) => void; + afterBreaks?(event: Event): void; /** * As opposed to the setExtremes event, this event fires after the final min and max values are computed and * corrected for minRange. * The this keyword refers to the {@link AxisObject|Axis} object. * @since 2.3 */ - afterSetExtremes?: (event: AxisEvent) => void; + afterSetExtremes?(event: AxisEvent): void; /** * An event fired when a break from this axis occurs on a point. * The this keyword refers to the {@link AxisObject|Axis} object. */ - pointBreak?: (event: Event) => void; + pointBreak?(event: Event): void; /** * Fires when the minimum and maximum is set for the axis, either by calling the .setExtremes() method or by * selecting an area in the chart. One parameter, event, is passed to the function. This contains common event @@ -516,7 +516,7 @@ declare namespace Highcharts { * The this keyword refers to the {@link AxisObject|Axis} object. * @since 1.2.0 */ - setExtremes?: (event: AxisEvent) => void; + setExtremes?(event: AxisEvent): void; }; /** * The lowest allowed value for automatically computed axis extremes. @@ -868,7 +868,7 @@ declare namespace Highcharts { * behaviour of tickPixelInterval and tickInterval. The automatic tick positions are accessible through * this.tickPositions and can be modified by the callback. */ - tickPositioner?: (min: number, max: number) => void; + tickPositioner?(min: number, max: number): void; /** * An array defining where the ticks are laid out on the axis. This overrides the default behaviour of * tickPixelInterval and tickInterval. @@ -958,7 +958,7 @@ declare namespace Highcharts { * corrected for minRange. * The this keyword refers to the {@link AxisObject|Axis} object. */ - afterSetExtremes?: (event: AxisEvent) => void; + afterSetExtremes?(event: AxisEvent): void; /** * Fires when the minimum and maximum is set for the axis, either by calling the .setExtremes() method or by * selecting an area in the chart. One parameter, event, is passed to the function. This contains common event @@ -970,7 +970,7 @@ declare namespace Highcharts { * * The this keyword refers to the {@link AxisObject|Axis} object. */ - setExtremes?: (event: AxisEvent) => void; + setExtremes?(event: AxisEvent): void; }; /** * Color of the grid lines extending from the axis across the gradient. @@ -1163,7 +1163,7 @@ declare namespace Highcharts { * A callback function returning array defining where the ticks are laid out on the axis. This overrides the default * behaviour of tickPixelInterval and tickInterval. */ - tickPositioner?: (min: number, max: number) => void; + tickPositioner?(min: number, max: number): void; /** * An array defining where the ticks are laid out on the axis. This overrides the default behaviour of * tickPixelInterval and tickInterval. @@ -1281,19 +1281,19 @@ declare namespace Highcharts { * The this keyword refers to the Chart object. * @since 1.2.0 */ - addSeries?: (event: AddSeriesEvent) => boolean | void; + addSeries?(event: AddSeriesEvent): boolean | void; /** * Fires after a chart is printed through the context menu item or the Chart.print method. Requires the exporting * module. * @since 4.1.0 */ - afterPrint?: (event: Event) => void; + afterPrint?(event: Event): void; /** * Fires before a chart is printed through the context menu item or the Chart.print method. Requires the exporting * module. * @since 4.1.0 */ - beforePrint?: (event: Event) => void; + beforePrint?(event: Event): void; /** * Fires when clicking on the plot background. One parameter, event, is passed to the function. This contains common * event information based on jQuery or MooTools depending on which library is used as the base for Highcharts. @@ -1309,17 +1309,17 @@ declare namespace Highcharts { * The this keyword refers to the Chart object. * @since 1.2.0 */ - click?: (event: ChartClickEvent) => void; + click?(event: ChartClickEvent): void; /** * Fires when a drilldown point is clicked, before the new series is added. * @since 3.0.8 */ - drilldown?: (event: ChartDrilldownEvent) => void; + drilldown?(event: ChartDrilldownEvent): void; /** * Fires when drilling up from a drilldown series. * @since 3.0.8 */ - drillup?: (event: Event) => void; + drillup?(event: Event): void; /** * Fires when the chart is finished loading. One parameter, event, is passed to the function. This contains common * event information based on jQuery or MooTools depending on which library is used as the base for Highcharts. @@ -1329,7 +1329,7 @@ declare namespace Highcharts { * * The this keyword refers to the Chart object. */ - load?: (event: Event) => void; + load?(event: Event): void; /** * Fires when the chart is redrawn, either after a call to chart.redraw() or after an axis, series or point is * modified with the redraw option set to true. One parameter, event, is passed to the function. This contains @@ -1339,7 +1339,7 @@ declare namespace Highcharts { * The this keyword refers to the Chart object. * @since 1.2.0 */ - redraw?: (event: Event) => void; + redraw?(event: Event): void; /** * Fires when an area of the chart has been selected. Selection is enabled by setting the chart's zoomType. One * parameter, event, is passed to the function. This contains common event information based on jQuery or MooTools @@ -1360,7 +1360,7 @@ declare namespace Highcharts { * console.log(event.yAxis[0].min, event.yAxis[0].max); * } */ - selection?: (event: ChartSelectionEvent) => void; + selection?(event: ChartSelectionEvent): void; } interface LinearGradient { @@ -1886,7 +1886,7 @@ declare namespace Highcharts { * extended with additional options and passed directly to the chart constructor. * @since 4.0 */ - complete?: (options: Options) => void; + complete?(options: Options): void; /** * A comma delimited string to be parsed. Related options are startRow, endRow, startColumn and endColumn to delimit * what part of the table is used. The lineDelimiter and itemDelimiter options define the CSV delimiter formats. @@ -1955,14 +1955,14 @@ declare namespace Highcharts { * timestamp on success. * @since 4.0 */ - parseDate?: (val: any) => number; + parseDate?(val: any): number; /** * A callback function to access the parsed columns, the two-dimentional input data array directly, before they are * interpreted into series data and categories. Return false to stop completion, or call this.complete() to continue * async. * @since 4.0 */ - parsed?: (columns: [string | number][]) => boolean | void; + parsed?(columns: [string | number][]): boolean | void; /** * The same as the columns input option, but defining rows intead of columns. * @since 4.0 @@ -2080,7 +2080,7 @@ declare namespace Highcharts { /** * Callback function to run on click. */ - onclick: () => void; + onclick(): void; } interface Button { @@ -2184,7 +2184,7 @@ declare namespace Highcharts { * A click handler callback to use on the button directly instead of the popup menu. * @since 2.0 */ - onclick?: () => void; + onclick?(): void; /** * The symbol for the button. Points to a definition function in the Highcharts.Renderer.symbols collection. The * default exportIcon function is part of the exporting module. @@ -2345,7 +2345,7 @@ declare namespace Highcharts { * charts in specific time zones using their local DST crossover dates, with the help of external libraries. * @since 4.1.0 */ - getTimezoneOffset?: (timestamp: number) => number; + getTimezoneOffset?(timestamp: number): number; /** * The timezone offset in minutes. Positive values are west, negative values are east of UTC, as in the ECMAScript * getTimezoneOffset method. Use this to display UTC based data in a predefined time zone. @@ -2624,7 +2624,7 @@ declare namespace Highcharts { * Callback function to format each of the series' labels. The this keyword refers to the series object, or the * point object in case of pie charts. By default the series or point name is printed. */ - labelFormatter?: () => string; + labelFormatter?(): string; /** * The layout of the legend items. Can be one of 'horizontal' or 'vertical'. * @default 'horizontal' @@ -2983,7 +2983,7 @@ declare namespace Highcharts { * - this.x: The x value. * - this.y: The y value. */ - formatter?: () => string; + formatter?(): string; /** * For points with an extent, like columns, whether to align the data label inside the box or to the actual value * point. Defaults to false in most cases, true in stacked columns. @@ -3126,7 +3126,7 @@ declare namespace Highcharts { * The this keyword refers to the Series object. * @since 4.0 */ - afterAnimate?: (event: Event) => void; + afterAnimate?(event: Event): void; /** * Fires when the checkbox next to the series' name in the legend is clicked. One parameter, event, is passed to the * function. The state of the checkbox is found by event.checked. The checked item is found by event.item. Return @@ -3135,7 +3135,7 @@ declare namespace Highcharts { * The this keyword refers to the Series object. * @since 1.2.0 */ - checkboxClick?: (event: AreaCheckboxEvent) => boolean | void; + checkboxClick?(event: AreaCheckboxEvent): boolean | void; /** * Fires when the series is clicked. One parameter, event, is passed to the function. This contains common event * information based on jQuery or MooTools depending on which library is used as the base for Highcharts. @@ -3143,14 +3143,14 @@ declare namespace Highcharts { * * The this keyword refers to the Series object. */ - click?: (event: AreaClickEvent) => void; + click?(event: AreaClickEvent): void; /** * Fires when the series is hidden after chart generation time, either by clicking the legend item or by calling * .hide(). * * The this keyword refers to the Series object. */ - hide?: () => void; + hide?(): void; /** * Fires when the legend item belonging to the series is clicked. One parameter, event, is passed to the function. * This contains common event information based on jQuery or MooTools depending on which library is used as the base @@ -3159,7 +3159,7 @@ declare namespace Highcharts { * * The this keyword refers to the Series object. */ - legendItemClick?: (event: Event) => boolean | void; + legendItemClick?(event: Event): boolean | void; /** * Fires when the mouse leaves the graph. One parameter, event, is passed to the function. This contains common * event information based on jQuery or MooTools depending on which library is used as the base for Highcharts. If @@ -3168,14 +3168,14 @@ declare namespace Highcharts { * * The this keyword refers to the Series object. */ - mouseOut?: (event: Event) => void; + mouseOut?(event: Event): void; /** * Fires when the mouse enters the graph. One parameter, event, is passed to the function. This contains common * event information based on jQuery or MooTools depending on which library is used as the base for Highcharts. * * The this keyword refers to the Series object. */ - mouseOver?: (event: Event) => void; + mouseOver?(event: Event): void; /** * Fires when the series is shown after chart generation time, either by clicking the legend item or by calling * .show(). @@ -3183,7 +3183,7 @@ declare namespace Highcharts { * The this keyword refers to the Series object. * @since 1.2.0 */ - show?: () => void; + show?(): void; } interface MarkerState { @@ -3273,7 +3273,7 @@ declare namespace Highcharts { * * The this keyword refers to the Point object. */ - click?: (event: Event) => boolean; + click?(event: Event): boolean; /** * Fires when the mouse leaves the area close to the point. One parameter, event, is passed to the function. This * contains common event information based on jQuery or MooTools depending on which library is used as the base for @@ -3281,7 +3281,7 @@ declare namespace Highcharts { * * The this keyword refers to the Point object. */ - mouseOut?: (event: Event) => void; + mouseOut?(event: Event): void; /** * Fires when the mouse enters the area close to the point. One parameter, event, is passed to the function. This * contains common event information based on jQuery or MooTools depending on which library is used as the base for @@ -3289,7 +3289,7 @@ declare namespace Highcharts { * * The this keyword refers to the Point object. */ - mouseOver?: (event: Event) => void; + mouseOver?(event: Event): void; /** * Fires when the point is removed using the .remove() method. One parameter, event, is passed to the function. * Returning false cancels the operation. @@ -3297,7 +3297,7 @@ declare namespace Highcharts { * The this keyword refers to the Point object. * @since 1.2.0 */ - remove?: (event: Event) => boolean | void; + remove?(event: Event): boolean | void; /** * Fires when the point is selected either programmatically or following a click on the point. One parameter, event, * is passed to the function. Returning false cancels the operation. @@ -3305,7 +3305,7 @@ declare namespace Highcharts { * The this keyword refers to the Point object. * @since 1.2.0 */ - select?: (event: Event) => boolean | void; + select?(event: Event): boolean | void; /** * Fires when the point is unselected either programmatically or following a click on the point. One parameter, * event, is passed to the function. Returning false cancels the operation. @@ -3313,7 +3313,7 @@ declare namespace Highcharts { * The this keyword refers to the Point object. * @since 1.2.0 */ - unselect?: (event: Event) => boolean | void; + unselect?(event: Event): boolean | void; /** * Fires when the point is updated programmatically through the .update() method. One parameter, event, is passed to * the function. The new point options can be accessed through event.options. Returning false cancels the operation. @@ -3321,14 +3321,14 @@ declare namespace Highcharts { * The this keyword refers to the Point object. * @since 1.2.0 */ - update?: (event: Event) => boolean | void; + update?(event: Event): boolean | void; /** * Fires when the legend item belonging to the pie point (slice) is clicked. * The this keyword refers to the point itself. One parameter, event, is passed to the function. * This contains common event information based on jQuery or MooTools depending on which library is used as the base for Highcharts. * The default action is to toggle the visibility of the point. This can be prevented by calling event.preventDefault(). */ - legendItemClick?: (event: Event) => boolean | void; + legendItemClick?(event: Event): boolean | void; } interface Halo { @@ -3516,7 +3516,7 @@ declare namespace Highcharts { * - this.x: The x value. * - this.y: The y value. */ - formatter?: () => string; + formatter?(): string; /** * For points with an extent, like columns, whether to align the data label inside the box or to the actual value * point. Defaults to false in most cases, true in stacked columns. @@ -5404,7 +5404,7 @@ declare namespace Highcharts { * this.y (not shared) / this.points[i].y (shared) * The y value. */ - formatter?: () => boolean | string; + formatter?(): boolean | string; /** * A callback function to place the tooltip in a default position. The callback receives three parameters: * labelWidth, labelHeight and point, where point contains values for plotX and plotY telling where the reference @@ -5413,7 +5413,7 @@ declare namespace Highcharts { * The return should be an object containing x and y values, for example { x: 100, y: 100 }. * @since 2.2.4 */ - positioner?: (labelWidth: number, labelHeight: number, point: PlotPoint) => { x: number; y: number; }; + positioner?(labelWidth: number, labelHeight: number, point: PlotPoint): { x: number; y: number; }; /** * Whether to apply a drop shadow to the tooltip. * @default true @@ -5516,7 +5516,7 @@ declare namespace Highcharts { * The this keyword refers to the Point object. * @since 4.1.0 */ - pointFormatter?: () => string; + pointFormatter?(): string; /** * How many decimals to show in each series' y value. This is overridable in each series' tooltip options object. * The default is to preserve all decimals. diff --git a/types/highcharts/modules/boost.d.ts b/types/highcharts/modules/boost.d.ts index 9b62dab1c7..1a297c7087 100644 --- a/types/highcharts/modules/boost.d.ts +++ b/types/highcharts/modules/boost.d.ts @@ -5,6 +5,6 @@ import { Static } from "highcharts"; -declare var HighchartsBoost: (H: Static) => Static; +declare function HighchartsBoost(H: Static): Static; export = HighchartsBoost; export as namespace HighchartsBoost; diff --git a/types/highcharts/modules/exporting.d.ts b/types/highcharts/modules/exporting.d.ts index 877ef3d0c1..8d808c1929 100644 --- a/types/highcharts/modules/exporting.d.ts +++ b/types/highcharts/modules/exporting.d.ts @@ -5,6 +5,6 @@ import { Static } from "highcharts"; -declare var HighchartsExporting: (H: Static) => Static; +declare function HighchartsExporting(H: Static): Static; export = HighchartsExporting; export as namespace HighchartsExporting; diff --git a/types/highcharts/modules/no-data-to-display.d.ts b/types/highcharts/modules/no-data-to-display.d.ts index 750f8de607..f807860838 100644 --- a/types/highcharts/modules/no-data-to-display.d.ts +++ b/types/highcharts/modules/no-data-to-display.d.ts @@ -29,6 +29,6 @@ declare module "highcharts" { } } -declare var HighchartsNoDataToDisplay: (H: Static) => Static; +declare function HighchartsNoDataToDisplay(H: Static): Static; export = HighchartsNoDataToDisplay; export as namespace HighchartsNoDataToDisplay; diff --git a/types/highcharts/modules/offline-exporting.d.ts b/types/highcharts/modules/offline-exporting.d.ts index 94ecf53485..5b58f65c46 100644 --- a/types/highcharts/modules/offline-exporting.d.ts +++ b/types/highcharts/modules/offline-exporting.d.ts @@ -5,6 +5,6 @@ import { Static } from "highcharts"; -declare var HighchartsOfflineExporting: (H: Static) => Static; +declare function HighchartsOfflineExporting(H: Static): Static; export = HighchartsOfflineExporting; export as namespace HighchartsOfflineExporting; diff --git a/types/highcharts/tslint.json b/types/highcharts/tslint.json index 6fb4f705cf..a53062e5df 100644 --- a/types/highcharts/tslint.json +++ b/types/highcharts/tslint.json @@ -1,7 +1,7 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false, + "ban-types": false, "unified-signatures": false, "array-type": false, "no-empty-interface": false, diff --git a/types/hyco-ws/hyco-ws-tests.ts b/types/hyco-ws/hyco-ws-tests.ts index 05b500d81c..e08890b3b1 100644 --- a/types/hyco-ws/hyco-ws-tests.ts +++ b/types/hyco-ws/hyco-ws-tests.ts @@ -18,4 +18,4 @@ const wss = AzureRelay.createRelayedServer( wss.on('error', (err: any) => { console.log('error' + err); -}); \ No newline at end of file +}); diff --git a/types/hyco-ws/index.d.ts b/types/hyco-ws/index.d.ts index 053c7fba18..68d0575fb5 100644 --- a/types/hyco-ws/index.d.ts +++ b/types/hyco-ws/index.d.ts @@ -24,4 +24,4 @@ export function createRelayToken(uri: string, key_name: string, key: string, exp export function appendRelayToken(uri: string, key_name: string, key: string, expiry?: number): string; export function createRelayBaseUri(serviceBusNamespace: string, path: string): string; export function createRelaySendUri(serviceBusNamespace: string, path: string, token?: any, id?: any): string; -export function createRelayListenUri(serviceBusNamespace: string, path: string, token?: any, id?: any): string; \ No newline at end of file +export function createRelayListenUri(serviceBusNamespace: string, path: string, token?: any, id?: any): string; diff --git a/types/ignite-ui/index.d.ts b/types/ignite-ui/index.d.ts index 6909aa644c..7052460f8b 100644 --- a/types/ignite-ui/index.d.ts +++ b/types/ignite-ui/index.d.ts @@ -4,7 +4,6 @@ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped interface DataSourceSettingsPaging { - /** * Paging is not enabled by default * @@ -58,7 +57,6 @@ interface DataSourceSettingsPaging { } interface DataSourceSettingsFiltering { - /** * Filtering type. * @@ -129,7 +127,6 @@ interface DataSourceSettingsFiltering { } interface DataSourceSettingsSorting { - /** * Sorting direction * @@ -224,7 +221,6 @@ interface DataSourceSettingsSorting { } interface DataSourceSettingsGroupby { - /** * Default collapse state * @@ -238,7 +234,6 @@ interface DataSourceSettingsGroupby { } interface DataSourceSettingsSummaries { - /** * Specifies whether summaries will be applied locally or remotely (via a remote request) * @@ -285,7 +280,6 @@ interface DataSourceSettingsSummaries { } interface DataSourceSettings { - /** * Setting this is only necessary when the data source is set to a table in string format. we need to create an invisible dummy data container in the body and append the table data to it * @@ -536,481 +530,480 @@ interface DataSourceSettings { [optionName: string]: any; } -declare module Infragistics { -export class DataSource { - constructor(settings: DataSourceSettings); +declare namespace Infragistics { + 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. 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; - /** - * This clears local filtering applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalFilter(): void; + /** + * This clears local filtering applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalFilter(): 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; + /** + * 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; + /** + * 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; + /** + * Returns metadata object for the specified key + * + * @param key Primary key of the record + */ + metadata(key: string): Object; - /** - * Returns the total number of records in the local data source - */ - totalLocalRecordsCount(): number; + /** + * 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 pages + */ + pageCount(): 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; + /** + * 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; + /** + * 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 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; + /** + * 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; + /** + * 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; + /** + * 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; + /** + * 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; + /** + * 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 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; + /** + * 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. 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 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[]; + /** + * 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; + /** + * 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 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; -} + /** + * 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 module Infragistics { -export class TypeParser { - toStr(obj: Object): void; +declare namespace Infragistics { + 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 + * @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; + } } interface DataSchemaSchemaFields { - /** * Name of the field */ @@ -1043,7 +1036,6 @@ interface DataSchemaSchemaFields { } interface DataSchemaSchema { - /** * A list of field definitions specifying the schema of the data source. Field objects description: {name, [type], [xpath]} * returnType="array" @@ -1066,950 +1058,949 @@ interface DataSchemaSchema { [optionName: string]: any; } -declare module Infragistics { -export class DataSchema { - constructor(schema: DataSchemaSchema); +declare namespace Infragistics { + 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 module Infragistics { -export class RemoteDataSource { - constructor(settings: DataSourceSettings); +declare namespace Infragistics { + 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. 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; - /** - * This clears local filtering applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalFilter(): void; + /** + * This clears local filtering applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalFilter(): 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; + /** + * 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; + /** + * 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; + /** + * Returns metadata object for the specified key + * + * @param key Primary key of the record + */ + metadata(key: string): Object; - /** - * Returns the total number of records in the local data source - */ - totalLocalRecordsCount(): number; + /** + * 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 pages + */ + pageCount(): 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; + /** + * 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; + /** + * 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 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; + /** + * 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; + /** + * 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; + /** + * 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; + /** + * 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; + /** + * 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 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; + /** + * 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. 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 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[]; + /** + * 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; + /** + * 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 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; -} + /** + * 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; } -declare module Infragistics { -export class JSONDataSource { - constructor(settings: DataSourceSettings); +declare namespace Infragistics { + class JSONDataSource { + 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. 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; - /** - * This clears local filtering applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalFilter(): void; + /** + * This clears local filtering applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalFilter(): 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; + /** + * 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; + /** + * 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; + /** + * Returns metadata object for the specified key + * + * @param key Primary key of the record + */ + metadata(key: string): Object; - /** - * Returns the total number of records in the local data source - */ - totalLocalRecordsCount(): number; + /** + * 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 pages + */ + pageCount(): 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; + /** + * 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; + /** + * 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 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; + /** + * 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; + /** + * 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; + /** + * 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; + /** + * 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; + /** + * 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 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; + /** + * 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. 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 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[]; + /** + * 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; + /** + * 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 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; -} + /** + * 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; } interface RESTDataSourceSettingsRestSettingsCreate { - /** * 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. */ @@ -2032,7 +2023,6 @@ interface RESTDataSourceSettingsRestSettingsCreate { } interface RESTDataSourceSettingsRestSettingsUpdate { - /** * 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. */ @@ -2055,7 +2045,6 @@ interface RESTDataSourceSettingsRestSettingsUpdate { } interface RESTDataSourceSettingsRestSettingsRemove { - /** * 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. */ @@ -2078,7 +2067,6 @@ interface RESTDataSourceSettingsRestSettingsRemove { } interface RESTDataSourceSettingsRestSettings { - /** * Settings for create requests */ @@ -2116,7 +2104,6 @@ interface RESTDataSourceSettingsRestSettings { } interface RESTDataSourceSettings { - /** * Settings related to REST compliant update routine */ @@ -2128,461 +2115,460 @@ interface RESTDataSourceSettings { [optionName: string]: any; } -declare module Infragistics { -export class RESTDataSource { - constructor(settings: RESTDataSourceSettings); +declare namespace Infragistics { + 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. 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; - /** - * This clears local filtering applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalFilter(): void; + /** + * This clears local filtering applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalFilter(): 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; + /** + * 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; + /** + * 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; + /** + * Returns metadata object for the specified key + * + * @param key Primary key of the record + */ + metadata(key: string): Object; - /** - * Returns the total number of records in the local data source - */ - totalLocalRecordsCount(): number; + /** + * 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 pages + */ + pageCount(): 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; + /** + * 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; + /** + * 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 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; + /** + * 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; + /** + * 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; + /** + * 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; + /** + * 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; + /** + * 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 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; + /** + * 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. 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 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[]; + /** + * 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; + /** + * 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 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; -} + /** + * 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; } interface JSONPDataSourceSettings { - /** * Override the callback function name in a jsonp request. Sets option jsonp in $.ajax functionbool Setting the jsonp option to false prevents jQuery from adding the "?callback" string to the URL or attempting to use "=?" for transformation * @@ -2600,2273 +2586,2272 @@ interface JSONPDataSourceSettings { [optionName: string]: any; } -declare module Infragistics { -export class JSONPDataSource { - constructor(settings: JSONPDataSourceSettings); +declare namespace Infragistics { + 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. 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; - /** - * This clears local filtering applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalFilter(): void; + /** + * This clears local filtering applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalFilter(): 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; + /** + * 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; + /** + * 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; + /** + * Returns metadata object for the specified key + * + * @param key Primary key of the record + */ + metadata(key: string): Object; - /** - * Returns the total number of records in the local data source - */ - totalLocalRecordsCount(): number; + /** + * 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 pages + */ + pageCount(): 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; + /** + * 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; + /** + * 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 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; + /** + * 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; + /** + * 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; + /** + * 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; + /** + * 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; + /** + * 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 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; + /** + * 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. 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 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[]; + /** + * 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; + /** + * 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 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; -} + /** + * 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 module Infragistics { -export class XmlDataSource { - constructor(settings: DataSourceSettings); +declare namespace Infragistics { + 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. 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; - /** - * This clears local filtering applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalFilter(): void; + /** + * This clears local filtering applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalFilter(): 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; + /** + * 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; + /** + * 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; + /** + * Returns metadata object for the specified key + * + * @param key Primary key of the record + */ + metadata(key: string): Object; - /** - * Returns the total number of records in the local data source - */ - totalLocalRecordsCount(): number; + /** + * 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 pages + */ + pageCount(): 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; + /** + * 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; + /** + * 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 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; + /** + * 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; + /** + * 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; + /** + * 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; + /** + * 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; + /** + * 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 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; + /** + * 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. 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 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[]; + /** + * 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; + /** + * 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 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; -} + /** + * 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; } -declare module Infragistics { -export class FunctionDataSource { - constructor(settings: DataSourceSettings); +declare namespace Infragistics { + class FunctionDataSource { + 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. 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; - /** - * This clears local filtering applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalFilter(): void; + /** + * This clears local filtering applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalFilter(): 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; + /** + * 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; + /** + * 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; + /** + * Returns metadata object for the specified key + * + * @param key Primary key of the record + */ + metadata(key: string): Object; - /** - * Returns the total number of records in the local data source - */ - totalLocalRecordsCount(): number; + /** + * 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 pages + */ + pageCount(): 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; + /** + * 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; + /** + * 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 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; + /** + * 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; + /** + * 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; + /** + * 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; + /** + * 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; + /** + * 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 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; + /** + * 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. 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 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[]; + /** + * 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; + /** + * 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 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; -} + /** + * 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; } -declare module Infragistics { -export class HtmlTableDataSource { - constructor(settings: DataSourceSettings); +declare namespace Infragistics { + class HtmlTableDataSource { + 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. 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; - /** - * This clears local filtering applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalFilter(): void; + /** + * This clears local filtering applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalFilter(): 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; + /** + * 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; + /** + * 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; + /** + * Returns metadata object for the specified key + * + * @param key Primary key of the record + */ + metadata(key: string): Object; - /** - * Returns the total number of records in the local data source - */ - totalLocalRecordsCount(): number; + /** + * 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 pages + */ + pageCount(): 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; + /** + * 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; + /** + * 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 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; + /** + * 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; + /** + * 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; + /** + * 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; + /** + * 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; + /** + * 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 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; + /** + * 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. 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 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[]; + /** + * 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; + /** + * 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 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; -} + /** + * 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 module Infragistics { -export class ArrayDataSource { - constructor(settings: DataSourceSettings); +declare namespace Infragistics { + 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. 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; - /** - * This clears local filtering applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalFilter(): void; + /** + * This clears local filtering applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalFilter(): 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; + /** + * 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; + /** + * 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; + /** + * Returns metadata object for the specified key + * + * @param key Primary key of the record + */ + metadata(key: string): Object; - /** - * Returns the total number of records in the local data source - */ - totalLocalRecordsCount(): number; + /** + * 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 pages + */ + pageCount(): 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; + /** + * 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; + /** + * 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 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; + /** + * 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; + /** + * 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; + /** + * 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; + /** + * 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; + /** + * 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 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; + /** + * 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. 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 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[]; + /** + * 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; + /** + * 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 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; -} + /** + * 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; } interface MashupDataSourceMashupSettings { - /** * Indicates whether to ignore records that have no corresponding data in all of the provided data sources. */ @@ -4883,445 +4868,444 @@ interface MashupDataSourceMashupSettings { [optionName: string]: any; } -declare module Infragistics { -export class MashupDataSource { - constructor(mashupSettings: MashupDataSourceMashupSettings); - constructor(settings: DataSourceSettings); +declare namespace Infragistics { + class MashupDataSource { + constructor(mashupSettings: MashupDataSourceMashupSettings); + constructor(settings: DataSourceSettings); - /** - * Sets a cell value for the cell denoted by rowId and colId. Creates a transaction for the update operation and returns it - * - * @param rowId the rowId - row key (string) or index (number) - * @param colId the column id - column key (string) or index (number) - * @param val The new value - * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log - */ - 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. 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; - /** - * This clears local filtering applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalFilter(): void; + /** + * This clears local filtering applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalFilter(): 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; + /** + * 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; + /** + * 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; + /** + * Returns metadata object for the specified key + * + * @param key Primary key of the record + */ + metadata(key: string): Object; - /** - * Returns the total number of records in the local data source - */ - totalLocalRecordsCount(): number; + /** + * 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 pages + */ + pageCount(): 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; + /** + * 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; + /** + * 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 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; + /** + * 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; + /** + * 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; + /** + * 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; + /** + * 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; + /** + * 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 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; + /** + * 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. 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 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[]; + /** + * 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; + /** + * 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 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; -} + /** + * 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; } interface HierarchicalDataSourceSettingsPaging { - /** * Option for HierarchicalDataSourceSettingsPaging */ @@ -5329,7 +5313,6 @@ interface HierarchicalDataSourceSettingsPaging { } interface HierarchicalDataSourceSettingsSorting { - /** * Option for HierarchicalDataSourceSettingsSorting */ @@ -5337,7 +5320,6 @@ interface HierarchicalDataSourceSettingsSorting { } interface HierarchicalDataSourceSettingsFiltering { - /** * Option for HierarchicalDataSourceSettingsFiltering */ @@ -5345,7 +5327,6 @@ interface HierarchicalDataSourceSettingsFiltering { } interface HierarchicalDataSourceSettingsSchema { - /** * Option for HierarchicalDataSourceSettingsSchema */ @@ -5391,20 +5372,19 @@ interface HierarchicalDataSourceSettings { [optionName: string]: any; } -declare module Infragistics { -export class HierarchicalDataSource { - constructor(settings: HierarchicalDataSourceSettings); - dataBind(callback: Object, callee: Object): void; - root(): void; - dataAt(path: Object, keyspath: Object): void; -} +declare namespace Infragistics { + 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; } interface TreeHierarchicalDataSourceSettingsTreeDSFiltering { - /** * Specifies from which data bound level to be applied filtering - 0 is the first level */ @@ -5432,7 +5412,6 @@ interface TreeHierarchicalDataSourceSettingsTreeDSFiltering { } interface TreeHierarchicalDataSourceSettingsTreeDSSorting { - /** * Specifies from which data bound level to be applied sorting - 0 is the first level */ @@ -5450,7 +5429,6 @@ interface TreeHierarchicalDataSourceSettingsTreeDSSorting { } interface TreeHierarchicalDataSourceSettingsTreeDSPaging { - /** * Sets gets paging mode. * @@ -5477,7 +5455,6 @@ interface TreeHierarchicalDataSourceSettingsTreeDSPaging { } interface TreeHierarchicalDataSourceSettingsTreeDS { - /** * Property name of the array of child data in a hierarchical data source. */ @@ -5568,7 +5545,6 @@ interface TreeHierarchicalDataSourceSettingsTreeDS { } interface TreeHierarchicalDataSourceSettings { - /** * Configure tree datasource specific settings */ @@ -5580,644 +5556,644 @@ interface TreeHierarchicalDataSourceSettings { [optionName: string]: any; } -declare module Infragistics { -export 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; -} +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; + } } interface IgniteUIStatic { TreeHierarchicalDataSource: typeof Infragistics.TreeHierarchicalDataSource; } -declare module Infragistics { -export class DvCommonWidget { - option(key: Object, value: Object): void; -} +declare namespace Infragistics { + class DvCommonWidget { + option(key: Object, value: Object): void; + } } interface SimpleTextMarkerTemplateSettings { @@ -6235,21 +6211,20 @@ interface SimpleTextMarkerTemplateSettings { [optionName: string]: any; } -declare module Infragistics { -export class SimpleTextMarkerTemplate { - constructor(requireThis: boolean); - constructor(settings: SimpleTextMarkerTemplateSettings); - getText(item: Object, textDelegate: Object): void; - measure(measureInfo: Object): void; - render(renderInfo: Object): void; -} +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; + } } interface IgniteUIStatic { SimpleTextMarkerTemplate: typeof Infragistics.SimpleTextMarkerTemplate; } 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. * @@ -6313,7 +6288,6 @@ interface GridExcelExporterSettingsGridFeatureOptions { } interface GridExcelExporterSettings { - /** * Specifies the name of the excel file that will be generated. */ @@ -6373,7 +6347,6 @@ interface GridExcelExporterSettings { } interface GridExcelExporterCallbacks { - /** * Cancel="true" Callback fired when the exporting has started. * Function takes arguments sender and args. @@ -6494,27 +6467,26 @@ interface GridExcelExporterCallbacks { [optionName: string]: any; } -declare module Infragistics { -export class GridExcelExporter { - constructor(settings: GridExcelExporterSettings); - constructor(callbacks: GridExcelExporterCallbacks); +declare namespace Infragistics { + class GridExcelExporter { + constructor(settings: GridExcelExporterSettings); + constructor(callbacks: GridExcelExporterCallbacks); - /** - * 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; } interface OlapXmlaDataSourceOptionsRequestOptions { - /** * The value is applied to XmlHttpRequest.withCredentials if supported by the user agent. * Setting this property to true will allow IE8/IE9 to make authenticated cross-origin requests to tusted domains through XmlHttpRequest instead of XDomainRequest @@ -6534,7 +6506,6 @@ interface OlapXmlaDataSourceOptionsRequestOptions { } interface OlapXmlaDataSourceOptionsMdxSettings { - /** * Optional="true" a value indicating whether a NON EMPTY clause is present on ROWS axis. Default value is true */ @@ -6572,7 +6543,6 @@ interface OlapXmlaDataSourceOptionsMdxSettings { } interface OlapXmlaDataSourceOptions { - /** * Optional="false" The URL of the XMLA server. */ @@ -6646,323 +6616,322 @@ interface OlapXmlaDataSourceOptions { [optionName: string]: any; } -declare module Infragistics { -export class OlapXmlaDataSource { - constructor(options: OlapXmlaDataSourceOptions); +declare namespace Infragistics { + 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; } interface OlapFlatDataSourceOptionsMetadataCubeMeasuresDimensionMeasure { - /** * Optional="false" A unique name for the measure. */ @@ -6991,7 +6960,6 @@ interface OlapFlatDataSourceOptionsMetadataCubeMeasuresDimensionMeasure { } interface OlapFlatDataSourceOptionsMetadataCubeMeasuresDimension { - /** * A unique name for the measures dimension. * The default value is "Measures". This name is used to create the names of dimensions using the following pattern: @@ -7017,7 +6985,6 @@ interface OlapFlatDataSourceOptionsMetadataCubeMeasuresDimension { } interface OlapFlatDataSourceOptionsMetadataCubeDimensionHierarchieLevel { - /** * Optional="false" A name for the level. * The unique name of the level is formed using the following pattern: @@ -7043,7 +7010,6 @@ interface OlapFlatDataSourceOptionsMetadataCubeDimensionHierarchieLevel { } interface OlapFlatDataSourceOptionsMetadataCubeDimensionHierarchie { - /** * Optional="false" A name for the hierarchy. * The unique name of the hierarchy is formed using the following pattern: @@ -7057,8 +7023,8 @@ interface OlapFlatDataSourceOptionsMetadataCubeDimensionHierarchie { caption?: string; /** - * The path to be used when displaying the hierarchy in the user interface. - * Nested folders are indicated by a backslash (\). + * The path to be used when displaying the hierarchy in the user interface. + * Nested folders are indicated by a backslash (\). * The folder hierarchy will appear under parent dimension node. */ displayFolder?: string; @@ -7075,7 +7041,6 @@ interface OlapFlatDataSourceOptionsMetadataCubeDimensionHierarchie { } interface OlapFlatDataSourceOptionsMetadataCubeDimension { - /** * Optional="false" A unique name for the dimension. */ @@ -7098,7 +7063,6 @@ interface OlapFlatDataSourceOptionsMetadataCubeDimension { } interface OlapFlatDataSourceOptionsMetadataCube { - /** * Optional="false" A unique name for the cube. */ @@ -7126,7 +7090,6 @@ interface OlapFlatDataSourceOptionsMetadataCube { } interface OlapFlatDataSourceOptionsMetadata { - /** * Optional="false" Metadata used for the creation of the cube. */ @@ -7139,7 +7102,6 @@ interface OlapFlatDataSourceOptionsMetadata { } interface OlapFlatDataSourceOptions { - /** * Optional="true" Specifies any valid data source accepted by $.ig.DataSource, or an instance of an $.ig.DataSource itself. */ @@ -7196,348 +7158,346 @@ interface OlapFlatDataSourceOptions { [optionName: string]: any; } -declare module Infragistics { -export class OlapFlatDataSource { - constructor(options: OlapFlatDataSourceOptions); +declare namespace Infragistics { + 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 module Infragistics { -export class OlapMetadataTreeItem { +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; - /** - * 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 { - /** * Optional="false" an object of type $.ig.OlapResult which represents the full cached result. */ @@ -7564,46 +7524,45 @@ interface OlapResultViewOptions { [optionName: string]: any; } -declare module Infragistics { -export class OlapResultView { - constructor(options: OlapResultViewOptions); +declare namespace Infragistics { + 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; } interface OlapTableViewOptionsViewSettings { - /** * Optional="false" a value indicating whether parent for columns is in front of its children. - * If set to true the query set sorts members in a level in their natural order. Their natural order is the default ordering of the members along the hierarchy when no other sort conditions are specified. + * If set to true the query set sorts members in a level in their natural order. Their natural order is the default ordering of the members along the hierarchy when no other sort conditions are specified. * Child members immediately follow their parent members. * If set to false the query set sorts the members in a level using a post-natural order. In other words, child members precede their parents. */ @@ -7611,7 +7570,7 @@ interface OlapTableViewOptionsViewSettings { /** * Optional="false" a value indicating whether parent for rows is in front of its children. - * If set to true the query set sorts members in a level in their natural order. Their natural order is the default ordering of the members along the hierarchy when no other sort conditions are specified. + * If set to true the query set sorts members in a level in their natural order. Their natural order is the default ordering of the members along the hierarchy when no other sort conditions are specified. * Child members immediately follow their parent members. * If set to false the query set sorts the members in a level using a post-natural order. In other words, child members precede their parents. */ @@ -7634,7 +7593,6 @@ interface OlapTableViewOptionsViewSettings { } interface OlapTableViewOptions { - /** * Optional="false" an object of type $.ig.OlapResult. */ @@ -7661,661 +7619,649 @@ interface OlapTableViewOptions { [optionName: string]: any; } -declare module Infragistics { -export class OlapTableView { - constructor(options: OlapTableViewOptions); +declare namespace Infragistics { + 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 module Infragistics { -export class OlapTableViewHeaderCell { +declare namespace Infragistics { + class OlapTableViewHeaderCell { + /** + * Returns the caption for the header cell. + */ + caption(): string; - /** - * 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 module Infragistics { -export class OlapTableViewResultCell { +declare namespace Infragistics { + class OlapTableViewResultCell { + /** + * Returns the value provided by $.ig.Cell object. + */ + value(): Object; - /** - * 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 module Infragistics { -export class Catalog { +declare namespace Infragistics { + class Catalog { + /** + * Returns the name of the catalog. + * + * @param value + */ + name(value: Object): string; - /** - * 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 module Infragistics { -export class Cube { +declare namespace Infragistics { + class Cube { + /** + * Returns the name of the cube. + * + * @param value + */ + name(value: Object): string; - /** - * 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 module Infragistics { -export class Dimension { +declare namespace Infragistics { + class Dimension { + /** + * Returns the name of the dimension. + * + * @param value + */ + name(value: Object): string; - /** - * 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 module Infragistics { -export class Hierarchy { +declare namespace Infragistics { + class Hierarchy { + /** + * Returns the name of the hierarchy. + * + * @param value + */ + name(value: Object): string; - /** - * 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 module Infragistics { -export class Measure { +declare namespace Infragistics { + class Measure { + /** + * Returns the name of the measure. + * + * @param value + */ + name(value: Object): string; - /** - * 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 module Infragistics { -export class Level { +declare namespace Infragistics { + class Level { + /** + * Returns the name of the level. + * + * @param value + */ + name(value: Object): string; - /** - * 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 module Infragistics { -export class MeasureGroup { +declare namespace Infragistics { + class MeasureGroup { + /** + * Returns the name of the measure group. + * + * @param value + */ + name(value: Object): string; - /** - * 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 module Infragistics { -export class MeasureList { +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; - /** - * 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 module Infragistics { -export class OlapResult { +declare namespace Infragistics { + class OlapResult { + /** + * Returns a value indicating whether the result object contains any data. + * + * @param value + */ + isEmpty(value: Object): boolean; - /** - * 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 { - /** * Optional="false" array of $.ig.OlapResultTuple objects which form the axis. */ @@ -8332,27 +8278,26 @@ interface OlapResultAxisOptions { [optionName: string]: any; } -declare module Infragistics { -export class OlapResultAxis { - constructor(options: OlapResultAxisOptions); +declare namespace Infragistics { + 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; } interface OlapResultTupleOptions { - /** * Optional="false" array of $.ig.OlapResultAxisMember objects which form the tuple object. */ @@ -8364,143 +8309,140 @@ interface OlapResultTupleOptions { [optionName: string]: any; } -declare module Infragistics { -export class OlapResultTuple { - constructor(options: OlapResultTupleOptions); +declare namespace Infragistics { + 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 module Infragistics { -export class OlapResultAxisMember { +declare namespace Infragistics { + class OlapResultAxisMember { + /** + * Returns the unique name of the axis member. + * + * @param value + */ + uniqueName(value: Object): string; - /** - * 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 module Infragistics { -export class OlapResultCell { +declare namespace Infragistics { + class OlapResultCell { + /** + * Returns the position of the cell when cells are iterated row by row. + * + * @param value + */ + cellOrdinal(value: Object): number; - /** - * 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 { - /** * Option for IgTemplatingRegExp */ [optionName: string]: any; } -declare module Infragistics { -export class igTemplating { - constructor(regExp: IgTemplatingRegExp); +declare namespace Infragistics { + 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; @@ -8511,7 +8453,6 @@ interface ErrorMessageDisplayingEvent { } interface ErrorMessageDisplayingEventUIParam { - /** * Used to obtain reference to the barcode widget. */ @@ -8528,7 +8469,6 @@ interface DataChangedEvent { } interface DataChangedEventUIParam { - /** * Used to obtain reference to the barcode widget. */ @@ -8541,7 +8481,6 @@ interface DataChangedEventUIParam { } interface IgQRCodeBarcode { - /** * The width of the barcode. It can be set as a number in pixels, string (px) or percentage (%). */ @@ -8596,9 +8535,9 @@ interface IgQRCodeBarcode { * Gets or sets the stretch. * * Valid values: - * "none" - * "fill" - * "uniform" + * "none" + * "fill" + * "uniform" * "uniformToFill" */ stretch?: string; @@ -8694,7 +8633,7 @@ interface IgQRCodeBarcode { encodingMode?: string; /** - * Each Extended Channel Interpretation (ECI) is designated by a six-digit assignment number: 000000 - 999999. + * Each Extended Channel Interpretation (ECI) is designated by a six-digit assignment number: 000000 - 999999. * The default value depends on the loaded encodings. The default is ECI 000003 (representing ISO/IEC 8859-1) if the ISO/IEC 8859-1 character set is loaded. Otherwise the default value is 000026 (representing UTF-8). */ eciNumber?: number; @@ -8746,7 +8685,6 @@ interface IgQRCodeBarcode { [optionName: string]: any; } interface IgQRCodeBarcodeMethods { - /** * Returns information about how the barcode is rendered. */ @@ -8768,7 +8706,7 @@ interface IgQRCodeBarcodeMethods { styleUpdated(): void; } interface JQuery { - data(propertyName: "igQRCodeBarcode"):IgQRCodeBarcodeMethods; + data(propertyName: "igQRCodeBarcode"): IgQRCodeBarcodeMethods; } interface JQuery { @@ -8982,13 +8920,13 @@ interface JQuery { igQRCodeBarcode(optionLiteral: 'option', optionName: "encodingMode", optionValue: string): void; /** - * Each Extended Channel Interpretation (ECI) is designated by a six-digit assignment number: 000000 - 999999. + * Each Extended Channel Interpretation (ECI) is designated by a six-digit assignment number: 000000 - 999999. * The default value depends on the loaded encodings. The default is ECI 000003 (representing ISO/IEC 8859-1) if the ISO/IEC 8859-1 character set is loaded. Otherwise the default value is 000026 (representing UTF-8). */ igQRCodeBarcode(optionLiteral: 'option', optionName: "eciNumber"): number; /** - * Each Extended Channel Interpretation (ECI) is designated by a six-digit assignment number: 000000 - 999999. + * Each Extended Channel Interpretation (ECI) is designated by a six-digit assignment number: 000000 - 999999. * The default value depends on the loaded encodings. The default is ECI 000003 (representing ISO/IEC 8859-1) if the ISO/IEC 8859-1 character set is loaded. Otherwise the default value is 000026 (representing UTF-8). * * @optionValue New value to be set. @@ -9079,7 +9017,6 @@ interface DataBindingEvent { } interface DataBindingEventUIParam { - /** * Used to obtain reference to chart widget. */ @@ -9096,7 +9033,6 @@ interface DataBoundEvent { } interface DataBoundEventUIParam { - /** * Used to obtain reference to chart widget. */ @@ -9118,7 +9054,6 @@ interface UpdateTooltipEvent { } interface UpdateTooltipEventUIParam { - /** * Used to obtain reference to chart widget. */ @@ -9155,7 +9090,6 @@ interface HideTooltipEvent { } interface HideTooltipEventUIParam { - /** * Used to obtain reference to chart widget. */ @@ -9173,7 +9107,6 @@ interface HideTooltipEventUIParam { } interface IgBaseChart { - /** * The width of the chart. */ @@ -9269,7 +9202,6 @@ interface IgBaseChart { [optionName: string]: any; } interface IgBaseChartMethods { - /** * Find index of item within actual data used by chart. * @@ -9373,7 +9305,7 @@ interface IgBaseChartMethods { destroy(): void; } interface JQuery { - data(propertyName: "igBaseChart"):IgBaseChartMethods; + data(propertyName: "igBaseChart"): IgBaseChartMethods; } interface JQuery { @@ -9602,7 +9534,6 @@ interface JQuery { igBaseChart(methodName: string, ...methodParams: any[]): any; } interface IgBulletGraphRange { - /** * Gets or sets the name of the range. */ @@ -9678,7 +9609,6 @@ interface AlignLabelEventUIParam { } interface IgBulletGraph { - /** * The width of the gauge. It can be set as a number in pixels, string (px) or percentage (%). */ @@ -9713,7 +9643,7 @@ interface IgBulletGraph { * Gets or sets the orientation of the scale. * * Valid values: - * "horizontal" + * "horizontal" * "vertical" */ orientation?: string; @@ -9993,7 +9923,6 @@ interface IgBulletGraph { [optionName: string]: any; } interface IgBulletGraphMethods { - /** * Returns a string containing the names of all the ranges delimited with a \n symbol. */ @@ -10041,7 +9970,7 @@ interface IgBulletGraphMethods { styleUpdated(): void; } interface JQuery { - data(propertyName: "igBulletGraph"):IgBulletGraphMethods; + data(propertyName: "igBulletGraph"): IgBulletGraphMethods; } interface JQuery { @@ -10807,7 +10736,6 @@ interface PropertyChangedEventUIParam { } interface IgCategoryChart { - /** * Gets or sets the data value corresponding to the minimum value of the Y-axis. */ @@ -11158,9 +11086,9 @@ 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" + * "left" + * "center" + * "right" * "stretch" */ titleAlignment?: string; @@ -11169,9 +11097,9 @@ 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" + * "left" + * "center" + * "right" * "stretch" */ subtitleAlignment?: string; @@ -11181,7 +11109,7 @@ interface IgCategoryChart { * * * Valid values: - * "linearInterpolate" + * "linearInterpolate" * "dontPlot" */ unknownValuePlotting?: string; @@ -11190,7 +11118,7 @@ interface IgCategoryChart { * Gets or sets behavior for markers in each series which are placed too close together for the current view, resulting in a collision. * * Valid values: - * "none" + * "none" * "omit" */ markerCollisionAvoidance?: string; @@ -11204,25 +11132,25 @@ 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" + * "auto" + * "fromZero" + * "sweepFromLeft" + * "sweepFromRight" + * "sweepFromTop" + * "sweepFromBottom" + * "sweepFromCenter" + * "accordionFromLeft" + * "accordionFromRight" + * "accordionFromTop" + * "accordionFromBottom" + * "expand" + * "sweepFromCategoryAxisMinimum" + * "sweepFromCategoryAxisMaximum" + * "sweepFromValueAxisMinimum" + * "sweepFromValueAxisMaximum" + * "accordionFromCategoryAxisMinimum" + * "accordionFromCategoryAxisMaximum" + * "accordionFromValueAxisMinimum" * "accordionFromValueAxisMaximum" */ transitionInMode?: string; @@ -11231,10 +11159,10 @@ 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" + * "auto" + * "normal" + * "valueScaled" + * "indexScaled" * "random" */ transitionInSpeedType?: string; @@ -11451,19 +11379,19 @@ 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" + * "none" + * "linearFit" + * "quadraticFit" + * "cubicFit" + * "quarticFit" + * "quinticFit" + * "logarithmicFit" + * "exponentialFit" + * "powerLawFit" + * "simpleAverage" + * "exponentialAverage" + * "modifiedAverage" + * "cumulativeAverage" * "weightedAverage" */ trendLineType?: string; @@ -11516,9 +11444,9 @@ interface IgCategoryChart { * Gets or sets the horizontal alignment of the X-axis title. * * Valid values: - * "left" - * "center" - * "right" + * "left" + * "center" + * "right" * "stretch" */ xAxisTitleAlignment?: string; @@ -11527,9 +11455,9 @@ interface IgCategoryChart { * Gets or sets the vertical alignment of the Y-axis title. * * Valid values: - * "top" - * "center" - * "bottom" + * "top" + * "center" + * "bottom" * "stretch" */ yAxisTitleAlignment?: string; @@ -11538,9 +11466,9 @@ interface IgCategoryChart { * Gets or sets the horizontal alignment of X-axis labels. * * Valid values: - * "left" - * "center" - * "right" + * "left" + * "center" + * "right" * "stretch" */ xAxisLabelHorizontalAlignment?: string; @@ -11549,9 +11477,9 @@ interface IgCategoryChart { * Gets or sets the horizontal alignment of Y-axis labels. * * Valid values: - * "left" - * "center" - * "right" + * "left" + * "center" + * "right" * "stretch" */ yAxisLabelHorizontalAlignment?: string; @@ -11560,9 +11488,9 @@ interface IgCategoryChart { * Gets or sets the vertical alignment of X-axis labels. * * Valid values: - * "top" - * "center" - * "bottom" + * "top" + * "center" + * "bottom" * "stretch" */ xAxisLabelVerticalAlignment?: string; @@ -11571,9 +11499,9 @@ interface IgCategoryChart { * Gets or sets the vertical alignment of Y-axis labels. * * Valid values: - * "top" - * "center" - * "bottom" + * "top" + * "center" + * "bottom" * "stretch" */ yAxisLabelVerticalAlignment?: string; @@ -11582,7 +11510,7 @@ interface IgCategoryChart { * Gets or sets the visibility of X-axis labels. * * Valid values: - * "visible" + * "visible" * "collapsed" */ xAxisLabelVisibility?: string; @@ -11591,7 +11519,7 @@ interface IgCategoryChart { * Gets or sets the visibility of Y-axis labels. * * Valid values: - * "visible" + * "visible" * "collapsed" */ yAxisLabelVisibility?: string; @@ -11798,7 +11726,7 @@ interface IgCategoryChartMethods { dataBind(): void; } interface JQuery { - data(propertyName: "igCategoryChart"):IgCategoryChartMethods; + data(propertyName: "igCategoryChart"): IgCategoryChartMethods; } interface JQuery { @@ -13645,7 +13573,6 @@ interface JQuery { igCategoryChart(methodName: string, ...methodParams: any[]): any; } interface IgDataChartCrosshairPoint { - /** * The x coordinate. */ @@ -13663,7 +13590,6 @@ interface IgDataChartCrosshairPoint { } interface IgDataChartLegend { - /** * The name of the element to turn into a legend. */ @@ -13702,7 +13628,6 @@ interface IgDataChartLegend { } interface IgDataChartAxes { - /** * Type of the axis. * @@ -14105,7 +14030,6 @@ interface IgDataChartAxes { } interface IgDataChartSeriesLegend { - /** * The name of the element to turn into a legend. */ @@ -14144,7 +14068,6 @@ interface IgDataChartSeriesLegend { } interface IgDataChartSeries { - /** * Type of the series. * @@ -14871,7 +14794,6 @@ interface TooltipShowingEvent { } interface TooltipShowingEventUIParam { - /** * Used to get reference to tooltip DOM element. */ @@ -14908,7 +14830,6 @@ interface TooltipShownEvent { } interface TooltipShownEventUIParam { - /** * Used to get reference to tooltip DOM element. */ @@ -14945,7 +14866,6 @@ interface TooltipHidingEvent { } interface TooltipHidingEventUIParam { - /** * Used to get reference to tooltip DOM element. */ @@ -14982,7 +14902,6 @@ interface TooltipHiddenEvent { } interface TooltipHiddenEventUIParam { - /** * Used to get reference to tooltip DOM element. */ @@ -15026,7 +14945,6 @@ interface SeriesCursorMouseMoveEvent { } interface SeriesCursorMouseMoveEventUIParam { - /** * Used to get reference to current series item object. */ @@ -15068,7 +14986,6 @@ interface SeriesMouseLeftButtonDownEvent { } interface SeriesMouseLeftButtonDownEventUIParam { - /** * Used to get reference to current series item object. */ @@ -15110,7 +15027,6 @@ interface SeriesMouseLeftButtonUpEvent { } interface SeriesMouseLeftButtonUpEventUIParam { - /** * Used to get reference to current series item object. */ @@ -15152,7 +15068,6 @@ interface SeriesMouseMoveEvent { } interface SeriesMouseMoveEventUIParam { - /** * Used to get reference to current series item object. */ @@ -15194,7 +15109,6 @@ interface SeriesMouseEnterEvent { } interface SeriesMouseEnterEventUIParam { - /** * Used to get reference to current series item object. */ @@ -15236,7 +15150,6 @@ interface SeriesMouseLeaveEvent { } interface SeriesMouseLeaveEventUIParam { - /** * Used to get reference to current series item object. */ @@ -15278,7 +15191,6 @@ interface WindowRectChangedEvent { } interface WindowRectChangedEventUIParam { - /** * Used to get reference to chart object. */ @@ -15330,7 +15242,6 @@ interface GridAreaRectChangedEvent { } interface GridAreaRectChangedEventUIParam { - /** * Used to get reference to chart object. */ @@ -15382,7 +15293,6 @@ interface RefreshCompletedEvent { } interface RefreshCompletedEventUIParam { - /** * Used to get reference to chart object. */ @@ -15394,7 +15304,6 @@ interface AxisRangeChangedEvent { } interface AxisRangeChangedEventUIParam { - /** * Used to get reference to current chart axis object. */ @@ -15431,7 +15340,6 @@ interface TypicalBasedOnEvent { } interface TypicalBasedOnEventUIParam { - /** * Used to get reference to chart object. */ @@ -15473,7 +15381,6 @@ interface ProgressiveLoadStatusChangedEvent { } interface ProgressiveLoadStatusChangedEventUIParam { - /** * Used to get reference to chart object. */ @@ -15495,7 +15402,6 @@ interface AssigningCategoryStyleEvent { } interface AssigningCategoryStyleEventUIParam { - /** * Used to get reference to chart object. */ @@ -15564,7 +15470,6 @@ interface AssigningCategoryMarkerStyleEvent { } interface AssigningCategoryMarkerStyleEventUIParam { - /** * Used to get reference to chart object. */ @@ -15629,7 +15534,6 @@ interface AssigningCategoryMarkerStyleEventUIParam { } interface IgDataChart { - /** * Gets or sets whether the series viewer can allow the page to pan if a control pan is not possible in the requested direction. */ @@ -16805,11 +16709,10 @@ interface IgDataChartMethods { clearTileZoomCache(): void; } interface JQuery { - data(propertyName: "igDataChart"):IgDataChartMethods; + data(propertyName: "igDataChart"): IgDataChartMethods; } interface IgPieChartLegend { - /** * The name of the element to turn into a legend. */ @@ -16845,7 +16748,6 @@ interface SliceClickEvent { } interface SliceClickEventUIParam { - /** * Used to get reference to chart object. */ @@ -16862,7 +16764,6 @@ interface LabelClickEvent { } interface LabelClickEventUIParam { - /** * Used to get reference to the slice object. */ @@ -16879,7 +16780,6 @@ interface SelectedItemChangingEvent { } interface SelectedItemChangingEventUIParam { - /** * Used to get a reference to the current selected data item. */ @@ -16901,7 +16801,6 @@ interface SelectedItemChangedEvent { } interface SelectedItemChangedEventUIParam { - /** * Used to get a reference to the previous selected data item. */ @@ -16918,7 +16817,6 @@ interface SelectedItemsChangingEvent { } interface SelectedItemsChangingEventUIParam { - /** * Used to get a reference to the current selected data items. */ @@ -16940,7 +16838,6 @@ interface SelectedItemsChangedEvent { } interface SelectedItemsChangedEventUIParam { - /** * Used to get a reference to the previous selected data items. */ @@ -16953,7 +16850,6 @@ interface SelectedItemsChangedEventUIParam { } interface IgPieChart { - /** * The width of the chart. It can be set as a number in pixels, string (px) or percentage (%). */ @@ -17392,7 +17288,7 @@ interface IgPieChartMethods { exportVisualData(): void; } interface JQuery { - data(propertyName: "igPieChart"):IgPieChartMethods; + data(propertyName: "igPieChart"): IgPieChartMethods; } interface JQuery { @@ -19836,7 +19732,6 @@ interface LegendItemMouseLeftButtonDownEvent { } interface LegendItemMouseLeftButtonDownEventUIParam { - /** * Used to get reference to current legend object. */ @@ -19873,7 +19768,6 @@ interface LegendItemMouseLeftButtonUpEvent { } interface LegendItemMouseLeftButtonUpEventUIParam { - /** * Used to get reference to current legend object. */ @@ -19910,7 +19804,6 @@ interface LegendItemMouseEnterEvent { } interface LegendItemMouseEnterEventUIParam { - /** * Used to get reference to current legend object. */ @@ -19947,7 +19840,6 @@ interface LegendItemMouseLeaveEvent { } interface LegendItemMouseLeaveEventUIParam { - /** * Used to get reference to current legend object. */ @@ -19980,7 +19872,6 @@ interface LegendItemMouseLeaveEventUIParam { } interface IgChartLegend { - /** * Type of the legend. * @@ -20078,7 +19969,7 @@ interface IgChartLegendMethods { id(): string; } interface JQuery { - data(propertyName: "igChartLegend"):IgChartLegendMethods; + data(propertyName: "igChartLegend"): IgChartLegendMethods; } interface JQuery { @@ -20249,7 +20140,6 @@ interface ColorSelectedEvent { } interface ColorSelectedEventUIParam { - /** * Used to get a reference to the color object. */ @@ -20257,7 +20147,6 @@ interface ColorSelectedEventUIParam { } interface IgColorPicker { - /** * Gets/Sets the default colors. Default colors are the ones displayed in the upper table of the color picker. * The array should contain arrays that contain the color values for every next row. @@ -20274,7 +20163,7 @@ interface IgColorPicker { /** * The event is fired when a color is selected. - * + * * Function takes arguments evt and ui. * Use ui.color to get a reference to the color object. */ @@ -20286,7 +20175,6 @@ interface IgColorPicker { [optionName: string]: any; } interface IgColorPickerMethods { - /** * Gets a reference to the div element of the color table */ @@ -20323,7 +20211,7 @@ interface IgColorPickerMethods { selectColor(color: string): Object; } interface JQuery { - data(propertyName: "igColorPicker"):IgColorPickerMethods; + data(propertyName: "igColorPicker"): IgColorPickerMethods; } interface JQuery { @@ -20368,7 +20256,7 @@ interface JQuery { /** * The event is fired when a color is selected. - * + * * Function takes arguments evt and ui. * Use ui.color to get a reference to the color object. */ @@ -20376,7 +20264,7 @@ interface JQuery { /** * The event is fired when a color is selected. - * + * * Function takes arguments evt and ui. * Use ui.color to get a reference to the color object. * @@ -20394,7 +20282,6 @@ interface ClickEvent { } interface ClickEventUIParam { - /** * Used to get a reference the igSplitButton element. */ @@ -20406,7 +20293,6 @@ interface ExpandedEvent { } interface ExpandedEventUIParam { - /** * Used to get a reference the igSplitButton. */ @@ -20418,7 +20304,6 @@ interface ExpandingEvent { } interface ExpandingEventUIParam { - /** * Used to get a reference the igSplitButton. */ @@ -20430,7 +20315,6 @@ interface CollapsedEvent { } interface CollapsedEventUIParam { - /** * Used to get a reference the igSplitButton. */ @@ -20442,7 +20326,6 @@ interface CollapsingEvent { } interface CollapsingEventUIParam { - /** * Used to get a reference the igSplitButton. */ @@ -20450,7 +20333,6 @@ interface CollapsingEventUIParam { } interface IgColorPickerSplitButton { - /** * Button items. * @@ -20483,7 +20365,7 @@ interface IgColorPickerSplitButton { /** * Event fired when the button is clicked. - * + * * Function takes arguments evt and ui. * Use ui.item to get a reference the igSplitButton element. */ @@ -20491,7 +20373,7 @@ interface IgColorPickerSplitButton { /** * Event fired after the button is expanded. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. */ @@ -20499,7 +20381,7 @@ interface IgColorPickerSplitButton { /** * Event fired before a button item is expanded. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. */ @@ -20507,7 +20389,7 @@ interface IgColorPickerSplitButton { /** * Event fired after the button is collapsed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. */ @@ -20515,7 +20397,7 @@ interface IgColorPickerSplitButton { /** * Event fired before a button item is collapsed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. */ @@ -20527,7 +20409,6 @@ interface IgColorPickerSplitButton { [optionName: string]: any; } interface IgColorPickerSplitButtonMethods { - /** * Sets the color of the split button * @@ -20538,14 +20419,14 @@ interface IgColorPickerSplitButtonMethods { /** * Collapse the widget. * - * @param e + * @param e */ collapse(e: Object): Object; /** * Expands the widget. * - * @param e + * @param e */ expand(e: Object): Object; @@ -20570,7 +20451,7 @@ interface IgColorPickerSplitButtonMethods { toggle(e: Object): Object; } interface JQuery { - data(propertyName: "igColorPickerSplitButton"):IgColorPickerSplitButtonMethods; + data(propertyName: "igColorPickerSplitButton"): IgColorPickerSplitButtonMethods; } interface JQuery { @@ -20654,7 +20535,7 @@ interface JQuery { /** * Event fired when the button is clicked. - * + * * Function takes arguments evt and ui. * Use ui.item to get a reference the igSplitButton element. */ @@ -20662,7 +20543,7 @@ interface JQuery { /** * Event fired when the button is clicked. - * + * * Function takes arguments evt and ui. * Use ui.item to get a reference the igSplitButton element. * @@ -20672,7 +20553,7 @@ interface JQuery { /** * Event fired after the button is expanded. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. */ @@ -20680,7 +20561,7 @@ interface JQuery { /** * Event fired after the button is expanded. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. * @@ -20690,7 +20571,7 @@ interface JQuery { /** * Event fired before a button item is expanded. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. */ @@ -20698,7 +20579,7 @@ interface JQuery { /** * Event fired before a button item is expanded. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. * @@ -20708,7 +20589,7 @@ interface JQuery { /** * Event fired after the button is collapsed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. */ @@ -20716,7 +20597,7 @@ interface JQuery { /** * Event fired after the button is collapsed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. * @@ -20726,7 +20607,7 @@ interface JQuery { /** * Event fired before a button item is collapsed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. */ @@ -20734,7 +20615,7 @@ interface JQuery { /** * Event fired before a button item is collapsed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. * @@ -20748,7 +20629,6 @@ interface JQuery { igColorPickerSplitButton(methodName: string, ...methodParams: any[]): any; } interface IgComboLoadOnDemandSettings { - /** * Gets/Sets option to enable load on demand. * @@ -20768,7 +20648,6 @@ interface IgComboLoadOnDemandSettings { } interface IgComboMultiSelection { - /** * Set enabled to true to turn multi selection on. Set to true by default when target element for the combo is a select with the multiple attribute set. * @@ -20800,7 +20679,6 @@ interface IgComboMultiSelection { } interface IgComboGrouping { - /** * Gets/Sets name of column by which the records will be grouped. Setting this option enables the grouping. * @@ -20824,7 +20702,6 @@ interface IgComboGrouping { } interface IgComboInitialSelectedItem { - /** * Optional="true" Index of item in the list. The index should be greater than -1 and less than the count of the [items](ui.igcombo#methods:items) in the list (rows in dataSource). * @@ -20848,7 +20725,6 @@ interface RenderedEvent { } interface RenderedEventUIParam { - /** * Used to get a reference to the combo performing rendering. */ @@ -20865,7 +20741,6 @@ interface FilteringEvent { } interface FilteringEventUIParam { - /** * Used to obtain reference to igCombo. */ @@ -20882,7 +20757,6 @@ interface FilteredEvent { } interface FilteredEventUIParam { - /** * Used to obtain reference to igCombo. */ @@ -20899,7 +20773,6 @@ interface ItemsRenderingEvent { } interface ItemsRenderingEventUIParam { - /** * Used to get a reference to the combo performing rendering. */ @@ -20916,7 +20789,6 @@ interface ItemsRenderedEvent { } interface ItemsRenderedEventUIParam { - /** * Used to get a reference to the combo performing rendering. */ @@ -20933,7 +20805,6 @@ interface DropDownOpeningEvent { } interface DropDownOpeningEventUIParam { - /** * Used to obtain reference to igCombo. */ @@ -20950,7 +20821,6 @@ interface DropDownOpenedEvent { } interface DropDownOpenedEventUIParam { - /** * Used to obtain reference to igCombo. */ @@ -20967,7 +20837,6 @@ interface DropDownClosingEvent { } interface DropDownClosingEventUIParam { - /** * Used to obtain reference to igCombo. */ @@ -20984,7 +20853,6 @@ interface DropDownClosedEvent { } interface DropDownClosedEventUIParam { - /** * Used to obtain reference to igCombo. */ @@ -21001,7 +20869,6 @@ interface SelectionChangingEvent { } interface SelectionChangingEventUIParam { - /** * Used to obtain reference to igCombo. */ @@ -21023,7 +20890,6 @@ interface SelectionChangedEvent { } interface SelectionChangedEventUIParam { - /** * Used to obtain reference to igCombo. */ @@ -21041,7 +20907,6 @@ interface SelectionChangedEventUIParam { } interface IgCombo { - /** * Gets/Sets the width of combo. The numeric and string values (valid html units for size) are supported. It includes %, px, em and other units. * @@ -21187,7 +21052,7 @@ interface IgCombo { /** * Gets/Sets type of filtering.Note: option is set to "remote", then the "css.waitFiltering" is applied to combo and its drop-down list. - * + * * * * Valid values: @@ -21205,7 +21070,7 @@ interface IgCombo { /** * Gets/Sets condition used for filtering.Note: When [autoComplete](ui.igcombo#options:autoComplete) is enabled, the filtering condition is always "startsWith". - * + * * * * Valid values: @@ -21393,9 +21258,9 @@ interface IgCombo { * Valid options are: * "auto" (default) - uses automatic formatting for Date and number objects. * "none", "", or null - will disable formatting - * + * * Custom values can be something like "currency", "percent", "dateLong", "time", "MMM-dd-yyyy H:mm tt", etc. - * + * * Custom format strings should match the data type in "textKey" column. * */ @@ -21440,7 +21305,7 @@ interface IgCombo { /** * Event which is raised after rendering of the combo completes. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the combo performing rendering. * Use ui.element to get a reference to the main/top combo element. @@ -21449,7 +21314,7 @@ interface IgCombo { /** * Event which is raised before data binding is performed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to igCombo performing the databinding. * Use ui.dataSource to get a reference to the [$.ig.DataSource](ig.datasource) combo is to be databound to. @@ -21458,7 +21323,7 @@ interface IgCombo { /** * Event which is raised after data binding is complete. - * + * * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo performing the data binding. * Use ui.dataSource to get a reference to the [$.ig.DataSource](ig.datasource) combo is databound to. @@ -21469,7 +21334,7 @@ interface IgCombo { /** * Event which is raised before data filtering. - * + * * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo. * Use ui.expression to obtain reference to array which contains expressions supported by [$.ig.DataSource](ig.datasource). @@ -21479,7 +21344,7 @@ interface IgCombo { /** * Event which is raised after filtering. - * + * * Function takes arguments evt and ui. * Use evt.originalEvent to obtain reference to event of browser. That can be null. * Use ui.owner to obtain reference to igCombo. @@ -21489,7 +21354,7 @@ interface IgCombo { /** * Event which is raised before rendering of the combo items is performed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the combo performing rendering. * Use ui.dataSource to get a reference to the [$.ig.DataSource](ig.datasource) combo is databound to. @@ -21498,7 +21363,7 @@ interface IgCombo { /** * Event which is raised after rendering of the combo items completes. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the combo performing rendering. * Use ui.dataSource to get a reference to the [$.ig.DataSource](ig.datasource) combo is databound to. @@ -21507,7 +21372,7 @@ interface IgCombo { /** * Event which is raised before drop-down list is opened. - * + * * Return false in order to cancel drop-down action. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo. @@ -21517,7 +21382,7 @@ interface IgCombo { /** * Event which is raised after drop-down list was opened. - * + * * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo. * Use ui.list to obtain reference to jquery DOM element which represents drop down list container. @@ -21526,7 +21391,7 @@ interface IgCombo { /** * Event which is raised before drop-down list is closed. - * + * * Return false in order to cancel hide action. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo. @@ -21536,7 +21401,7 @@ interface IgCombo { /** * Event which is raised after drop-down list was closed. - * + * * Function takes arguments evt and ui. * Use evt.originalEvent to obtain reference to event of browser. * Use ui.owner to obtain reference to igCombo. @@ -21546,7 +21411,7 @@ interface IgCombo { /** * Event which is raised before selection change. - * + * * Return false in order to cancel change. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo. @@ -21557,7 +21422,7 @@ interface IgCombo { /** * Event which is raised after selection change. - * + * * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo. * Use ui.items to obtain reference to array of new selected items. That can be null. @@ -21571,7 +21436,6 @@ interface IgCombo { [optionName: string]: any; } interface IgComboMethods { - /** * Performs databinding on the combo box. The [databinding](ui.igcombo#events:dataBinding) and [dataBound](ui.igcombo#events:dataBound) events are always raised. */ @@ -21579,7 +21443,7 @@ 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. */ @@ -21888,7 +21752,7 @@ interface IgComboMethods { destroy(): Object; } interface JQuery { - data(propertyName: "igCombo"):IgComboMethods; + data(propertyName: "igCombo"): IgComboMethods; } interface JQuery { @@ -22237,14 +22101,14 @@ interface JQuery { /** * Gets/Sets type of filtering.Note: option is set to "remote", then the "css.waitFiltering" is applied to combo and its drop-down list. - * + * * */ igCombo(optionLiteral: 'option', optionName: "filteringType"): string; /** * /Sets type of filtering.Note: option is set to "remote", then the "css.waitFiltering" is applied to combo and its drop-down list. - * + * * * * @optionValue New value to be set. @@ -22267,14 +22131,14 @@ interface JQuery { /** * Gets/Sets condition used for filtering.Note: When [autoComplete](ui.igcombo#options:autoComplete) is enabled, the filtering condition is always "startsWith". - * + * * */ igCombo(optionLiteral: 'option', optionName: "filteringCondition"): string; /** * /Sets condition used for filtering.Note: When [autoComplete](ui.igcombo#options:autoComplete) is enabled, the filtering condition is always "startsWith". - * + * * * * @optionValue New value to be set. @@ -22630,9 +22494,9 @@ interface JQuery { * Valid options are: * "auto" (default) - uses automatic formatting for Date and number objects. * "none", "", or null - will disable formatting - * + * * Custom values can be something like "currency", "percent", "dateLong", "time", "MMM-dd-yyyy H:mm tt", etc. - * + * * Custom format strings should match the data type in "textKey" column. * */ @@ -22643,9 +22507,9 @@ interface JQuery { * Valid options are: * "auto" (default) - uses automatic formatting for Date and number objects. * "none", "", or null - will disable formatting - * + * * Custom values can be something like "currency", "percent", "dateLong", "time", "MMM-dd-yyyy H:mm tt", etc. - * + * * Custom format strings should match the data type in "textKey" column. * * @@ -22729,7 +22593,7 @@ interface JQuery { /** * Event which is raised after rendering of the combo completes. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the combo performing rendering. * Use ui.element to get a reference to the main/top combo element. @@ -22738,7 +22602,7 @@ interface JQuery { /** * Event which is raised after rendering of the combo completes. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the combo performing rendering. * Use ui.element to get a reference to the main/top combo element. @@ -22749,7 +22613,7 @@ interface JQuery { /** * Event which is raised before data binding is performed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to igCombo performing the databinding. * Use ui.dataSource to get a reference to the [$.ig.DataSource](ig.datasource) combo is to be databound to. @@ -22758,7 +22622,7 @@ interface JQuery { /** * Event which is raised before data binding is performed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to igCombo performing the databinding. * Use ui.dataSource to get a reference to the [$.ig.DataSource](ig.datasource) combo is to be databound to. @@ -22769,7 +22633,7 @@ interface JQuery { /** * Event which is raised after data binding is complete. - * + * * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo performing the data binding. * Use ui.dataSource to get a reference to the [$.ig.DataSource](ig.datasource) combo is databound to. @@ -22780,7 +22644,7 @@ interface JQuery { /** * Event which is raised after data binding is complete. - * + * * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo performing the data binding. * Use ui.dataSource to get a reference to the [$.ig.DataSource](ig.datasource) combo is databound to. @@ -22793,7 +22657,7 @@ interface JQuery { /** * Event which is raised before data filtering. - * + * * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo. * Use ui.expression to obtain reference to array which contains expressions supported by [$.ig.DataSource](ig.datasource). @@ -22803,7 +22667,7 @@ interface JQuery { /** * Event which is raised before data filtering. - * + * * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo. * Use ui.expression to obtain reference to array which contains expressions supported by [$.ig.DataSource](ig.datasource). @@ -22815,7 +22679,7 @@ interface JQuery { /** * Event which is raised after filtering. - * + * * Function takes arguments evt and ui. * Use evt.originalEvent to obtain reference to event of browser. That can be null. * Use ui.owner to obtain reference to igCombo. @@ -22825,7 +22689,7 @@ interface JQuery { /** * Event which is raised after filtering. - * + * * Function takes arguments evt and ui. * Use evt.originalEvent to obtain reference to event of browser. That can be null. * Use ui.owner to obtain reference to igCombo. @@ -22837,7 +22701,7 @@ interface JQuery { /** * Event which is raised before rendering of the combo items is performed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the combo performing rendering. * Use ui.dataSource to get a reference to the [$.ig.DataSource](ig.datasource) combo is databound to. @@ -22846,7 +22710,7 @@ interface JQuery { /** * Event which is raised before rendering of the combo items is performed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the combo performing rendering. * Use ui.dataSource to get a reference to the [$.ig.DataSource](ig.datasource) combo is databound to. @@ -22857,7 +22721,7 @@ interface JQuery { /** * Event which is raised after rendering of the combo items completes. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the combo performing rendering. * Use ui.dataSource to get a reference to the [$.ig.DataSource](ig.datasource) combo is databound to. @@ -22866,7 +22730,7 @@ interface JQuery { /** * Event which is raised after rendering of the combo items completes. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the combo performing rendering. * Use ui.dataSource to get a reference to the [$.ig.DataSource](ig.datasource) combo is databound to. @@ -22877,7 +22741,7 @@ interface JQuery { /** * Event which is raised before drop-down list is opened. - * + * * Return false in order to cancel drop-down action. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo. @@ -22887,7 +22751,7 @@ interface JQuery { /** * Event which is raised before drop-down list is opened. - * + * * Return false in order to cancel drop-down action. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo. @@ -22899,7 +22763,7 @@ interface JQuery { /** * Event which is raised after drop-down list was opened. - * + * * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo. * Use ui.list to obtain reference to jquery DOM element which represents drop down list container. @@ -22908,7 +22772,7 @@ interface JQuery { /** * Event which is raised after drop-down list was opened. - * + * * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo. * Use ui.list to obtain reference to jquery DOM element which represents drop down list container. @@ -22919,7 +22783,7 @@ interface JQuery { /** * Event which is raised before drop-down list is closed. - * + * * Return false in order to cancel hide action. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo. @@ -22929,7 +22793,7 @@ interface JQuery { /** * Event which is raised before drop-down list is closed. - * + * * Return false in order to cancel hide action. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo. @@ -22941,7 +22805,7 @@ interface JQuery { /** * Event which is raised after drop-down list was closed. - * + * * Function takes arguments evt and ui. * Use evt.originalEvent to obtain reference to event of browser. * Use ui.owner to obtain reference to igCombo. @@ -22951,7 +22815,7 @@ interface JQuery { /** * Event which is raised after drop-down list was closed. - * + * * Function takes arguments evt and ui. * Use evt.originalEvent to obtain reference to event of browser. * Use ui.owner to obtain reference to igCombo. @@ -22963,7 +22827,7 @@ interface JQuery { /** * Event which is raised before selection change. - * + * * Return false in order to cancel change. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo. @@ -22974,7 +22838,7 @@ interface JQuery { /** * Event which is raised before selection change. - * + * * Return false in order to cancel change. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo. @@ -22987,7 +22851,7 @@ interface JQuery { /** * Event which is raised after selection change. - * + * * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo. * Use ui.items to obtain reference to array of new selected items. That can be null. @@ -22997,7 +22861,7 @@ interface JQuery { /** * Event which is raised after selection change. - * + * * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo. * Use ui.items to obtain reference to array of new selected items. That can be null. @@ -23017,7 +22881,6 @@ interface StateChangingEvent { } interface StateChangingEventUIParam { - /** * Used to obtain a reference to the igDialog. */ @@ -23049,7 +22912,6 @@ interface StateChangedEvent { } interface StateChangedEventUIParam { - /** * Used to obtain a reference to the igDialog. */ @@ -23081,7 +22943,6 @@ interface AnimationEndedEvent { } interface AnimationEndedEventUIParam { - /** * Used to obtain a reference to the igDialog. */ @@ -23098,7 +22959,6 @@ interface FocusEvent { } interface FocusEventUIParam { - /** * Used to obtain a reference to the igDialog. */ @@ -23110,7 +22970,6 @@ interface BlurEvent { } interface BlurEventUIParam { - /** * Used to obtain a reference to the igDialog. */ @@ -23118,7 +22977,6 @@ interface BlurEventUIParam { } interface IgDialog { - /** * Gets the jquery DIV object which is used as the main container for the dialog. * Notes: @@ -23132,7 +22990,7 @@ interface IgDialog { /** * Gets/Sets the state of the dialog.Note: when the dialog is modal, then pinned and minimized states are not supported, because that will trigger misbehavior. - * + * * * * Valid values: @@ -23238,7 +23096,7 @@ interface IgDialog { /** * Gets/Sets the initial height of the dialog in pixels for normal state.Besides numeric values, following units are supported: "px", "em" and "%". * In case of "%", the size of browser window is used and it has effect only on open action. - * + * * */ height?: number|string; @@ -23246,7 +23104,7 @@ interface IgDialog { /** * Gets/Sets the initial width of the dialog in pixels for normal state.Besides numeric values, following units are supported: "px", "em" and "%". * In case of "%", the size of browser window is used and it has effect only on open action. - * + * * */ width?: number|string; @@ -23388,7 +23246,7 @@ interface IgDialog { * Gets/Sets the processing of the double-click on the dialog-header.If this option is not false and dialog was minimized, then its state will be set to normal. * If this option is set to "auto" and showMaximizeButton is enabled or if this option is set to true, then the dialog will be maximized when it was in normal state, * and dialog-state will be set to normal if it was maximized. - * + * * */ enableDblclick?: any; @@ -23396,7 +23254,7 @@ interface IgDialog { /** * Event which is raised before the state of dialog was changed. * Return false in order to cancel action. - * + * * The function takes arguments "evt" and "ui". * Use evt to obtain the browser event. That parameter can be null if the state was modified from the code. * Use ui.owner to obtain a reference to the igDialog. @@ -23416,7 +23274,7 @@ interface IgDialog { /** * Event which is raised after the state of the dialog was changed. - * + * * The function takes arguments "evt" and "ui". * Use evt to obtain the browser event. That parameter can be null if the state was modified from the code. * Use ui.owner to obtain a reference to the igDialog. @@ -23436,7 +23294,7 @@ interface IgDialog { /** * Event which is raised after the end of the animation when the dialod was closed or opened. - * + * * The function takes arguments "evt" and "ui". * Use ui.owner to obtain a reference to the igDialog. * Use ui.action to obtain the name of the action, which triggered the animation. @@ -23447,7 +23305,7 @@ interface IgDialog { /** * Event which is raised when the dialog or its content gets focus. - * + * * The function takes arguments "evt" and "ui". * Use evt to obtain the browser event. * Use ui.owner to obtain a reference to the igDialog. @@ -23456,7 +23314,7 @@ interface IgDialog { /** * Event which is raised when the dialog or its content loses focus. - * + * * The function takes arguments "evt" and "ui". * Use evt to obtain the browser event. * Use ui.owner to obtain a reference to the igDialog. @@ -23469,7 +23327,6 @@ interface IgDialog { [optionName: string]: any; } interface IgDialogMethods { - /** * Destroys the igDialog and moves the target element to its original parent. */ @@ -23565,7 +23422,7 @@ interface IgDialogMethods { content(newContent?: string): Object; } interface JQuery { - data(propertyName: "igDialog"):IgDialogMethods; + data(propertyName: "igDialog"): IgDialogMethods; } interface JQuery { @@ -23610,14 +23467,14 @@ interface JQuery { /** * Gets/Sets the state of the dialog.Note: when the dialog is modal, then pinned and minimized states are not supported, because that will trigger misbehavior. - * + * * */ igDialog(optionLiteral: 'option', optionName: "state"): string; /** * /Sets the state of the dialog.Note: when the dialog is modal, then pinned and minimized states are not supported, because that will trigger misbehavior. - * + * * * * @optionValue New value to be set. @@ -23839,7 +23696,7 @@ interface JQuery { /** * Gets/Sets the initial height of the dialog in pixels for normal state.Besides numeric values, following units are supported: "px", "em" and "%". * In case of "%", the size of browser window is used and it has effect only on open action. - * + * * */ igDialog(optionLiteral: 'option', optionName: "height"): number|string; @@ -23847,7 +23704,7 @@ interface JQuery { /** * /Sets the initial height of the dialog in pixels for normal state.Besides numeric values, following units are supported: "px", "em" and "%". * In case of "%", the size of browser window is used and it has effect only on open action. - * + * * * * @optionValue New value to be set. @@ -23857,7 +23714,7 @@ interface JQuery { /** * Gets/Sets the initial width of the dialog in pixels for normal state.Besides numeric values, following units are supported: "px", "em" and "%". * In case of "%", the size of browser window is used and it has effect only on open action. - * + * * */ igDialog(optionLiteral: 'option', optionName: "width"): number|string; @@ -23865,7 +23722,7 @@ interface JQuery { /** * /Sets the initial width of the dialog in pixels for normal state.Besides numeric values, following units are supported: "px", "em" and "%". * In case of "%", the size of browser window is used and it has effect only on open action. - * + * * * * @optionValue New value to be set. @@ -24184,7 +24041,7 @@ interface JQuery { * Gets/Sets the processing of the double-click on the dialog-header.If this option is not false and dialog was minimized, then its state will be set to normal. * If this option is set to "auto" and showMaximizeButton is enabled or if this option is set to true, then the dialog will be maximized when it was in normal state, * and dialog-state will be set to normal if it was maximized. - * + * * */ igDialog(optionLiteral: 'option', optionName: "enableDblclick"): any; @@ -24193,7 +24050,7 @@ interface JQuery { * /Sets the processing of the double-click on the dialog-header.If this option is not false and dialog was minimized, then its state will be set to normal. * If this option is set to "auto" and showMaximizeButton is enabled or if this option is set to true, then the dialog will be maximized when it was in normal state, * and dialog-state will be set to normal if it was maximized. - * + * * * * @optionValue New value to be set. @@ -24203,7 +24060,7 @@ interface JQuery { /** * Event which is raised before the state of dialog was changed. * Return false in order to cancel action. - * + * * The function takes arguments "evt" and "ui". * Use evt to obtain the browser event. That parameter can be null if the state was modified from the code. * Use ui.owner to obtain a reference to the igDialog. @@ -24224,7 +24081,7 @@ interface JQuery { /** * Event which is raised before the state of dialog was changed. * Return false in order to cancel action. - * + * * The function takes arguments "evt" and "ui". * Use evt to obtain the browser event. That parameter can be null if the state was modified from the code. * Use ui.owner to obtain a reference to the igDialog. @@ -24246,7 +24103,7 @@ interface JQuery { /** * Event which is raised after the state of the dialog was changed. - * + * * The function takes arguments "evt" and "ui". * Use evt to obtain the browser event. That parameter can be null if the state was modified from the code. * Use ui.owner to obtain a reference to the igDialog. @@ -24266,7 +24123,7 @@ interface JQuery { /** * Event which is raised after the state of the dialog was changed. - * + * * The function takes arguments "evt" and "ui". * Use evt to obtain the browser event. That parameter can be null if the state was modified from the code. * Use ui.owner to obtain a reference to the igDialog. @@ -24288,7 +24145,7 @@ interface JQuery { /** * Event which is raised after the end of the animation when the dialod was closed or opened. - * + * * The function takes arguments "evt" and "ui". * Use ui.owner to obtain a reference to the igDialog. * Use ui.action to obtain the name of the action, which triggered the animation. @@ -24299,7 +24156,7 @@ interface JQuery { /** * Event which is raised after the end of the animation when the dialod was closed or opened. - * + * * The function takes arguments "evt" and "ui". * Use ui.owner to obtain a reference to the igDialog. * Use ui.action to obtain the name of the action, which triggered the animation. @@ -24312,7 +24169,7 @@ interface JQuery { /** * Event which is raised when the dialog or its content gets focus. - * + * * The function takes arguments "evt" and "ui". * Use evt to obtain the browser event. * Use ui.owner to obtain a reference to the igDialog. @@ -24321,7 +24178,7 @@ interface JQuery { /** * Event which is raised when the dialog or its content gets focus. - * + * * The function takes arguments "evt" and "ui". * Use evt to obtain the browser event. * Use ui.owner to obtain a reference to the igDialog. @@ -24332,7 +24189,7 @@ interface JQuery { /** * Event which is raised when the dialog or its content loses focus. - * + * * The function takes arguments "evt" and "ui". * Use evt to obtain the browser event. * Use ui.owner to obtain a reference to the igDialog. @@ -24341,7 +24198,7 @@ interface JQuery { /** * Event which is raised when the dialog or its content loses focus. - * + * * The function takes arguments "evt" and "ui". * Use evt to obtain the browser event. * Use ui.owner to obtain a reference to the igDialog. @@ -24356,7 +24213,6 @@ interface JQuery { igDialog(methodName: string, ...methodParams: any[]): any; } interface IgDoughnutChartSeries { - /** * Gets or sets the current series type. * @@ -24399,10 +24255,10 @@ interface IgDoughnutChartSeries { * Gets or sets the position of chart labels. * * Valid values: - * "none" - * "center" - * "insideEnd" - * "outsideEnd" + * "none" + * "center" + * "insideEnd" + * "outsideEnd" * "bestFit" */ labelsPosition?: string; @@ -24411,7 +24267,7 @@ interface IgDoughnutChartSeries { * Gets or sets whether the leader lines are visible. * * Valid values: - * "visible" + * "visible" * "collapsed" */ leaderLineVisibility?: string; @@ -24425,8 +24281,8 @@ interface IgDoughnutChartSeries { * Gets or sets what type of leader lines will be used for the outside end labels. * * Valid values: - * "straight" - * "arc" + * "straight" + * "arc" * "spline" */ leaderLineType?: string; @@ -24445,7 +24301,7 @@ interface IgDoughnutChartSeries { * Gets or sets whether to use numeric or percent-based threshold value. * * Valid values: - * "number" + * "number" * "percent" */ othersCategoryType?: string; @@ -24524,7 +24380,6 @@ interface HoleDimensionsChangedEventUIParam { } interface IgDoughnutChart { - /** * The width of the chart. It can be set as a number in pixels, string (px) or percentage (%). */ @@ -24604,7 +24459,7 @@ interface IgDoughnutChart { responseDataKey?: string; /** - * Event fired when the mouse has hovered on a series and the tooltip is about to show + * Event fired when the mouse has hovered on a series and the tooltip is about to show * Function takes arguments evt and ui. * Use ui.element to get reference to tooltip DOM element. * Use ui.item to get reference to current series item object. @@ -24640,7 +24495,7 @@ interface IgDoughnutChart { tooltipHiding?: TooltipHidingEvent; /** - * Event fired after a tooltip is hidden + * Event fired after a tooltip is hidden * Function takes arguments evt and ui. * Use ui.element to get reference to tooltip DOM element. * Use ui.item to get reference to current series item object. @@ -24713,7 +24568,6 @@ interface IgDoughnutChart { [optionName: string]: any; } interface IgDoughnutChartMethods { - /** * Adds a new series to the doughnut chart. * @@ -24858,7 +24712,7 @@ interface IgDoughnutChartMethods { dataBind(): void; } interface JQuery { - data(propertyName: "igDoughnutChart"):IgDoughnutChartMethods; + data(propertyName: "igDoughnutChart"): IgDoughnutChartMethods; } interface JQuery { @@ -25071,7 +24925,7 @@ interface JQuery { igDoughnutChart(optionLiteral: 'option', optionName: "responseDataKey", optionValue: string): void; /** - * Event fired when the mouse has hovered on a series and the tooltip is about to show + * Event fired when the mouse has hovered on a series and the tooltip is about to show * Function takes arguments evt and ui. * Use ui.element to get reference to tooltip DOM element. * Use ui.item to get reference to current series item object. @@ -25083,7 +24937,7 @@ interface JQuery { igDoughnutChart(optionLiteral: 'option', optionName: "tooltipShowing"): TooltipShowingEvent; /** - * Event fired when the mouse has hovered on a series and the tooltip is about to show + * Event fired when the mouse has hovered on a series and the tooltip is about to show * Function takes arguments evt and ui. * Use ui.element to get reference to tooltip DOM element. * Use ui.item to get reference to current series item object. @@ -25149,7 +25003,7 @@ interface JQuery { igDoughnutChart(optionLiteral: 'option', optionName: "tooltipHiding", optionValue: TooltipHidingEvent): void; /** - * Event fired after a tooltip is hidden + * Event fired after a tooltip is hidden * Function takes arguments evt and ui. * Use ui.element to get reference to tooltip DOM element. * Use ui.item to get reference to current series item object. @@ -25161,7 +25015,7 @@ interface JQuery { igDoughnutChart(optionLiteral: 'option', optionName: "tooltipHidden"): TooltipHiddenEvent; /** - * Event fired after a tooltip is hidden + * Event fired after a tooltip is hidden * Function takes arguments evt and ui. * Use ui.element to get reference to tooltip DOM element. * Use ui.item to get reference to current series item object. @@ -25310,7 +25164,6 @@ interface RenderingEvent { } interface RenderingEventUIParam { - /** * Used to get a reference to the editor performing rendering. */ @@ -25327,7 +25180,6 @@ interface MousedownEvent { } interface MousedownEventUIParam { - /** * Used to obtain reference to igEditor. */ @@ -25349,7 +25201,6 @@ interface MouseupEvent { } interface MouseupEventUIParam { - /** * Used to obtain reference to igEditor. */ @@ -25371,7 +25222,6 @@ interface MousemoveEvent { } interface MousemoveEventUIParam { - /** * Used to obtain reference to igEditor. */ @@ -25393,7 +25243,6 @@ interface MouseoverEvent { } interface MouseoverEventUIParam { - /** * Used to obtain reference to igEditor. */ @@ -25415,7 +25264,6 @@ interface MouseoutEvent { } interface MouseoutEventUIParam { - /** * Used to obtain reference to igEditor. */ @@ -25437,7 +25285,6 @@ interface KeydownEvent { } interface KeydownEventUIParam { - /** * Used to obtain reference to igEditor. */ @@ -25454,7 +25301,6 @@ interface KeypressEvent { } interface KeypressEventUIParam { - /** * Used to obtain reference to igEditor. */ @@ -25471,7 +25317,6 @@ interface KeyupEvent { } interface KeyupEventUIParam { - /** * Used to obtain reference to igEditor. */ @@ -25488,7 +25333,6 @@ interface ValueChangingEvent { } interface ValueChangingEventUIParam { - /** * Used to obtain reference to igEditor. */ @@ -25515,7 +25359,6 @@ interface ValueChangedEvent { } interface ValueChangedEventUIParam { - /** * Used to obtain reference to igEditor. */ @@ -25538,7 +25381,6 @@ interface ValueChangedEventUIParam { } interface IgBaseEditor { - /** * Gets/Sets the width of the control. * @@ -25744,7 +25586,6 @@ interface IgBaseEditor { [optionName: string]: any; } interface IgBaseEditorMethods { - /** * Gets/Sets name attribute applied to the editor element. * @@ -25806,7 +25647,7 @@ interface IgBaseEditorMethods { destroy(): void; } interface JQuery { - data(propertyName: "igBaseEditor"):IgBaseEditorMethods; + data(propertyName: "igBaseEditor"): IgBaseEditorMethods; } interface DropDownListOpeningEvent { @@ -25814,7 +25655,6 @@ interface DropDownListOpeningEvent { } interface DropDownListOpeningEventUIParam { - /** * Used to obtain reference to igEditor. */ @@ -25836,7 +25676,6 @@ interface DropDownListOpenedEvent { } interface DropDownListOpenedEventUIParam { - /** * Used to obtain reference to igEditor. */ @@ -25858,7 +25697,6 @@ interface DropDownListClosingEvent { } interface DropDownListClosingEventUIParam { - /** * Used to obtain reference to igEditor. */ @@ -25880,7 +25718,6 @@ interface DropDownListClosedEvent { } interface DropDownListClosedEventUIParam { - /** * Used to obtain reference to igEditor. */ @@ -25902,7 +25739,6 @@ interface DropDownItemSelectingEvent { } interface DropDownItemSelectingEventUIParam { - /** * Used to obtain reference to igEditor. */ @@ -25929,7 +25765,6 @@ interface DropDownItemSelectedEvent { } interface DropDownItemSelectedEventUIParam { - /** * Used to obtain reference to igEditor. */ @@ -25956,7 +25791,6 @@ interface TextChangedEvent { } interface TextChangedEventUIParam { - /** * Used to obtain reference to igEditor. */ @@ -25974,10 +25808,9 @@ interface TextChangedEventUIParam { } interface IgTextEditor { - /** * Gets visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. - * + * * * * Valid values: @@ -26435,7 +26268,6 @@ interface IgTextEditor { [optionName: string]: any; } interface IgTextEditorMethods { - /** * Gets the visible text in the editor. */ @@ -26603,11 +26435,10 @@ interface IgTextEditorMethods { destroy(): void; } interface JQuery { - data(propertyName: "igTextEditor"):IgTextEditorMethods; + data(propertyName: "igTextEditor"): IgTextEditorMethods; } 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. @@ -26701,7 +26532,7 @@ interface IgNumericEditor { * Defines the range that editor's value can accept.This is achieved by setting the [minValue](ui.igNumericEditor#options:minValue) and [maxValue](ui.igNumericEditor#options:maxValue) editor's options, accordingly to the lowest and highest accepted values for the defined numeric mode. * The range for the specific type follows the numeric type standards, e.g. in .NET Framework [floating-point](https://msdn.microsoft.com/en-us/library/9ahet949.aspx) types and [integral types](https://msdn.microsoft.com/en-us/library/exx3b86w.aspx). * In addition, the maximum value that can be set to [minDecimals](ui.igNumericEditor#options:minDecimals) and [maxDecimals](ui.igNumericEditor#options:maxDecimals) options can be 15, when editor is in 'double' mode and 7, when in 'float' mode. - * + * * * * Valid values: @@ -26747,7 +26578,7 @@ interface IgNumericEditor { * Gets/Sets support for scientific format in edit mode. * 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. - * + * * * * Valid values: @@ -26791,20 +26622,20 @@ interface IgNumericEditor { toUpper?: any; /** - * + * */ textMode?: any; /** * Gets/Sets value in editor. The effect of setting/getting that option depends on type of editor and on dataMode options for every type of editor. - * + * * */ value?: any; /** * Gets visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. - * + * * * * Valid values: @@ -27045,7 +26876,6 @@ interface IgNumericEditor { [optionName: string]: any; } interface IgNumericEditorMethods { - /** * Gets/Sets editor value. * @@ -27166,11 +26996,10 @@ interface IgNumericEditorMethods { spinDownButton(): string; } interface JQuery { - data(propertyName: "igNumericEditor"):IgNumericEditorMethods; + data(propertyName: "igNumericEditor"): IgNumericEditorMethods; } interface IgCurrencyEditor { - /** * Gets/Sets the string, which is used as positive pattern. The "n" flag represents the value of number. * Note: This option has priority over possible regional settings. @@ -27278,7 +27107,7 @@ interface IgCurrencyEditor { * Defines the range that editor's value can accept.This is achieved by setting the [minValue](ui.igNumericEditor#options:minValue) and [maxValue](ui.igNumericEditor#options:maxValue) editor's options, accordingly to the lowest and highest accepted values for the defined numeric mode. * The range for the specific type follows the numeric type standards, e.g. in .NET Framework [floating-point](https://msdn.microsoft.com/en-us/library/9ahet949.aspx) types and [integral types](https://msdn.microsoft.com/en-us/library/exx3b86w.aspx). * In addition, the maximum value that can be set to [minDecimals](ui.igNumericEditor#options:minDecimals) and [maxDecimals](ui.igNumericEditor#options:maxDecimals) options can be 15, when editor is in 'double' mode and 7, when in 'float' mode. - * + * * * * Valid values: @@ -27324,7 +27153,7 @@ interface IgCurrencyEditor { * Gets/Sets support for scientific format in edit mode. * 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. - * + * * * * Valid values: @@ -27368,20 +27197,20 @@ interface IgCurrencyEditor { toUpper?: any; /** - * + * */ textMode?: any; /** * Gets/Sets value in editor. The effect of setting/getting that option depends on type of editor and on dataMode options for every type of editor. - * + * * */ value?: any; /** * Gets visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. - * + * * * * Valid values: @@ -27556,7 +27385,6 @@ interface IgCurrencyEditor { [optionName: string]: any; } interface IgCurrencyEditorMethods { - /** * Gets/sets a string that is used as the currency symbol shown with the number in the input. The value provided as a param is propagated to the currencySymbol option and thus has the same priority as the option. * @@ -27611,11 +27439,10 @@ interface IgCurrencyEditorMethods { getRegionalOption(): string; } interface JQuery { - data(propertyName: "igCurrencyEditor"):IgCurrencyEditorMethods; + data(propertyName: "igCurrencyEditor"): IgCurrencyEditorMethods; } interface IgPercentEditor { - /** * Gets/Sets the pattern for positive numeric values, which is used in display (no focus) state. * If you use the "en-US" culture the default value for "positivePattern" will be "n$" where the "$" flag represents the "numericSymbol" and the "n" flag represents the value of the number. @@ -27645,7 +27472,7 @@ interface IgPercentEditor { * Defines the range that editor's value can accept.This is achieved by setting the [minValue](ui.igPercentEditor#options:minValue) and [maxValue](ui.igPercentEditor#options:maxValue) editor's options, accordingly to the lowest and highest accepted values for the defined numeric mode. * The range for the specific type follows the numeric type standards, e.g. in .NET Framework [floating-point](https://msdn.microsoft.com/en-us/library/9ahet949.aspx) types and [integral types](https://msdn.microsoft.com/en-us/library/exx3b86w.aspx). * In addition, the maximum value that can be set to [minDecimals](ui.igPercentEditor#options:minDecimals) and [maxDecimals](ui.igPercentEditor#options:maxDecimals) options can be 15, when editor is in 'double' mode and 7, when in 'float' mode. - * + * * * * Valid values: @@ -27780,7 +27607,7 @@ interface IgPercentEditor { * Gets/Sets support for scientific format in edit mode. * 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. - * + * * * * Valid values: @@ -27824,20 +27651,20 @@ interface IgPercentEditor { toUpper?: any; /** - * + * */ textMode?: any; /** * Gets/Sets value in editor. The effect of setting/getting that option depends on type of editor and on dataMode options for every type of editor. - * + * * */ value?: any; /** * Gets visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. - * + * * * * Valid values: @@ -28012,7 +27839,6 @@ interface IgPercentEditor { [optionName: string]: any; } 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. @@ -28075,11 +27901,10 @@ interface IgPercentEditorMethods { getRegionalOption(): string; } interface JQuery { - data(propertyName: "igPercentEditor"):IgPercentEditorMethods; + data(propertyName: "igPercentEditor"): IgPercentEditorMethods; } interface IgMaskEditor { - /** * Gets custom regional settings for editor. If it is string, then $.ig.regional[stringValue] is assumed. * @@ -28088,7 +27913,7 @@ 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. */ buttonType?: string; @@ -28212,7 +28037,7 @@ interface IgMaskEditor { dropDownOnReadOnly?: boolean; /** - * + * */ textMode?: any; @@ -28387,7 +28212,6 @@ interface IgMaskEditor { [optionName: string]: any; } interface IgMaskEditorMethods { - /** * Gets/Sets mask editor value. * @@ -28454,11 +28278,10 @@ interface IgMaskEditorMethods { select(start: number, end: number): void; } interface JQuery { - data(propertyName: "igMaskEditor"):IgMaskEditorMethods; + data(propertyName: "igMaskEditor"): IgMaskEditorMethods; } 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. @@ -28722,7 +28545,7 @@ interface IgDateEditor { dropDownOrientation?: string; /** - * + * */ textMode?: any; @@ -28885,10 +28708,9 @@ interface IgDateEditor { [optionName: string]: any; } interface IgDateEditorMethods { - /** * Gets/Sets editor value. - * + * * Note! This option doesn't use the displayInputFormat 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"/). @@ -28903,7 +28725,7 @@ interface IgDateEditorMethods { /** * Sets selected date. * - * @param date + * @param date */ selectDate(date: Object): void; @@ -28945,7 +28767,7 @@ interface IgDateEditorMethods { hideDropDown(): void; } interface JQuery { - data(propertyName: "igDateEditor"):IgDateEditorMethods; + data(propertyName: "igDateEditor"): IgDateEditorMethods; } interface ItemSelectedEvent { @@ -28953,7 +28775,6 @@ interface ItemSelectedEvent { } interface ItemSelectedEventUIParam { - /** * Used to obtain reference to igEditor. */ @@ -28976,7 +28797,6 @@ interface ItemSelectedEventUIParam { } interface IgDatePicker { - /** * Gets/Sets the custom regional settings for the editor. If it is a string, then $.ig.regional[stringValue] is assumed. * @@ -29249,7 +29069,7 @@ interface IgDatePicker { dropDownOrientation?: string; /** - * + * */ textMode?: any; @@ -29434,7 +29254,6 @@ interface IgDatePicker { [optionName: string]: any; } interface IgDatePickerMethods { - /** * Returns a reference to the jQuery calendar used as a picker selector */ @@ -29471,7 +29290,7 @@ interface IgDatePickerMethods { /** * Gets/Sets editor value. - * + * * Note! This option doesn't use the displayInputFormat 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"/). @@ -29486,7 +29305,7 @@ interface IgDatePickerMethods { /** * Sets selected date. * - * @param date + * @param date */ selectDate(date: Object): void; @@ -29520,11 +29339,10 @@ interface IgDatePickerMethods { isValid(): boolean; } interface JQuery { - data(propertyName: "igDatePicker"):IgDatePickerMethods; + data(propertyName: "igDatePicker"): IgDatePickerMethods; } interface IgCheckboxEditor { - /** * Gets/Sets whether the checkbox is checked. * @@ -29533,7 +29351,7 @@ interface IgCheckboxEditor { /** * Gets/Sets size of the checkbox based on preset styles.For different sizes, define 'width' and 'height' options instead. - * + * * * * Valid values: @@ -29748,7 +29566,6 @@ interface IgCheckboxEditor { [optionName: string]: any; } interface IgCheckboxEditorMethods { - /** * Checks if the value in the editor is valid. Note: This function will not trigger automatic notifications. */ @@ -29761,7 +29578,7 @@ interface IgCheckboxEditorMethods { * 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 + * @param newValue */ value(newValue: Object): string; @@ -29825,7 +29642,7 @@ interface IgCheckboxEditorMethods { destroy(): void; } interface JQuery { - data(propertyName: "igCheckboxEditor"):IgCheckboxEditorMethods; + data(propertyName: "igCheckboxEditor"): IgCheckboxEditorMethods; } interface JQuery { @@ -30316,14 +30133,14 @@ interface JQuery { /** * Gets visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. - * + * * */ igTextEditor(optionLiteral: 'option', optionName: "buttonType"): string; /** * Visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. - * + * * * * @optionValue New value to be set. @@ -31490,7 +31307,7 @@ interface JQuery { * Defines the range that editor's value can accept.This is achieved by setting the [minValue](ui.igNumericEditor#options:minValue) and [maxValue](ui.igNumericEditor#options:maxValue) editor's options, accordingly to the lowest and highest accepted values for the defined numeric mode. * The range for the specific type follows the numeric type standards, e.g. in .NET Framework [floating-point](https://msdn.microsoft.com/en-us/library/9ahet949.aspx) types and [integral types](https://msdn.microsoft.com/en-us/library/exx3b86w.aspx). * In addition, the maximum value that can be set to [minDecimals](ui.igNumericEditor#options:minDecimals) and [maxDecimals](ui.igNumericEditor#options:maxDecimals) options can be 15, when editor is in 'double' mode and 7, when in 'float' mode. - * + * * */ igNumericEditor(optionLiteral: 'option', optionName: "dataMode"): string; @@ -31499,7 +31316,7 @@ interface JQuery { * Defines the range that editor's value can accept.This is achieved by setting the [minValue](ui.igNumericEditor#options:minValue) and [maxValue](ui.igNumericEditor#options:maxValue) editor's options, accordingly to the lowest and highest accepted values for the defined numeric mode. * The range for the specific type follows the numeric type standards, e.g. in .NET Framework [floating-point](https://msdn.microsoft.com/en-us/library/9ahet949.aspx) types and [integral types](https://msdn.microsoft.com/en-us/library/exx3b86w.aspx). * In addition, the maximum value that can be set to [minDecimals](ui.igNumericEditor#options:minDecimals) and [maxDecimals](ui.igNumericEditor#options:maxDecimals) options can be 15, when editor is in 'double' mode and 7, when in 'float' mode. - * + * * * * @optionValue New value to be set. @@ -31568,7 +31385,7 @@ interface JQuery { * Gets/Sets support for scientific format in edit mode. * If that option is set, then numeric value appears as a string with possible E-power flag. In edit mode the "E" or "e" character can be entered as well. * Notes: The "+" character is not supported in edit mode. - * + * * */ igNumericEditor(optionLiteral: 'option', optionName: "scientificFormat"): string; @@ -31577,7 +31394,7 @@ interface JQuery { * /Sets support for scientific format in edit mode. * 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. - * + * * * * @optionValue New value to be set. @@ -31668,14 +31485,14 @@ interface JQuery { /** * Gets/Sets value in editor. The effect of setting/getting that option depends on type of editor and on dataMode options for every type of editor. - * + * * */ igNumericEditor(optionLiteral: 'option', optionName: "value"): any; /** * /Sets value in editor. The effect of setting/getting that option depends on type of editor and on dataMode options for every type of editor. - * + * * * * @optionValue New value to be set. @@ -31684,14 +31501,14 @@ interface JQuery { /** * Gets visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. - * + * * */ igNumericEditor(optionLiteral: 'option', optionName: "buttonType"): string; /** * Visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. - * + * * * * @optionValue New value to be set. @@ -32414,7 +32231,7 @@ interface JQuery { * Defines the range that editor's value can accept.This is achieved by setting the [minValue](ui.igNumericEditor#options:minValue) and [maxValue](ui.igNumericEditor#options:maxValue) editor's options, accordingly to the lowest and highest accepted values for the defined numeric mode. * The range for the specific type follows the numeric type standards, e.g. in .NET Framework [floating-point](https://msdn.microsoft.com/en-us/library/9ahet949.aspx) types and [integral types](https://msdn.microsoft.com/en-us/library/exx3b86w.aspx). * In addition, the maximum value that can be set to [minDecimals](ui.igNumericEditor#options:minDecimals) and [maxDecimals](ui.igNumericEditor#options:maxDecimals) options can be 15, when editor is in 'double' mode and 7, when in 'float' mode. - * + * * */ igCurrencyEditor(optionLiteral: 'option', optionName: "dataMode"): string; @@ -32423,7 +32240,7 @@ interface JQuery { * Defines the range that editor's value can accept.This is achieved by setting the [minValue](ui.igNumericEditor#options:minValue) and [maxValue](ui.igNumericEditor#options:maxValue) editor's options, accordingly to the lowest and highest accepted values for the defined numeric mode. * The range for the specific type follows the numeric type standards, e.g. in .NET Framework [floating-point](https://msdn.microsoft.com/en-us/library/9ahet949.aspx) types and [integral types](https://msdn.microsoft.com/en-us/library/exx3b86w.aspx). * In addition, the maximum value that can be set to [minDecimals](ui.igNumericEditor#options:minDecimals) and [maxDecimals](ui.igNumericEditor#options:maxDecimals) options can be 15, when editor is in 'double' mode and 7, when in 'float' mode. - * + * * * * @optionValue New value to be set. @@ -32492,7 +32309,7 @@ interface JQuery { * Gets/Sets support for scientific format in edit mode. * If that option is set, then numeric value appears as a string with possible E-power flag. In edit mode the "E" or "e" character can be entered as well. * Notes: The "+" character is not supported in edit mode. - * + * * */ igCurrencyEditor(optionLiteral: 'option', optionName: "scientificFormat"): string; @@ -32501,7 +32318,7 @@ interface JQuery { * /Sets support for scientific format in edit mode. * 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. - * + * * * * @optionValue New value to be set. @@ -32592,14 +32409,14 @@ interface JQuery { /** * Gets/Sets value in editor. The effect of setting/getting that option depends on type of editor and on dataMode options for every type of editor. - * + * * */ igCurrencyEditor(optionLiteral: 'option', optionName: "value"): any; /** * /Sets value in editor. The effect of setting/getting that option depends on type of editor and on dataMode options for every type of editor. - * + * * * * @optionValue New value to be set. @@ -32608,14 +32425,14 @@ interface JQuery { /** * Gets visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. - * + * * */ igCurrencyEditor(optionLiteral: 'option', optionName: "buttonType"): string; /** * Visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. - * + * * * * @optionValue New value to be set. @@ -33029,7 +32846,7 @@ interface JQuery { * Defines the range that editor's value can accept.This is achieved by setting the [minValue](ui.igPercentEditor#options:minValue) and [maxValue](ui.igPercentEditor#options:maxValue) editor's options, accordingly to the lowest and highest accepted values for the defined numeric mode. * The range for the specific type follows the numeric type standards, e.g. in .NET Framework [floating-point](https://msdn.microsoft.com/en-us/library/9ahet949.aspx) types and [integral types](https://msdn.microsoft.com/en-us/library/exx3b86w.aspx). * In addition, the maximum value that can be set to [minDecimals](ui.igPercentEditor#options:minDecimals) and [maxDecimals](ui.igPercentEditor#options:maxDecimals) options can be 15, when editor is in 'double' mode and 7, when in 'float' mode. - * + * * */ igPercentEditor(optionLiteral: 'option', optionName: "dataMode"): string; @@ -33038,7 +32855,7 @@ interface JQuery { * Defines the range that editor's value can accept.This is achieved by setting the [minValue](ui.igPercentEditor#options:minValue) and [maxValue](ui.igPercentEditor#options:maxValue) editor's options, accordingly to the lowest and highest accepted values for the defined numeric mode. * The range for the specific type follows the numeric type standards, e.g. in .NET Framework [floating-point](https://msdn.microsoft.com/en-us/library/9ahet949.aspx) types and [integral types](https://msdn.microsoft.com/en-us/library/exx3b86w.aspx). * In addition, the maximum value that can be set to [minDecimals](ui.igPercentEditor#options:minDecimals) and [maxDecimals](ui.igPercentEditor#options:maxDecimals) options can be 15, when editor is in 'double' mode and 7, when in 'float' mode. - * + * * * * @optionValue New value to be set. @@ -33295,7 +33112,7 @@ interface JQuery { * Gets/Sets support for scientific format in edit mode. * If that option is set, then numeric value appears as a string with possible E-power flag. In edit mode the "E" or "e" character can be entered as well. * Notes: The "+" character is not supported in edit mode. - * + * * */ igPercentEditor(optionLiteral: 'option', optionName: "scientificFormat"): string; @@ -33304,7 +33121,7 @@ interface JQuery { * /Sets support for scientific format in edit mode. * 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. - * + * * * * @optionValue New value to be set. @@ -33395,14 +33212,14 @@ interface JQuery { /** * Gets/Sets value in editor. The effect of setting/getting that option depends on type of editor and on dataMode options for every type of editor. - * + * * */ igPercentEditor(optionLiteral: 'option', optionName: "value"): any; /** * /Sets value in editor. The effect of setting/getting that option depends on type of editor and on dataMode options for every type of editor. - * + * * * * @optionValue New value to be set. @@ -33411,14 +33228,14 @@ interface JQuery { /** * Gets visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. - * + * * */ igPercentEditor(optionLiteral: 'option', optionName: "buttonType"): string; /** * Visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. - * + * * * * @optionValue New value to be set. @@ -33797,14 +33614,14 @@ 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. @@ -36383,14 +36200,14 @@ interface JQuery { /** * Gets/Sets size of the checkbox based on preset styles.For different sizes, define 'width' and 'height' options instead. - * + * * */ igCheckboxEditor(optionLiteral: 'option', optionName: "size"): string; /** * /Sets size of the checkbox based on preset styles.For different sizes, define 'width' and 'height' options instead. - * + * * * * @optionValue New value to be set. @@ -36849,7 +36666,6 @@ interface SliceClickedEvent { } interface SliceClickedEventUIParam { - /** * Used to obtain reference to igFunnelChart. */ @@ -36872,7 +36688,6 @@ interface SliceClickedEventUIParam { } interface IgFunnelChart { - /** * Gets or sets values for upper and lower bezier points. That option has effect only when useBezierCurve is enabled. * Value should provide 4 numeric values in range from 0 to 1 separated by space character. @@ -36935,7 +36750,7 @@ interface IgFunnelChart { * Gets or sets whether the inner labels are visible. * * Valid values: - * "visible" + * "visible" * "collapsed" */ innerLabelVisibility?: string; @@ -36944,7 +36759,7 @@ interface IgFunnelChart { * Gets or sets whether the outer labels are visible. * * Valid values: - * "visible" + * "visible" * "collapsed" */ outerLabelVisibility?: string; @@ -37167,7 +36982,6 @@ interface IgFunnelChart { [optionName: string]: any; } interface IgFunnelChartMethods { - /** * Gets array of selected slice items. * @@ -37302,7 +37116,7 @@ interface IgFunnelChartMethods { dataBind(): void; } interface JQuery { - data(propertyName: "igFunnelChart"):IgFunnelChartMethods; + data(propertyName: "igFunnelChart"): IgFunnelChartMethods; } interface JQuery { @@ -37974,7 +37788,6 @@ interface JQuery { igFunnelChart(methodName: string, ...methodParams: any[]): any; } interface IgPopoverHeaderTemplate { - /** * Controls whether the popover renders a functional close button */ @@ -37996,7 +37809,6 @@ interface ShowingEvent { } interface ShowingEventUIParam { - /** * Used to get the element the popover will show for. */ @@ -38023,7 +37835,6 @@ interface ShownEvent { } interface ShownEventUIParam { - /** * Used to get the element the popover showed for. */ @@ -38050,7 +37861,6 @@ interface HidingEvent { } interface HidingEventUIParam { - /** * Used to get the element the popover will hide for. */ @@ -38077,7 +37887,6 @@ interface HiddenEvent { } interface HiddenEventUIParam { - /** * Used to get the element the popover is hidden for. */ @@ -38300,7 +38109,7 @@ interface IgGridFeatureChooserPopoverMethods { setCoordinates(pos: Object): void; } interface JQuery { - data(propertyName: "igGridFeatureChooserPopover"):IgGridFeatureChooserPopoverMethods; + data(propertyName: "igGridFeatureChooserPopover"): IgGridFeatureChooserPopoverMethods; } interface FeatureChooserRenderingEvent { @@ -38401,7 +38210,7 @@ interface IgGridFeatureChooserMethods { destroy(e: Object, args: Object): void; } interface JQuery { - data(propertyName: "igGridFeatureChooser"):IgGridFeatureChooserMethods; + data(propertyName: "igGridFeatureChooser"): IgGridFeatureChooserMethods; } interface JQuery { @@ -38787,7 +38596,6 @@ interface JQuery { igGridFeatureChooser(methodName: string, ...methodParams: any[]): any; } interface IgGridGroupByGroupedColumn { - /** * Key of the column that's grouped */ @@ -38818,7 +38626,6 @@ interface IgGridGroupByGroupedColumn { } interface IgGridGroupBySummarySettings { - /** * Specifies the delimiter for multiple summaries. * @@ -38838,7 +38645,6 @@ interface IgGridGroupBySummarySettings { } interface IgGridGroupByColumnSettingsSummaries { - /** * the summary function key * @@ -38865,7 +38671,7 @@ interface IgGridGroupByColumnSettingsSummaries { * array - array of cell values for the specified column, * key - key of the grouped column, * allGroupData - array of data records for the group(for the whole data source - not only for the data view) - * + * * * * Valid values: @@ -38881,7 +38687,6 @@ interface IgGridGroupByColumnSettingsSummaries { } interface IgGridGroupByColumnSettings { - /** * Enables/disables grouping a column from the UI. By default all columns can be grouped. * @@ -38950,7 +38755,6 @@ interface GroupedColumnsChangingEvent { } interface GroupedColumnsChangingEventUIParam { - /** * Used to access the GroupBy widget object */ @@ -38992,7 +38796,6 @@ interface GroupedColumnsChangedEvent { } interface GroupedColumnsChangedEventUIParam { - /** * Used to access the GroupBy widget object */ @@ -39029,7 +38832,6 @@ interface ModalDialogMovingEvent { } interface ModalDialogMovingEventUIParam { - /** * Used to get the reference to the igGridGroupBy widget. */ @@ -39056,7 +38858,6 @@ interface ModalDialogClosingEvent { } interface ModalDialogClosingEventUIParam { - /** * Used to get the reference to the igGridGroupBy widget. */ @@ -39073,7 +38874,6 @@ interface ModalDialogClosedEvent { } interface ModalDialogClosedEventUIParam { - /** * Used to get the reference to the igGridGroupBy widget. */ @@ -39090,7 +38890,6 @@ interface ModalDialogOpeningEvent { } interface ModalDialogOpeningEventUIParam { - /** * Used to get the reference to the igGridGroupBy widget. */ @@ -39107,7 +38906,6 @@ interface ModalDialogOpenedEvent { } interface ModalDialogOpenedEventUIParam { - /** * Used to get the reference to the igGridGroupBy widget. */ @@ -39124,7 +38922,6 @@ interface ModalDialogContentsRenderingEvent { } interface ModalDialogContentsRenderingEventUIParam { - /** * Used to get the reference to the igGridGroupby widget. */ @@ -39141,7 +38938,6 @@ interface ModalDialogContentsRenderedEvent { } interface ModalDialogContentsRenderedEventUIParam { - /** * Used to get the reference to the igGridGroupBy widget. */ @@ -39158,7 +38954,6 @@ interface ModalDialogButtonApplyClickEvent { } interface ModalDialogButtonApplyClickEventUIParam { - /** * Used to get the reference to the igGridGroupby widget. */ @@ -39190,7 +38985,6 @@ interface ModalDialogButtonResetClickEvent { } interface ModalDialogButtonResetClickEventUIParam { - /** * Used to get the reference to the igGridGroupby widget. */ @@ -39207,7 +39001,6 @@ interface ModalDialogGroupingColumnEvent { } interface ModalDialogGroupingColumnEventUIParam { - /** * Used to get the reference to the igGridGroupby widget. */ @@ -39229,7 +39022,6 @@ interface ModalDialogGroupColumnEvent { } interface ModalDialogGroupColumnEventUIParam { - /** * Used to get the reference to the igGridGroupby widget. */ @@ -39256,7 +39048,6 @@ interface ModalDialogUngroupingColumnEvent { } interface ModalDialogUngroupingColumnEventUIParam { - /** * Used to get the reference to the igGridGroupby widget. */ @@ -39278,7 +39069,6 @@ interface ModalDialogUngroupColumnEvent { } interface ModalDialogUngroupColumnEventUIParam { - /** * Used to get the reference to the igGridGroupby widget. */ @@ -39305,7 +39095,6 @@ interface ModalDialogSortGroupedColumnEvent { } interface ModalDialogSortGroupedColumnEventUIParam { - /** * Used to get the reference to the igGridGroupby widget. */ @@ -39328,7 +39117,6 @@ interface ModalDialogSortGroupedColumnEventUIParam { } interface IgGridGroupBy { - /** * Sets the place in the grid where the GroupBy area will be * @@ -39787,7 +39575,6 @@ interface IgGridGroupBy { [optionName: string]: any; } interface IgGridGroupByMethods { - /** * Open groupby modal dialog */ @@ -39877,7 +39664,7 @@ interface IgGridGroupByMethods { destroy(): void; } interface JQuery { - data(propertyName: "igGridGroupBy"):IgGridGroupByMethods; + data(propertyName: "igGridGroupBy"): IgGridGroupByMethods; } interface JQuery { @@ -40876,7 +40663,6 @@ interface JQuery { igGridGroupBy(methodName: string, ...methodParams: any[]): any; } interface IgGridHidingColumnSetting { - /** * Column key. this is a required property in every column setting if columnIndex is not set. * @@ -40912,7 +40698,6 @@ interface ColumnHidingEvent { } interface ColumnHidingEventUIParam { - /** * Used to get the reference to the GridHiding widget. */ @@ -40934,7 +40719,6 @@ interface ColumnHidingRefusedEvent { } interface ColumnHidingRefusedEventUIParam { - /** * Used to get the reference to the GridHiding widget. */ @@ -40947,7 +40731,6 @@ interface ColumnShowingRefusedEvent { } interface ColumnShowingRefusedEventUIParam { - /** * Used to get the reference to the GridHiding widget. */ @@ -40960,7 +40743,6 @@ interface MultiColumnHidingEvent { } interface MultiColumnHidingEventUIParam { - /** * Used to get the reference to the GridHiding widget. */ @@ -40977,7 +40759,6 @@ interface ColumnHiddenEvent { } interface ColumnHiddenEventUIParam { - /** * Used to get the reference to the GridHiding widget. */ @@ -40999,7 +40780,6 @@ interface ColumnShowingEvent { } interface ColumnShowingEventUIParam { - /** * Used to get the reference to the GridHiding widget. */ @@ -41021,7 +40801,6 @@ interface ColumnShownEvent { } interface ColumnShownEventUIParam { - /** * Used to get the reference to the GridHiding widget. */ @@ -41043,7 +40822,6 @@ interface ColumnChooserOpeningEvent { } interface ColumnChooserOpeningEventUIParam { - /** * Used to get the reference to the GridHiding widget. */ @@ -41060,7 +40838,6 @@ interface ColumnChooserOpenedEvent { } interface ColumnChooserOpenedEventUIParam { - /** * Used to get the reference to the GridHiding widget. */ @@ -41077,7 +40854,6 @@ interface ColumnChooserMovingEvent { } interface ColumnChooserMovingEventUIParam { - /** * Used to get the reference to the GridHiding widget. */ @@ -41104,7 +40880,6 @@ interface ColumnChooserClosingEvent { } interface ColumnChooserClosingEventUIParam { - /** * Used to get the reference to the GridHiding widget. */ @@ -41121,7 +40896,6 @@ interface ColumnChooserClosedEvent { } interface ColumnChooserClosedEventUIParam { - /** * Used to get the reference to the GridHiding widget. */ @@ -41138,7 +40912,6 @@ interface ColumnChooserContentsRenderingEvent { } interface ColumnChooserContentsRenderingEventUIParam { - /** * Used to get the reference to the GridHiding widget. */ @@ -41155,7 +40928,6 @@ interface ColumnChooserContentsRenderedEvent { } interface ColumnChooserContentsRenderedEventUIParam { - /** * Used to get the reference to the GridHiding widget. */ @@ -41172,7 +40944,6 @@ interface ColumnChooserButtonApplyClickEvent { } interface ColumnChooserButtonApplyClickEventUIParam { - /** * Used to get the reference to the GridHiding widget. */ @@ -41199,7 +40970,6 @@ interface ColumnChooserButtonResetClickEvent { } interface ColumnChooserButtonResetClickEventUIParam { - /** * Used to get the reference to the GridHiding widget. */ @@ -41212,7 +40982,6 @@ interface ColumnChooserButtonResetClickEventUIParam { } interface IgGridHiding { - /** * A list of column settings that specifies hiding options on a per column basis. * @@ -41227,7 +40996,7 @@ interface IgGridHiding { /** * Controls containment behavior. - * + * * owner The column chooser dialog will be draggable only in the grid area * window The column chooser dialog will be draggable in the whole window area */ @@ -41487,7 +41256,6 @@ interface IgGridHiding { [optionName: string]: any; } interface IgGridHidingMethods { - /** * Destroys the hiding widget */ @@ -41562,7 +41330,7 @@ interface IgGridHidingMethods { removeColumnChooserResetButton(): void; } interface JQuery { - data(propertyName: "igGridHiding"):IgGridHidingMethods; + data(propertyName: "igGridHiding"): IgGridHidingMethods; } interface JQuery { @@ -41608,7 +41376,7 @@ interface JQuery { /** * Controls containment behavior. - * + * * owner The column chooser dialog will be draggable only in the grid area * window The column chooser dialog will be draggable in the whole window area */ @@ -41616,7 +41384,7 @@ interface JQuery { /** * Controls containment behavior. - * + * * owner The column chooser dialog will be draggable only in the grid area * window The column chooser dialog will be draggable in the whole window area * @@ -42190,7 +41958,6 @@ interface JQuery { igGridHiding(methodName: string, ...methodParams: any[]): any; } interface IgHierarchicalGridColumnLayout { - /** * Specifies the columnLayout key. This is the property that holds the data records for the current column layout. */ @@ -42217,7 +41984,6 @@ interface RowExpandingEvent { } interface RowExpandingEventUIParam { - /** * Used to access the hierarchical grid object */ @@ -42234,7 +42000,6 @@ interface RowExpandedEvent { } interface RowExpandedEventUIParam { - /** * Used to access the hierarchical grid object */ @@ -42251,7 +42016,6 @@ interface RowCollapsingEvent { } interface RowCollapsingEventUIParam { - /** * Used to access the hierarchical grid object */ @@ -42268,7 +42032,6 @@ interface RowCollapsedEvent { } interface RowCollapsedEventUIParam { - /** * Used to access the hierarchical grid object */ @@ -42285,7 +42048,6 @@ interface ChildrenPopulatingEvent { } interface ChildrenPopulatingEventUIParam { - /** * Used to access the hierarchical grid object */ @@ -42307,7 +42069,6 @@ interface ChildrenPopulatedEvent { } interface ChildrenPopulatedEventUIParam { - /** * Used to access the hierarchical grid object */ @@ -42329,7 +42090,6 @@ interface ChildGridRenderedEvent { } interface ChildGridRenderedEventUIParam { - /** * Used to access the hierarchical grid object */ @@ -42361,7 +42121,6 @@ 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 */ @@ -42507,7 +42266,6 @@ interface IgHierarchicalGrid { [optionName: string]: any; } interface IgHierarchicalGridMethods { - /** * Data binds the hierarchical grid. No child grids will be created or rendered by default, unless there is initialExpandDepth >= 0 set. */ @@ -42607,7 +42365,7 @@ interface IgHierarchicalGridMethods { destroy(): void; } interface JQuery { - data(propertyName: "igHierarchicalGrid"):IgHierarchicalGridMethods; + data(propertyName: "igHierarchicalGrid"): IgHierarchicalGridMethods; } interface JQuery { @@ -42963,7 +42721,6 @@ interface GroupCollapsingEvent { } interface GroupCollapsingEventUIParam { - /** * Used to get the reference to the GridMultiColumnHeaders widget. */ @@ -42985,7 +42742,6 @@ interface GroupCollapsedEvent { } interface GroupCollapsedEventUIParam { - /** * Used to get the reference to the GridMultiColumnHeaders widget. */ @@ -43007,7 +42763,6 @@ interface GroupExpandingEvent { } interface GroupExpandingEventUIParam { - /** * Used to get the reference to the GridMultiColumnHeaders widget. */ @@ -43029,7 +42784,6 @@ interface GroupExpandedEvent { } interface GroupExpandedEventUIParam { - /** * Used to get the reference to the GridMultiColumnHeaders widget. */ @@ -43047,7 +42801,6 @@ interface GroupExpandedEventUIParam { } interface IgGridMultiColumnHeaders { - /** * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. */ @@ -43099,7 +42852,6 @@ interface IgGridMultiColumnHeaders { [optionName: string]: any; } interface IgGridMultiColumnHeadersMethods { - /** * Expands a collapsed group. If the group is expanded, the method does nothing. * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. @@ -43138,7 +42890,7 @@ interface IgGridMultiColumnHeadersMethods { destroy(): void; } interface JQuery { - data(propertyName: "igGridMultiColumnHeaders"):IgGridMultiColumnHeadersMethods; + data(propertyName: "igGridMultiColumnHeaders"): IgGridMultiColumnHeadersMethods; } interface JQuery { @@ -43258,7 +43010,6 @@ interface PageIndexChangingEvent { } interface PageIndexChangingEventUIParam { - /** * Used to get reference to GridPaging. */ @@ -43280,7 +43031,6 @@ interface PageIndexChangedEvent { } interface PageIndexChangedEventUIParam { - /** * Used to get reference to GridPaging. */ @@ -43297,7 +43047,6 @@ interface PageSizeChangingEvent { } interface PageSizeChangingEventUIParam { - /** * Used to get reference to GridPaging. */ @@ -43319,7 +43068,6 @@ interface PageSizeChangedEvent { } interface PageSizeChangedEventUIParam { - /** * Used to get reference to GridPaging. */ @@ -43336,7 +43084,6 @@ interface PagerRenderingEvent { } interface PagerRenderingEventUIParam { - /** * Used to get reference to GridPaging. */ @@ -43353,7 +43100,6 @@ interface PagerRenderedEvent { } interface PagerRenderedEventUIParam { - /** * Used to get reference to GridPaging. */ @@ -43366,7 +43112,6 @@ interface PagerRenderedEventUIParam { } interface IgGridPaging { - /** * Number of records loaded and displayed per page. * @@ -43580,7 +43325,7 @@ interface IgGridPaging { persist?: boolean; /** - * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. + * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. * */ inherit?: boolean; @@ -43650,7 +43395,6 @@ interface IgGridPaging { [optionName: string]: any; } interface IgGridPagingMethods { - /** * Gets/Sets the current page index, delegates data binding and paging to [$.ig.DataSource](ig.datasource). * @@ -43671,7 +43415,7 @@ interface IgGridPagingMethods { destroy(): void; } interface JQuery { - data(propertyName: "igGridPaging"):IgGridPagingMethods; + data(propertyName: "igGridPaging"): IgGridPagingMethods; } interface JQuery { @@ -44156,13 +43900,13 @@ interface JQuery { igGridPaging(optionLiteral: 'option', optionName: "persist", optionValue: boolean): void; /** - * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. + * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. * */ igGridPaging(optionLiteral: 'option', optionName: "inherit"): boolean; /** - * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. + * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. * * * @optionValue New value to be set. @@ -44305,7 +44049,6 @@ interface JQuery { igGridPaging(methodName: string, ...methodParams: any[]): any; } interface IgGridResizingColumnSetting { - /** * Column key. this is a required property in every column setting if columnIndex is not set. * @@ -44347,7 +44090,6 @@ interface ColumnResizingEvent { } interface ColumnResizingEventUIParam { - /** * Used to get the reference to the GridResizing widget. */ @@ -44374,7 +44116,6 @@ interface ColumnResizingRefusedEvent { } interface ColumnResizingRefusedEventUIParam { - /** * Used to get the reference to the GridResizing widget. */ @@ -44401,7 +44142,6 @@ interface ColumnResizedEvent { } interface ColumnResizedEventUIParam { - /** * Used to get the reference to the GridResizing widget. */ @@ -44429,7 +44169,6 @@ interface ColumnResizedEventUIParam { } interface IgGridResizing { - /** * Resize the column to the size of the longest currently visible cell value. * @@ -44499,7 +44238,6 @@ interface IgGridResizing { [optionName: string]: any; } interface IgGridResizingMethods { - /** * Destroys the resizing widget */ @@ -44514,7 +44252,7 @@ interface IgGridResizingMethods { resize(column: Object, width?: Object): void; } interface JQuery { - data(propertyName: "igGridResizing"):IgGridResizingMethods; + data(propertyName: "igGridResizing"): IgGridResizingMethods; } interface JQuery { @@ -44669,7 +44407,6 @@ interface JQuery { igGridResizing(methodName: string, ...methodParams: any[]): any; } interface IgGridResponsiveColumnSetting { - /** * Column key. This is a required property in every column setting if columnIndex is not set. * @@ -44701,7 +44438,6 @@ interface IgGridResponsiveColumnSetting { } interface IgGridResponsiveAllowedColumnWidthPerType { - /** * Minimal width in pixels string columns can take before forcing vertical rendering * @@ -44743,7 +44479,6 @@ interface ResponsiveColumnHidingEvent { } interface ResponsiveColumnHidingEventUIParam { - /** * Used to get the reference to the igGridResponsive widget. */ @@ -44765,7 +44500,6 @@ interface ResponsiveColumnHiddenEvent { } interface ResponsiveColumnHiddenEventUIParam { - /** * Used to get the reference to the igGridResponsive widget. */ @@ -44787,7 +44521,6 @@ interface ResponsiveColumnShowingEvent { } interface ResponsiveColumnShowingEventUIParam { - /** * Used to get the reference to the igGridResponsive widget. */ @@ -44809,7 +44542,6 @@ interface ResponsiveColumnShownEvent { } interface ResponsiveColumnShownEventUIParam { - /** * Used to get the reference to the igGridResponsive widget. */ @@ -44831,7 +44563,6 @@ interface ResponsiveModeChangedEvent { } interface ResponsiveModeChangedEventUIParam { - /** * Used to get the reference to the igGridResponsive widget. */ @@ -44849,7 +44580,6 @@ interface ResponsiveModeChangedEventUIParam { } interface IgGridResponsive { - /** * A list of column settings that specifies how columns will react based on the environment the grid is run on. * @@ -44991,7 +44721,6 @@ interface IgGridResponsive { [optionName: string]: any; } interface IgGridResponsiveMethods { - /** * Destroys the responsive widget. */ @@ -45003,7 +44732,7 @@ interface IgGridResponsiveMethods { getCurrentResponsiveMode(): void; } interface JQuery { - data(propertyName: "igGridResponsive"):IgGridResponsiveMethods; + data(propertyName: "igGridResponsive"): IgGridResponsiveMethods; } interface ResponsiveModeSettings { @@ -45018,11 +44747,11 @@ interface ResponsiveModeSettings { [optionName: string]: any; } -declare module Infragistics { -export class ResponsiveMode { - constructor(settings: ResponsiveModeSettings); - isActive(): void; -} +declare namespace Infragistics { + class ResponsiveMode { + constructor(settings: ResponsiveModeSettings); + isActive(): void; + } } interface IgniteUIStatic { ResponsiveMode: typeof Infragistics.ResponsiveMode; @@ -45038,11 +44767,11 @@ interface InfragisticsModeSettings { [optionName: string]: any; } -declare module Infragistics { -export class InfragisticsMode { - constructor(settings: InfragisticsModeSettings); - isActive(): void; -} +declare namespace Infragistics { + class InfragisticsMode { + constructor(settings: InfragisticsModeSettings); + isActive(): void; + } } interface IgniteUIStatic { InfragisticsMode: typeof Infragistics.InfragisticsMode; @@ -45058,11 +44787,11 @@ interface BootstrapModeSettings { [optionName: string]: any; } -declare module Infragistics { -export class BootstrapMode { - constructor(settings: BootstrapModeSettings); - isActive(): void; -} +declare namespace Infragistics { + class BootstrapMode { + constructor(settings: BootstrapModeSettings); + isActive(): void; + } } interface IgniteUIStatic { BootstrapMode: typeof Infragistics.BootstrapMode; @@ -45360,7 +45089,6 @@ interface RowSelectorClickedEvent { } interface RowSelectorClickedEventUIParam { - /** * Used to get reference to the row the clicked row selector resides in. */ @@ -45402,7 +45130,6 @@ interface CheckBoxStateChangingEvent { } interface CheckBoxStateChangingEventUIParam { - /** * Used to get reference to the row the clicked row selector resides in. */ @@ -45454,7 +45181,6 @@ interface CheckBoxStateChangedEvent { } interface CheckBoxStateChangedEventUIParam { - /** * Used to get reference to the row the clicked row selector resides in. */ @@ -45497,7 +45223,6 @@ interface CheckBoxStateChangedEventUIParam { } interface IgGridRowSelectors { - /** * Determines whether the row selectors column should contain row numbering * @@ -45517,7 +45242,7 @@ interface IgGridRowSelectors { rowNumberingSeed?: number; /** - * + * * * Valid values: * "string" The row selector column width can be set in pixels (px) and percentage (%) @@ -45622,7 +45347,7 @@ interface IgGridRowSelectorsMethods { destroy(): void; } interface JQuery { - data(propertyName: "igGridRowSelectors"):IgGridRowSelectorsMethods; + data(propertyName: "igGridRowSelectors"): IgGridRowSelectorsMethods; } interface JQuery { @@ -45884,7 +45609,6 @@ interface RowSelectionChangingEvent { } interface RowSelectionChangingEventUIParam { - /** * Used to get reference to GridSelection. */ @@ -45916,7 +45640,6 @@ interface RowSelectionChangedEvent { } interface RowSelectionChangedEventUIParam { - /** * Used to get reference to GridSelection. */ @@ -45938,7 +45661,6 @@ interface CellSelectionChangingEvent { } interface CellSelectionChangingEventUIParam { - /** * Used to get reference to GridSelection. */ @@ -45980,7 +45702,6 @@ interface CellSelectionChangedEvent { } interface CellSelectionChangedEventUIParam { - /** * Used to get reference to GridSelection. */ @@ -46002,7 +45723,6 @@ interface ActiveCellChangingEvent { } interface ActiveCellChangingEventUIParam { - /** * Used to get reference to GridSelection. */ @@ -46019,7 +45739,6 @@ interface ActiveCellChangedEvent { } interface ActiveCellChangedEventUIParam { - /** * Used to get reference to GridSelection. */ @@ -46036,7 +45755,6 @@ interface ActiveRowChangingEvent { } interface ActiveRowChangingEventUIParam { - /** * Used to get reference to GridSelection. */ @@ -46053,7 +45771,6 @@ interface ActiveRowChangedEvent { } interface ActiveRowChangedEventUIParam { - /** * Used to get reference to GridSelection. */ @@ -46066,7 +45783,6 @@ interface ActiveRowChangedEventUIParam { } interface IgGridSelection { - /** * Enables / Disables multiple selection of cells and rows - depending on the mode * @@ -46259,7 +45975,6 @@ interface IgGridSelection { [optionName: string]: any; } interface IgGridSelectionMethods { - /** * Destroys the selection widget. */ @@ -46334,28 +46049,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. */ 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; @@ -46371,11 +46086,10 @@ interface IgGridSelectionMethods { activeRow(): Object; } interface JQuery { - data(propertyName: "igGridSelection"):IgGridSelectionMethods; + data(propertyName: "igGridSelection"): IgGridSelectionMethods; } interface SelectionCollectionSettingsSubscribers { - /** * Option for SelectionCollectionSettingsSubscribers */ @@ -46393,94 +46107,94 @@ interface SelectionCollectionSettings { [optionName: string]: any; } -declare module Infragistics { -export 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; -} +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; + } } interface IgniteUIStatic { SelectionCollection: typeof Infragistics.SelectionCollection; } -declare module Infragistics { -export 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; -} +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; + } } interface IgniteUIStatic { SelectedRowsCollection: typeof Infragistics.SelectedRowsCollection; } -declare module Infragistics { -export 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; -} +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; + } } interface IgniteUIStatic { SelectedCellsCollection: typeof Infragistics.SelectedCellsCollection; @@ -46914,7 +46628,6 @@ interface ButtonOKClickEvent { } interface ButtonOKClickEventUIParam { - /** * Used to get the reference to the igGridModalDialog widget. */ @@ -46931,7 +46644,6 @@ interface ButtonCancelClickEvent { } interface ButtonCancelClickEventUIParam { - /** * Used to get the reference to the igGridModalDialog widget. */ @@ -47061,11 +46773,10 @@ interface IgGridModalDialogMethods { destroy(): void; } interface JQuery { - data(propertyName: "igGridModalDialog"):IgGridModalDialogMethods; + data(propertyName: "igGridModalDialog"): IgGridModalDialogMethods; } interface IgEditorFilter { - /** * Option for igEditorFilter */ @@ -47080,266 +46791,264 @@ interface IgEditorFilterMethods { destroy(): void; } interface JQuery { - data(propertyName: "igEditorFilter"):IgEditorFilterMethods; + data(propertyName: "igEditorFilter"): IgEditorFilterMethods; } -declare module Infragistics { -export 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 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 module Infragistics { -export 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 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 module Infragistics { -export 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 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 module Infragistics { -export 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 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 module Infragistics { -export 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 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 module Infragistics { -export 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 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 module Infragistics { -export 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 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 module Infragistics { -export 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 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 module Infragistics { -export 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 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 module Infragistics { -export 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 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 module Infragistics { -export 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 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 module Infragistics { -export 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 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 module Infragistics { -export 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 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 module Infragistics { -export class SortingExpressionsManager { - setGridInstance(grid: 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; -} + /** + * 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 { @@ -47647,7 +47356,6 @@ interface 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. * @@ -47715,7 +47423,6 @@ interface ColumnSortingEvent { } interface ColumnSortingEventUIParam { - /** * Used to get reference to GridSorting. */ @@ -47742,7 +47449,6 @@ interface ColumnSortedEvent { } interface ColumnSortedEventUIParam { - /** * Used to get reference to GridSorting. */ @@ -47769,7 +47475,6 @@ interface ModalDialogSortingChangedEvent { } interface ModalDialogSortingChangedEventUIParam { - /** * Used to get the reference to the GridSorting widget. */ @@ -47796,7 +47501,6 @@ interface ModalDialogButtonUnsortClickEvent { } interface ModalDialogButtonUnsortClickEventUIParam { - /** * Used to get the reference to the GridSorting widget. */ @@ -47818,7 +47522,6 @@ interface ModalDialogSortClickEvent { } interface ModalDialogSortClickEventUIParam { - /** * Used to get the reference to the GridSorting widget. */ @@ -47836,7 +47539,6 @@ interface ModalDialogSortClickEventUIParam { } interface IgGridSorting { - /** * Defines local or remote sorting operations. * @@ -48026,7 +47728,7 @@ interface IgGridSorting { /** * Controls containment behavior of multiple sorting dialog. - * + * * owner The multi sorting dialog will be draggable only in the grid area * window The multi sorting dialog will be draggable in the whole window area */ @@ -48188,13 +47890,12 @@ interface IgGridSorting { [optionName: string]: any; } interface IgGridSortingMethods { - /** * Sorts the data in a grid column and updates the UI. * * @param index Column key (string) or index (number) - for multi-row grid only column key can be used. Specifies the column which we want to sort. If the mode is multiple, previous sorting states are not cleared. * @param direction Specifies sorting direction (ascending or descending) - * @param header + * @param header */ sortColumn(index: Object, direction: Object, header: Object): void; @@ -48234,7 +47935,7 @@ interface IgGridSortingMethods { /** * Renders content of multiple sorting dialog - sorted and unsorted columns. * - * @param isToCallEvents + * @param isToCallEvents */ renderMultipleSortingDialogContent(isToCallEvents: Object): void; @@ -48244,7 +47945,7 @@ interface IgGridSortingMethods { removeDialogClearButton(): void; } interface JQuery { - data(propertyName: "igGridSorting"):IgGridSortingMethods; + data(propertyName: "igGridSorting"): IgGridSortingMethods; } interface JQuery { @@ -48650,7 +48351,7 @@ interface JQuery { /** * Controls containment behavior of multiple sorting dialog. - * + * * owner The multi sorting dialog will be draggable only in the grid area * window The multi sorting dialog will be draggable in the whole window area */ @@ -48658,7 +48359,7 @@ interface JQuery { /** * Controls containment behavior of multiple sorting dialog. - * + * * owner The multi sorting dialog will be draggable only in the grid area * window The multi sorting dialog will be draggable in the whole window area * @@ -49004,7 +48705,6 @@ interface JQuery { igGridSorting(methodName: string, ...methodParams: any[]): any; } interface IgGridSummariesColumnSettingSummaryOperand { - /** * Text of the summary method which is shown in summary cell * @@ -49062,7 +48762,6 @@ interface IgGridSummariesColumnSettingSummaryOperand { } interface IgGridSummariesColumnSetting { - /** * Enables disables summaries for the column * @@ -49098,7 +48797,6 @@ interface SummariesCalculatingEvent { } interface SummariesCalculatingEventUIParam { - /** * Used to access the igGridSummaries widget object. */ @@ -49110,7 +48808,6 @@ interface SummariesCalculatedEvent { } interface SummariesCalculatedEventUIParam { - /** * Used to get data for calculated summaries */ @@ -49127,7 +48824,6 @@ interface SummariesMethodSelectionChangedEvent { } interface SummariesMethodSelectionChangedEventUIParam { - /** * Used to get column key of the column where it is changed selection of summary method */ @@ -49154,7 +48850,6 @@ interface SummariesTogglingEvent { } interface SummariesTogglingEventUIParam { - /** * Used to get whether summaries are shown or not. */ @@ -49171,7 +48866,6 @@ interface SummariesToggledEvent { } interface SummariesToggledEventUIParam { - /** * Used to get whether summaries are shown or not. */ @@ -49188,7 +48882,6 @@ interface DropDownOKClickedEvent { } interface DropDownOKClickedEventUIParam { - /** * Used to get column key for which OK button is clicked. */ @@ -49210,7 +48903,6 @@ interface DropDownCancelClickedEvent { } interface DropDownCancelClickedEventUIParam { - /** * Used to get column key for which Cancel button is clicked. */ @@ -49223,7 +48915,6 @@ interface DropDownCancelClickedEventUIParam { } interface IgGridSummaries { - /** * type of summaries calculating. * @@ -49545,7 +49236,7 @@ interface IgGridSummariesMethods { * @param columnMethods Array of column methods objects * @param data Object which represents result represents dataType for the current column - * @param dataType + * @param dataType */ calculateSummaryColumn(ck: string, columnMethods: any[], data: Object, dataType: Object): void; @@ -49557,12 +49248,12 @@ interface IgGridSummariesMethods { /** * Return a JQUERY object which holds all summaries for column with the specified column key * - * @param columnKey + * @param columnKey */ summariesFor(columnKey: Object): void; } interface JQuery { - data(propertyName: "igGridSummaries"):IgGridSummariesMethods; + data(propertyName: "igGridSummaries"): IgGridSummariesMethods; } interface JQuery { @@ -50135,7 +49826,6 @@ interface JQuery { igGridSummaries(methodName: string, ...methodParams: any[]): any; } interface IgGridTooltipsColumnSettings { - /** * Either key or index must be set in every column setting. * @@ -50167,7 +49857,6 @@ interface IgGridTooltipsColumnSettings { } interface IgGridTooltips { - /** * determines the tooltip visibility option * @@ -50286,7 +49975,6 @@ interface IgGridTooltips { [optionName: string]: any; } interface IgGridTooltipsMethods { - /** * Destroys the tooltip widget. */ @@ -50298,7 +49986,7 @@ interface IgGridTooltipsMethods { id(): string; } interface JQuery { - data(propertyName: "igGridTooltips"):IgGridTooltipsMethods; + data(propertyName: "igGridTooltips"): IgGridTooltipsMethods; } interface JQuery { @@ -50543,7 +50231,6 @@ interface JQuery { igGridTooltips(methodName: string, ...methodParams: any[]): any; } interface IgGridUpdatingColumnSetting { - /** * Identifies the grid column by key. * @@ -50627,7 +50314,6 @@ interface IgGridUpdatingColumnSetting { } interface IgGridUpdatingRowEditDialogOptions { - /** * Specifies the caption of the dialog. If not set, $.ig.GridUpdating.locale.rowEditDialogCaptionLabel is used. * @@ -50713,14 +50399,14 @@ interface IgGridUpdatingRowEditDialogOptions { /** * Specifies a template to be rendered against the currently edited record (or up-to-date key-value pairs in the case of not yet created records). It may contain an element decorated with the 'data-render-tmpl' attribute to specify where the control should render the editors template specified in the [editorsTemplate](ui.iggridupdating#options:rowEditDialogOptions.editorsTemplate) option. For custom dialogs, the elements can be decorated with 'data-editor-for-' attributes where columnKey is the key of the column that editor or input will be used to edit. If both dialogTemplate and [dialogTemplateSelector](ui.iggridupdating#options:rowEditDialogOptions.dialogTemplateSelector) are specified, dialogTemplateSelector will be used.The default template is '
'. - * + * * */ dialogTemplate?: string; /** * Specifies a selector to a template rendered against the currently edited record (or up-to-date key-value pairs in the case of not yet created records). It may contain an element decorated with the 'data-render-tmpl' attribute to specify where the control should render the editors template specified in the [editorsTemplate](ui.iggridupdating#options:rowEditDialogOptions.editorsTemplate) option. For custom dialogs, the elements can be decorated with 'data-editor-for-' attributes where columnKey is the key of the column that editor or input will be used to edit. If both [dialogTemplate](ui.iggridupdating#options:rowEditDialogOptions.dialogTemplate) and dialogTemplateSelector are specified, dialogTemplateSelector will be used.The default template is '
'. - * + * * */ dialogTemplateSelector?: string; @@ -50750,7 +50436,6 @@ interface EditRowStartingEvent { } interface EditRowStartingEventUIParam { - /** * Used to get a reference to GridUpdating. */ @@ -50772,7 +50457,6 @@ interface EditRowStartedEvent { } interface EditRowStartedEventUIParam { - /** * Used to get a reference to GridUpdating. */ @@ -50794,7 +50478,6 @@ interface EditRowEndingEvent { } interface EditRowEndingEventUIParam { - /** * Used to get a reference to GridUpdating. */ @@ -50831,7 +50514,6 @@ interface EditRowEndedEvent { } interface EditRowEndedEventUIParam { - /** * Used to get a reference to GridUpdating. */ @@ -50868,7 +50550,6 @@ interface EditCellStartingEvent { } interface EditCellStartingEventUIParam { - /** * Used to get a reference to GridUpdating. */ @@ -50910,7 +50591,6 @@ interface EditCellStartedEvent { } interface EditCellStartedEventUIParam { - /** * Used to get a reference to GridUpdating. */ @@ -50952,7 +50632,6 @@ interface EditCellEndingEvent { } interface EditCellEndingEventUIParam { - /** * Used to get a reference to GridUpdating. */ @@ -51004,7 +50683,6 @@ interface EditCellEndedEvent { } interface EditCellEndedEventUIParam { - /** * Used to get a reference to GridUpdating. */ @@ -51056,7 +50734,6 @@ interface RowAddingEvent { } interface RowAddingEventUIParam { - /** * Used to get a reference to GridUpdating. */ @@ -51078,7 +50755,6 @@ interface RowAddedEvent { } interface RowAddedEventUIParam { - /** * Used to get a reference to GridUpdating. */ @@ -51100,7 +50776,6 @@ interface RowDeletingEvent { } interface RowDeletingEventUIParam { - /** * Used to get a reference to GridUpdating. */ @@ -51122,7 +50797,6 @@ interface RowDeletedEvent { } interface RowDeletedEventUIParam { - /** * Used to get a reference to GridUpdating. */ @@ -51144,7 +50818,6 @@ interface DataDirtyEvent { } interface DataDirtyEventUIParam { - /** * Used to get a reference to GridUpdating. */ @@ -51156,7 +50829,6 @@ interface GeneratePrimaryKeyValueEvent { } interface GeneratePrimaryKeyValueEventUIParam { - /** * Used to get a reference to GridUpdating. */ @@ -51173,7 +50845,6 @@ interface RowEditDialogBeforeOpenEvent { } interface RowEditDialogBeforeOpenEventUIParam { - /** * Used to get a reference to GridUpdating. */ @@ -51190,7 +50861,6 @@ interface RowEditDialogAfterOpenEvent { } interface RowEditDialogAfterOpenEventUIParam { - /** * Used to get a reference to GridUpdating. */ @@ -51207,7 +50877,6 @@ interface RowEditDialogBeforeCloseEvent { } interface RowEditDialogBeforeCloseEventUIParam { - /** * Used to get a reference to GridUpdating. */ @@ -51224,7 +50893,6 @@ interface RowEditDialogAfterCloseEvent { } interface RowEditDialogAfterCloseEventUIParam { - /** * Used to get a reference to GridUpdating. */ @@ -51241,7 +50909,6 @@ interface RowEditDialogContentsRenderedEvent { } interface RowEditDialogContentsRenderedEventUIParam { - /** * Used to get a reference to GridUpdating. */ @@ -51254,7 +50921,6 @@ interface RowEditDialogContentsRenderedEventUIParam { } interface IgGridUpdating { - /** * A list of custom column options that specify editing and validation settings for a specific column. * @@ -51631,7 +51297,6 @@ interface IgGridUpdating { [optionName: string]: any; } interface IgGridUpdatingMethods { - /** * Sets a cell value for the specified cell. It also creates a transaction and updates the UI. * If the specified cell is currently in edit mode, the function will set the desired value in the cell's editor instead. @@ -51732,7 +51397,7 @@ interface IgGridUpdatingMethods { hideDeleteButton(): void; } interface JQuery { - data(propertyName: "igGridUpdating"):IgGridUpdatingMethods; + data(propertyName: "igGridUpdating"): IgGridUpdatingMethods; } interface JQuery { @@ -52657,7 +52322,6 @@ interface WorkspaceResizedEventUIParam { } interface IgHtmlEditor { - /** * Shows/hides the "Formatting" toolbar. * @@ -52794,7 +52458,6 @@ interface IgHtmlEditor { [optionName: string]: any; } interface IgHtmlEditorMethods { - /** * Returns the element on which the widget was instantiated */ @@ -52871,7 +52534,7 @@ interface IgHtmlEditorMethods { insertAtCaret(element: Object): void; } interface JQuery { - data(propertyName: "igHtmlEditor"):IgHtmlEditorMethods; + data(propertyName: "igHtmlEditor"): IgHtmlEditorMethods; } interface IgPathFinder { @@ -52930,7 +52593,7 @@ interface IgHtmlEditorPopoverMethods { hide(): void; } interface JQuery { - data(propertyName: "igHtmlEditorPopover"):IgHtmlEditorPopoverMethods; + data(propertyName: "igHtmlEditorPopover"): IgHtmlEditorPopoverMethods; } interface IgLinkPropertiesDialog { @@ -52952,7 +52615,7 @@ interface IgLinkPropertiesDialogMethods { hide(): void; } interface JQuery { - data(propertyName: "igLinkPropertiesDialog"):IgLinkPropertiesDialogMethods; + data(propertyName: "igLinkPropertiesDialog"): IgLinkPropertiesDialogMethods; } interface IgTablePropertiesDialog { @@ -52974,7 +52637,7 @@ interface IgTablePropertiesDialogMethods { hide(): void; } interface JQuery { - data(propertyName: "igTablePropertiesDialog"):IgTablePropertiesDialogMethods; + data(propertyName: "igTablePropertiesDialog"): IgTablePropertiesDialogMethods; } interface IgImagePropertiesDialog { @@ -52996,30 +52659,30 @@ interface IgImagePropertiesDialogMethods { hide(): void; } interface JQuery { - data(propertyName: "igImagePropertiesDialog"):IgImagePropertiesDialogMethods; + data(propertyName: "igImagePropertiesDialog"): IgImagePropertiesDialogMethods; } -declare module Infragistics { -export 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; -} +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; + } } interface IgniteUIStatic { -SelectionWrapper: typeof Infragistics.SelectionWrapper; + SelectionWrapper: typeof Infragistics.SelectionWrapper; } -declare module Infragistics { -export class ToolbarHelper { - analyse(el: Object): void; -} +declare namespace Infragistics { + class ToolbarHelper { + analyse(el: Object): void; + } } interface JQuery { @@ -53351,7 +53014,6 @@ interface JQuery { igHtmlEditor(methodName: string, ...methodParams: any[]): any; } interface JQuery { - /** */ igPathFinder(optionLiteral: 'option', optionName: "items"): any; @@ -53626,7 +53288,6 @@ interface JQuery { igImagePropertiesDialog(methodName: string, ...methodParams: any[]): any; } interface IgLayoutManagerBorderLayout { - /** * Option specifying the width of the left region, either in px or percentages * @@ -53670,7 +53331,6 @@ interface IgLayoutManagerBorderLayout { } interface IgLayoutManagerGridLayout { - /** * Specifies the duration of the animations in the layout manager"s grid layout * @@ -53733,7 +53393,6 @@ interface IgLayoutManagerGridLayout { } interface IgLayoutManagerItem { - /** * Column index of the item in the grid * @@ -53783,7 +53442,6 @@ interface InternalResizedEvent { } interface InternalResizedEventUIParam { - /** * Used to get a reference to the layout manager performing resizing. */ @@ -53795,7 +53453,6 @@ interface InternalResizingEvent { } interface InternalResizingEventUIParam { - /** * Used to get a reference to the layout manager performing resizing. */ @@ -53807,7 +53464,6 @@ interface ItemRenderedEvent { } interface ItemRenderedEventUIParam { - /** * Used to get reference to the igLayoutManager. */ @@ -53834,7 +53490,6 @@ interface ItemRenderingEvent { } interface ItemRenderingEventUIParam { - /** * Used to get reference to the igLayoutManager. */ @@ -53857,7 +53512,6 @@ interface ItemRenderingEventUIParam { } interface IgLayoutManager { - /** * Options specific to a border layout * @@ -53963,7 +53617,6 @@ interface IgLayoutManager { [optionName: string]: any; } 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. @@ -53983,7 +53636,7 @@ interface IgLayoutManagerMethods { destroy(): void; } interface JQuery { - data(propertyName: "igLayoutManager"):IgLayoutManagerMethods; + data(propertyName: "igLayoutManager"): IgLayoutManagerMethods; } interface JQuery { @@ -54204,7 +53857,6 @@ interface JQuery { igLayoutManager(methodName: string, ...methodParams: any[]): any; } interface IgLinearGaugeRange { - /** * Gets or sets the name of the range. */ @@ -54266,7 +53918,6 @@ interface IgLinearGaugeRange { } interface IgLinearGauge { - /** * The width of the gauge. It can be set as a number in pixels, string (px) or percentage (%). */ @@ -54296,7 +53947,7 @@ interface IgLinearGauge { * Gets or sets the orientation of the scale. * * Valid values: - * "horizontal" + * "horizontal" * "vertical" */ orientation?: string; @@ -54332,10 +53983,10 @@ interface IgLinearGauge { * Gets or sets the shape to use when rendering the needle from a number of options. * * Valid values: - * "custom" - * "rectangle" - * "triangle" - * "needle" + * "custom" + * "rectangle" + * "triangle" + * "needle" * "trapezoid" */ needleShape?: string; @@ -54622,7 +54273,6 @@ interface IgLinearGauge { [optionName: string]: any; } interface IgLinearGaugeMethods { - /** * Returns a string containing the names of all the ranges delimited with a \n symbol. */ @@ -54652,8 +54302,8 @@ interface IgLinearGaugeMethods { /** * Gets the value for the main scale of the gauge for a given point within the bounds of the gauge. * - * @param x - * @param y + * @param x + * @param y */ getValueForPoint(x: Object, y: Object): number; @@ -54686,7 +54336,7 @@ interface IgLinearGaugeMethods { styleUpdated(): void; } interface JQuery { - data(propertyName: "igLinearGauge"):IgLinearGaugeMethods; + data(propertyName: "igLinearGauge"): IgLinearGaugeMethods; } interface JQuery { @@ -55523,7 +55173,6 @@ interface JQuery { igLinearGauge(methodName: string, ...methodParams: any[]): any; } interface IgMapCrosshairPoint { - /** * The x coordinate. */ @@ -55541,7 +55190,6 @@ interface IgMapCrosshairPoint { } interface IgMapBackgroundContent { - /** * Type of the background content for the map. * @@ -55584,7 +55232,6 @@ interface IgMapBackgroundContent { } interface IgMapSeries { - /** * Type of the series. * @@ -56079,7 +55726,6 @@ interface TriangulationStatusChangedEvent { } interface TriangulationStatusChangedEventUIParam { - /** * Used to get reference to map object. */ @@ -56097,7 +55743,6 @@ interface TriangulationStatusChangedEventUIParam { } interface IgMap { - /** * The width of the map. It can be set as a number in pixels, string (px) or percentage (%). */ @@ -56700,14 +56345,14 @@ interface IgMapMethods { /** * Gets the actual minimum value of the target xAxis or yAxis * - * @param targetName + * @param targetName */ getActualMinimumValue(targetName: Object): void; /** * Gets the actual maximum value of the target xAxis or yAxis * - * @param targetName + * @param targetName */ getActualMaximumValue(targetName: Object): void; @@ -56751,11 +56396,10 @@ interface IgMapMethods { renderSeries(targetName: string, animate: boolean): void; } interface JQuery { - data(propertyName: "igMap"):IgMapMethods; + data(propertyName: "igMap"): IgMapMethods; } interface ShapeDataSourceSettings { - /** * The unique identifier. */ @@ -56811,32 +56455,31 @@ interface ShapeDataSourceSettings { [optionName: string]: any; } -declare module Infragistics { -export class ShapeDataSource { - constructor(settings: ShapeDataSourceSettings); +declare namespace Infragistics { + 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 { - /** * The unique identifier. */ @@ -56868,28 +56511,28 @@ interface TriangulationDataSourceSettings { [optionName: string]: any; } -declare module Infragistics { -export class TriangulationDataSource { - constructor(settings: TriangulationDataSourceSettings); +declare namespace Infragistics { + 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 { @@ -57880,7 +57523,6 @@ interface IgNotifierMessages { } interface IgNotifierHeaderTemplate { - /** * Controls whether the popover renders a functional close button * @@ -57900,7 +57542,6 @@ interface IgNotifierHeaderTemplate { } interface IgNotifier { - /** * Gets/Sets the current state of the igNotifier messages. State controls what CSS classes are applied to the messages and target and has interactions with other options as well. * @@ -57937,7 +57578,7 @@ interface IgNotifier { /** * Controls the positioning mode of messages. Setting a mode will override the default behavior which is auto.Note: Inline element uses a block container as is always placed after the target. - * + * * * * Valid values: @@ -58115,7 +57756,6 @@ interface IgNotifier { [optionName: string]: any; } interface IgNotifierMethods { - /** * Triggers a notification with a certain state and optional message. The [notifyLevel](ui.ignotifier#options:notifyLevel) option determines if the notification will be displayed. * @@ -58187,7 +57827,7 @@ interface IgNotifierMethods { setCoordinates(pos: Object): void; } interface JQuery { - data(propertyName: "igNotifier"):IgNotifierMethods; + data(propertyName: "igNotifier"): IgNotifierMethods; } interface JQuery { @@ -58248,14 +57888,14 @@ interface JQuery { /** * Controls the positioning mode of messages. Setting a mode will override the default behavior which is auto.Note: Inline element uses a block container as is always placed after the target. - * + * * */ igNotifier(optionLiteral: 'option', optionName: "mode"): string; /** * Controls the positioning mode of messages. Setting a mode will override the default behavior which is auto.Note: Inline element uses a block container as is always placed after the target. - * + * * * * @optionValue New value to be set. @@ -58590,7 +58230,6 @@ interface JQuery { igNotifier(methodName: string, ...methodParams: any[]): any; } interface IgPivotDataSelectorDataSourceOptionsXmlaOptionsRequestOptions { - /** * The value is applied to XmlHttpRequest.withCredentials if supported by the user agent. * Setting this property to true will allow IE8/IE9 to make authenticated cross-origin requests to tusted domains through XmlHttpRequest instead of XDomainRequest @@ -58610,7 +58249,6 @@ interface IgPivotDataSelectorDataSourceOptionsXmlaOptionsRequestOptions { } interface IgPivotDataSelectorDataSourceOptionsXmlaOptionsMdxSettings { - /** * Optional="true" a value indicating whether a NON EMPTY clause is present on ROWS axis. Default value is true */ @@ -58648,7 +58286,6 @@ interface IgPivotDataSelectorDataSourceOptionsXmlaOptionsMdxSettings { } interface IgPivotDataSelectorDataSourceOptionsXmlaOptions { - /** * Optional="false" The URL of the XMLA server. */ @@ -58703,7 +58340,6 @@ interface IgPivotDataSelectorDataSourceOptionsXmlaOptions { } interface IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimensionMeasure { - /** * Optional="false" A unique name for the measure. */ @@ -58732,7 +58368,6 @@ interface IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeMeasure } interface IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimension { - /** * A unique name for the measures dimension. * The default value is "Measures". This name is used to create the names of dimensions using the following pattern: @@ -58758,7 +58393,6 @@ interface IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeMeasure } interface IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierarchieLevel { - /** * Optional="false" A name for the level. * The unique name of the level is formed using the following pattern: @@ -58784,7 +58418,6 @@ interface IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeDimensi } interface IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierarchie { - /** * Optional="false" A name for the hierarchy. * The unique name of the hierarchy is formed using the following pattern: @@ -58798,8 +58431,8 @@ interface IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeDimensi caption?: string; /** - * The path to be used when displaying the hierarchy in the user interface. - * Nested folders are indicated by a backslash (\). + * The path to be used when displaying the hierarchy in the user interface. + * Nested folders are indicated by a backslash (\). * The folder hierarchy will appear under parent dimension node. */ displayFolder?: string; @@ -58816,7 +58449,6 @@ interface IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeDimensi } interface IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeDimension { - /** * Optional="false" A unique name for the dimension. */ @@ -58839,7 +58471,6 @@ interface IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeDimensi } interface IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCube { - /** * Optional="false" A unique name for the cube. */ @@ -58867,7 +58498,6 @@ interface IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCube { } interface IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadata { - /** * Optional="false" Metadata used for the creation of the cube. */ @@ -58880,7 +58510,6 @@ interface IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadata { } interface IgPivotDataSelectorDataSourceOptionsFlatDataOptions { - /** * Specifies any valid data source accepted by $.ig.DataSource, or an instance of an $.ig.DataSource itself. */ @@ -58897,8 +58526,8 @@ interface IgPivotDataSelectorDataSourceOptionsFlatDataOptions { dataSourceType?: string; /** - * See $.ig.DataSource. - * string Specifies the name of the property in which data records are held if the response is wrapped. + * See $.ig.DataSource. + * string Specifies the name of the property in which data records are held if the response is wrapped. * null Option is ignored. */ responseDataKey?: string; @@ -58921,7 +58550,6 @@ interface IgPivotDataSelectorDataSourceOptionsFlatDataOptions { } interface IgPivotDataSelectorDataSourceOptions { - /** * Settings for creating an instance of $.ig.OlapXmlaDataSource. */ @@ -58959,7 +58587,6 @@ interface IgPivotDataSelectorDataSourceOptions { } interface IgPivotDataSelectorDragAndDropSettings { - /** * Which element the draggable helper should be appended to while dragging. */ @@ -58987,7 +58614,6 @@ interface DataSelectorRenderedEvent { } interface DataSelectorRenderedEventUIParam { - /** * Used to get a reference to the data selector. */ @@ -58999,7 +58625,6 @@ interface DataSourceInitializedEvent { } interface DataSourceInitializedEventUIParam { - /** * Used to get a reference to the data selector. */ @@ -59026,7 +58651,6 @@ interface DataSourceUpdatedEvent { } interface DataSourceUpdatedEventUIParam { - /** * Used to get a reference to the data selector. */ @@ -59053,7 +58677,6 @@ interface DeferUpdateChangedEvent { } interface DeferUpdateChangedEventUIParam { - /** * Used to get a reference to the data selector. */ @@ -59070,7 +58693,6 @@ interface DragStartEvent { } interface DragStartEventUIParam { - /** * Used to get a reference to the data. */ @@ -59102,7 +58724,6 @@ interface DragEvent { } interface DragEventUIParam { - /** * Used to get a reference to the data. */ @@ -59134,7 +58755,6 @@ interface DragStopEvent { } interface DragStopEventUIParam { - /** * Used to get a reference to the helper. */ @@ -59161,7 +58781,6 @@ interface MetadataDroppingEvent { } interface MetadataDroppingEventUIParam { - /** * Used to the drop target. */ @@ -59203,7 +58822,6 @@ interface MetadataDroppedEvent { } interface MetadataDroppedEventUIParam { - /** * Used to the drop target. */ @@ -59245,7 +58863,6 @@ interface MetadataRemovingEvent { } interface MetadataRemovingEventUIParam { - /** * Used to the dragged element. */ @@ -59262,7 +58879,6 @@ interface MetadataRemovedEvent { } interface MetadataRemovedEventUIParam { - /** * Used to get a reference to the data. */ @@ -59274,7 +58890,6 @@ interface FilterDropDownOpeningEvent { } interface FilterDropDownOpeningEventUIParam { - /** * Used to the hierarchy. */ @@ -59286,7 +58901,6 @@ interface FilterDropDownOpenedEvent { } interface FilterDropDownOpenedEventUIParam { - /** * Used to the hierarchy. */ @@ -59303,7 +58917,6 @@ interface FilterMembersLoadedEvent { } interface FilterMembersLoadedEventUIParam { - /** * Used to get the parent node or the igTree instance in the initial load. */ @@ -59317,7 +58930,6 @@ interface FilterDropDownOkEvent { } interface FilterDropDownOkEventUIParam { - /** * Used to the hierarchy. */ @@ -59335,7 +58947,6 @@ interface FilterDropDownClosingEvent { } interface FilterDropDownClosingEventUIParam { - /** * Used to the hierarchy. */ @@ -59352,7 +58963,6 @@ interface FilterDropDownClosedEvent { } interface FilterDropDownClosedEventUIParam { - /** * Used to the hierarchy. */ @@ -59576,7 +59186,6 @@ interface IgPivotDataSelector { [optionName: string]: any; } interface IgPivotDataSelectorMethods { - /** * Updates the data source. */ @@ -59591,7 +59200,7 @@ interface IgPivotDataSelectorMethods { destroy(): void; } interface JQuery { - data(propertyName: "igPivotDataSelector"):IgPivotDataSelectorMethods; + data(propertyName: "igPivotDataSelector"): IgPivotDataSelectorMethods; } interface JQuery { @@ -60074,7 +59683,6 @@ interface JQuery { igPivotDataSelector(methodName: string, ...methodParams: any[]): any; } interface IgPivotGridDataSourceOptionsXmlaOptionsRequestOptions { - /** * The value is applied to XmlHttpRequest.withCredentials if supported by the user agent. * Setting this property to true will allow IE8/IE9 to make authenticated cross-origin requests to tusted domains through XmlHttpRequest instead of XDomainRequest @@ -60094,7 +59702,6 @@ interface IgPivotGridDataSourceOptionsXmlaOptionsRequestOptions { } interface IgPivotGridDataSourceOptionsXmlaOptionsMdxSettings { - /** * Optional="true" a value indicating whether a NON EMPTY clause is present on ROWS axis. Default value is true */ @@ -60132,7 +59739,6 @@ interface IgPivotGridDataSourceOptionsXmlaOptionsMdxSettings { } interface IgPivotGridDataSourceOptionsXmlaOptions { - /** * Optional="false" The URL of the XMLA server. */ @@ -60187,7 +59793,6 @@ interface IgPivotGridDataSourceOptionsXmlaOptions { } interface IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimensionMeasure { - /** * Optional="false" A unique name for the measure. */ @@ -60216,7 +59821,6 @@ interface IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimensi } interface IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimension { - /** * A unique name for the measures dimension. * The default value is "Measures". This name is used to create the names of dimensions using the following pattern: @@ -60242,7 +59846,6 @@ interface IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimensi } interface IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierarchieLevel { - /** * Optional="false" A name for the level. * The unique name of the level is formed using the following pattern: @@ -60268,7 +59871,6 @@ interface IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierar } interface IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierarchie { - /** * Optional="false" A name for the hierarchy. * The unique name of the hierarchy is formed using the following pattern: @@ -60282,8 +59884,8 @@ interface IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierar caption?: string; /** - * The path to be used when displaying the hierarchy in the user interface. - * Nested folders are indicated by a backslash (\). + * The path to be used when displaying the hierarchy in the user interface. + * Nested folders are indicated by a backslash (\). * The folder hierarchy will appear under parent dimension node. */ displayFolder?: string; @@ -60300,7 +59902,6 @@ interface IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierar } interface IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeDimension { - /** * Optional="false" A unique name for the dimension. */ @@ -60323,7 +59924,6 @@ interface IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeDimension { } interface IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCube { - /** * Optional="false" A unique name for the cube. */ @@ -60351,7 +59951,6 @@ interface IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCube { } interface IgPivotGridDataSourceOptionsFlatDataOptionsMetadata { - /** * Optional="false" Metadata used for the creation of the cube. */ @@ -60364,7 +59963,6 @@ interface IgPivotGridDataSourceOptionsFlatDataOptionsMetadata { } interface IgPivotGridDataSourceOptionsFlatDataOptions { - /** * Specifies any valid data source accepted by $.ig.DataSource, or an instance of an $.ig.DataSource itself. */ @@ -60381,8 +59979,8 @@ interface IgPivotGridDataSourceOptionsFlatDataOptions { dataSourceType?: string; /** - * See $.ig.DataSource. - * string Specifies the name of the property in which data records are held if the response is wrapped. + * See $.ig.DataSource. + * string Specifies the name of the property in which data records are held if the response is wrapped. * null Option is ignored. */ responseDataKey?: string; @@ -60405,7 +60003,6 @@ interface IgPivotGridDataSourceOptionsFlatDataOptions { } interface IgPivotGridDataSourceOptions { - /** * Settings for creating an instance of $.ig.OlapXmlaDataSource. */ @@ -60443,7 +60040,6 @@ interface IgPivotGridDataSourceOptions { } interface IgPivotGridLevelSortDirection { - /** * Specifies the unique name of the level, which will be sorted. */ @@ -60470,7 +60066,6 @@ interface IgPivotGridLevelSortDirection { } interface IgPivotGridGridOptionsFeatures { - /** * Option for IgPivotGridGridOptionsFeatures */ @@ -60478,7 +60073,6 @@ interface IgPivotGridGridOptionsFeatures { } interface IgPivotGridGridOptions { - /** * Default column width that will be set for all columns. */ @@ -60521,7 +60115,6 @@ interface IgPivotGridGridOptions { } interface IgPivotGridDragAndDropSettings { - /** * Which element the draggable helper should be appended to while dragging. */ @@ -60549,7 +60142,6 @@ interface PivotGridHeadersRenderedEvent { } interface PivotGridHeadersRenderedEventUIParam { - /** * Used to get a reference to the pivot grid. */ @@ -60571,7 +60163,6 @@ interface PivotGridRenderedEvent { } interface PivotGridRenderedEventUIParam { - /** * Used to get a reference to the pivot grid. */ @@ -60588,7 +60179,6 @@ interface TupleMemberExpandingEvent { } interface TupleMemberExpandingEventUIParam { - /** * Used to get a reference to the pivot grid. */ @@ -60620,7 +60210,6 @@ interface TupleMemberExpandedEvent { } interface TupleMemberExpandedEventUIParam { - /** * Used to get a reference to the pivot grid. */ @@ -60652,7 +60241,6 @@ interface TupleMemberCollapsingEvent { } interface TupleMemberCollapsingEventUIParam { - /** * Used to get a reference to the pivot grid. */ @@ -60684,7 +60272,6 @@ interface TupleMemberCollapsedEvent { } interface TupleMemberCollapsedEventUIParam { - /** * Used to get a reference to the pivot grid. */ @@ -60716,7 +60303,6 @@ interface SortingEvent { } interface SortingEventUIParam { - /** * Used to get a reference to the pivot grid. */ @@ -60733,7 +60319,6 @@ interface SortedEvent { } interface SortedEventUIParam { - /** * Used to get a reference to the pivot grid. */ @@ -60755,7 +60340,6 @@ interface HeadersSortingEvent { } interface HeadersSortingEventUIParam { - /** * Used to get a reference to the pivot grid. */ @@ -60772,7 +60356,6 @@ interface HeadersSortedEvent { } interface HeadersSortedEventUIParam { - /** * Used to get a reference to the pivot grid. */ @@ -61210,7 +60793,6 @@ interface IgPivotGrid { [optionName: string]: any; } interface IgPivotGridMethods { - /** * Returns the igGrid instance used to render the OLAP data. */ @@ -61265,7 +60847,7 @@ interface IgPivotGridMethods { destroy(): void; } interface JQuery { - data(propertyName: "igPivotGrid"):IgPivotGridMethods; + data(propertyName: "igPivotGrid"): IgPivotGridMethods; } interface JQuery { @@ -62207,7 +61789,6 @@ interface JQuery { igPivotGrid(methodName: string, ...methodParams: any[]): any; } interface IgPivotViewDataSourceOptionsXmlaOptionsRequestOptions { - /** * The value is applied to XmlHttpRequest.withCredentials if supported by the user agent. * Setting this property to true will allow IE8/IE9 to make authenticated cross-origin requests to tusted domains through XmlHttpRequest instead of XDomainRequest @@ -62227,7 +61808,6 @@ interface IgPivotViewDataSourceOptionsXmlaOptionsRequestOptions { } interface IgPivotViewDataSourceOptionsXmlaOptionsMdxSettings { - /** * Optional="true" a value indicating whether a NON EMPTY clause is present on ROWS axis. Default value is true */ @@ -62265,7 +61845,6 @@ interface IgPivotViewDataSourceOptionsXmlaOptionsMdxSettings { } interface IgPivotViewDataSourceOptionsXmlaOptions { - /** * Optional="false" The URL of the XMLA server. */ @@ -62320,7 +61899,6 @@ interface IgPivotViewDataSourceOptionsXmlaOptions { } interface IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimensionMeasure { - /** * Optional="false" A unique name for the measure. */ @@ -62349,7 +61927,6 @@ interface IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimensi } interface IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimension { - /** * A unique name for the measures dimension. * The default value is "Measures". This name is used to create the names of dimensions using the following pattern: @@ -62375,7 +61952,6 @@ interface IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimensi } interface IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierarchieLevel { - /** * Optional="false" A name for the level. * The unique name of the level is formed using the following pattern: @@ -62401,7 +61977,6 @@ interface IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierar } interface IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierarchie { - /** * Optional="false" A name for the hierarchy. * The unique name of the hierarchy is formed using the following pattern: @@ -62415,8 +61990,8 @@ interface IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierar caption?: string; /** - * The path to be used when displaying the hierarchy in the user interface. - * Nested folders are indicated by a backslash (\). + * The path to be used when displaying the hierarchy in the user interface. + * Nested folders are indicated by a backslash (\). * The folder hierarchy will appear under parent dimension node. */ displayFolder?: string; @@ -62433,7 +62008,6 @@ interface IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierar } interface IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeDimension { - /** * Optional="false" A unique name for the dimension. */ @@ -62456,7 +62030,6 @@ interface IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeDimension { } interface IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCube { - /** * Optional="false" A unique name for the cube. */ @@ -62484,7 +62057,6 @@ interface IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCube { } interface IgPivotViewDataSourceOptionsFlatDataOptionsMetadata { - /** * Optional="false" Metadata used for the creation of the cube. */ @@ -62497,7 +62069,6 @@ interface IgPivotViewDataSourceOptionsFlatDataOptionsMetadata { } interface IgPivotViewDataSourceOptionsFlatDataOptions { - /** * Specifies any valid data source accepted by $.ig.DataSource, or an instance of an $.ig.DataSource itself. */ @@ -62514,8 +62085,8 @@ interface IgPivotViewDataSourceOptionsFlatDataOptions { dataSourceType?: string; /** - * See $.ig.DataSource. - * string Specifies the name of the property in which data records are held if the response is wrapped. + * See $.ig.DataSource. + * string Specifies the name of the property in which data records are held if the response is wrapped. * null Option is ignored. */ responseDataKey?: string; @@ -62538,7 +62109,6 @@ interface IgPivotViewDataSourceOptionsFlatDataOptions { } interface IgPivotViewDataSourceOptions { - /** * Settings for creating an instance of $.ig.OlapXmlaDataSource. */ @@ -62576,7 +62146,6 @@ interface IgPivotViewDataSourceOptions { } interface IgPivotViewPivotGridOptionsLevelSortDirection { - /** * Specifies the unique name of the level, which will be sorted. */ @@ -62595,7 +62164,6 @@ interface IgPivotViewPivotGridOptionsLevelSortDirection { } interface IgPivotViewPivotGridOptionsGridOptionsFeatures { - /** * Option for IgPivotViewPivotGridOptionsGridOptionsFeatures */ @@ -62603,7 +62171,6 @@ interface IgPivotViewPivotGridOptionsGridOptionsFeatures { } interface IgPivotViewPivotGridOptionsGridOptions { - /** * Default column width that will be set for all columns. * @@ -62650,7 +62217,6 @@ interface IgPivotViewPivotGridOptionsGridOptions { } interface IgPivotViewPivotGridOptionsDragAndDropSettings { - /** * Which element the draggable helper should be appended to while dragging. */ @@ -62674,7 +62240,6 @@ interface IgPivotViewPivotGridOptionsDragAndDropSettings { } interface IgPivotViewPivotGridOptions { - /** * A boolean value indicating whether a parent in the columns is in front of its children. * If set to true, the query set sorts members in a level in their natural order - child members immediately follow their parent members. @@ -62815,7 +62380,6 @@ interface IgPivotViewPivotGridOptions { } interface IgPivotViewDataSelectorOptionsDragAndDropSettings { - /** * Which element the draggable helper should be appended to while dragging. */ @@ -62839,7 +62403,6 @@ interface IgPivotViewDataSelectorOptionsDragAndDropSettings { } interface IgPivotViewDataSelectorOptions { - /** * Settings for the drag and drop functionality of the igPivotDataSelector. */ @@ -62866,7 +62429,6 @@ interface IgPivotViewDataSelectorOptions { } interface IgPivotViewPivotGridPanel { - /** * Determines if the panel containing the igPivotGrid will be resizable. */ @@ -62899,7 +62461,6 @@ interface IgPivotViewPivotGridPanel { } interface IgPivotViewDataSelectorPanel { - /** * Determines the position of the data selector panel inside the igPivotView widget. */ @@ -62977,7 +62538,6 @@ interface IgPivotView { [optionName: string]: any; } interface IgPivotViewMethods { - /** * Returns the igPivotGrid instance of the pivot view. */ @@ -63002,7 +62562,7 @@ interface IgPivotViewMethods { destroy(): void; } interface JQuery { - data(propertyName: "igPivotView"):IgPivotViewMethods; + data(propertyName: "igPivotView"): IgPivotViewMethods; } interface JQuery { @@ -63107,7 +62667,6 @@ interface JQuery { igPivotView(methodName: string, ...methodParams: any[]): any; } interface IgPopover { - /** * Controls whether the popover will close on blur or not */ @@ -63256,7 +62815,6 @@ interface IgPopover { [optionName: string]: any; } interface IgPopoverMethods { - /** * Destroys the popover widget. */ @@ -63315,7 +62873,7 @@ interface IgPopoverMethods { setCoordinates(pos: Object): void; } interface JQuery { - data(propertyName: "igPopover"):IgPopoverMethods; + data(propertyName: "igPopover"): IgPopoverMethods; } interface JQuery { @@ -63606,7 +63164,6 @@ interface JQuery { igPopover(methodName: string, ...methodParams: any[]): any; } interface IgRadialGaugeRange { - /** * Gets or sets the name of the range. */ @@ -63669,7 +63226,6 @@ interface IgRadialGaugeRange { } interface IgRadialGauge { - /** * The width of the gauge. It can be set as a number in pixels, string (px) or percentage (%). */ @@ -63741,7 +63297,7 @@ 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" + * "counterclockwise" * "clockwise" */ scaleSweepDirection?: string; @@ -63767,7 +63323,7 @@ interface IgRadialGauge { needleOutline?: string; /** - * Gets or sets the extent (from -1 to 1) at which to start rendering the needle, measured from the center of the gauge. + * Gets or sets the extent (from -1 to 1) at which to start rendering the needle, measured from the center of the gauge. * Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. */ needleStartExtent?: number; @@ -63782,14 +63338,14 @@ 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" + * "none" + * "rectangle" + * "triangle" + * "needle" + * "trapezoid" + * "rectangleWithBulb" + * "triangleWithBulb" + * "needleWithBulb" * "trapezoidWithBulb" */ needleShape?: string; @@ -63845,12 +63401,12 @@ interface IgRadialGauge { * Gets or sets the shape to use for the needle cap. * * Valid values: - * "none" - * "circle" - * "circleWithHole" - * "circleOverlay" - * "circleOverlayWithHole" - * "circleUnderlay" + * "none" + * "circle" + * "circleWithHole" + * "circleOverlay" + * "circleOverlayWithHole" + * "circleUnderlay" * "circleUnderlayWithHole" */ needlePivotShape?: string; @@ -63991,8 +63547,8 @@ interface IgRadialGauge { * Gets or sets the over or shape to use for the excess fill area for the scale. * * Valid values: - * "auto" - * "circular" + * "auto" + * "circular" * "fitted" */ scaleOversweepShape?: string; @@ -64011,14 +63567,14 @@ interface IgRadialGauge { * Gets or sets the type of shape to use for the backing of the gauge. * * Valid values: - * "circular" + * "circular" * "fitted" */ backingShape?: string; /** - * Gets or sets the multiplying factor to apply to the normal radius of the gauge. - * The radius of the gauge is defined by the minimum of the width and height of the control divided by 2.0. + * Gets or sets the multiplying factor to apply to the normal radius of the gauge. + * The radius of the gauge is defined by the minimum of the width and height of the control divided by 2.0. * This introduces a multiplicative factor to that value. */ radiusMultiplier?: number; @@ -64027,9 +63583,9 @@ 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" + * "omitLast" + * "omitFirst" + * "omitNeither" * "omitBoth" */ duplicateLabelOmissionStrategy?: string; @@ -64072,7 +63628,6 @@ interface IgRadialGauge { [optionName: string]: any; } interface IgRadialGaugeMethods { - /** * Returns a string containing the names of all the ranges delimited with a \n symbol. */ @@ -64081,21 +63636,21 @@ interface IgRadialGaugeMethods { /** * Adds a new range to the radial gauge. * - * @param value + * @param value */ addRange(value: Object): void; /** * Removes a specified range. * - * @param value + * @param value */ removeRange(value: Object): void; /** * Updates the range. * - * @param value + * @param value */ updateRange(value: Object): void; @@ -64107,38 +63662,38 @@ interface IgRadialGaugeMethods { /** * Scales a value on the gauge's main scale to an angle around the center point of the gauge, in radians. * - * @param value + * @param value */ scaleValue(value: Object): void; /** * Unscales a value from an angle in radians to the represented value along the main scale of the gauge. * - * @param value + * @param value */ unscaleValue(value: Object): void; /** * Gets the value for the main scale of the gauge for a given point within the bounds of the gauge. * - * @param x - * @param y + * @param x + * @param y */ getValueForPoint(x: Object, y: Object): number; /** * Gets the point on the gauge for a given scale value and extent. * - * @param value - * @param extent + * @param value + * @param extent */ getPointForValue(value: Object, extent: Object): void; /** * Returns true if the main gauge needle bounding box contains the point provided, otherwise false. * - * @param x - * @param y + * @param x + * @param y */ needleContainsPoint(x: Object, y: Object): void; @@ -64163,7 +63718,7 @@ interface IgRadialGaugeMethods { styleUpdated(): void; } interface JQuery { - data(propertyName: "igRadialGauge"):IgRadialGaugeMethods; + data(propertyName: "igRadialGauge"): IgRadialGaugeMethods; } interface JQuery { @@ -64403,13 +63958,13 @@ interface JQuery { igRadialGauge(optionLiteral: 'option', optionName: "needleOutline", optionValue: string): void; /** - * Gets the extent (from -1 to 1) at which to start rendering the needle, measured from the center of the gauge. + * Gets the extent (from -1 to 1) at which to start rendering the needle, measured from the center of the gauge. * 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: "needleStartExtent"): number; /** - * Sets the extent (from -1 to 1) at which to start rendering the needle, measured from the center of the gauge. + * Sets the extent (from -1 to 1) at which to start rendering the needle, measured from the center of the gauge. * 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. @@ -64927,15 +64482,15 @@ interface JQuery { igRadialGauge(optionLiteral: 'option', optionName: "backingShape", optionValue: string): void; /** - * Gets the multiplying factor to apply to the normal radius of the gauge. - * The radius of the gauge is defined by the minimum of the width and height of the control divided by 2.0. + * Gets the multiplying factor to apply to the normal radius of the gauge. + * The radius of the gauge is defined by the minimum of the width and height of the control divided by 2.0. * This introduces a multiplicative factor to that value. */ igRadialGauge(optionLiteral: 'option', optionName: "radiusMultiplier"): number; /** - * Sets the multiplying factor to apply to the normal radius of the gauge. - * The radius of the gauge is defined by the minimum of the width and height of the control divided by 2.0. + * Sets the multiplying factor to apply to the normal radius of the gauge. + * The radius of the gauge is defined by the minimum of the width and height of the control divided by 2.0. * This introduces a multiplicative factor to that value. * * @optionValue New value to be set. @@ -65048,17 +64603,16 @@ interface JQuery { igRadialGauge(methodName: string, ...methodParams: any[]): any; } interface IgRadialMenuItem { - /** * Gets or sets a value indicating what type of item is being provided. * * * Valid values: - * "button" - * "coloritem" - * "colorwell" - * "list" - * "numericitem" + * "button" + * "coloritem" + * "colorwell" + * "list" + * "numericitem" * "numericgauge" */ type?: string; @@ -65369,7 +64923,6 @@ interface ClosedEvent { } interface ClosedEventUIParam { - /** * Used to obtain reference to menu widget. */ @@ -65381,7 +64934,6 @@ interface OpenedEvent { } interface OpenedEventUIParam { - /** * Used to obtain reference to menu widget. */ @@ -65389,7 +64941,6 @@ interface OpenedEventUIParam { } interface IgRadialMenu { - /** * Gets or sets the items in the menu. */ @@ -65541,7 +65092,6 @@ interface IgRadialMenu { [optionName: string]: any; } interface IgRadialMenuMethods { - /** * Gets or sets the value of a property for the item created with the specified key * @@ -65572,7 +65122,7 @@ interface IgRadialMenuMethods { styleUpdated(): void; } interface JQuery { - data(propertyName: "igRadialMenu"):IgRadialMenuMethods; + data(propertyName: "igRadialMenu"): IgRadialMenuMethods; } interface JQuery { @@ -65944,7 +65494,6 @@ interface HoverChangeEvent { } interface HoverChangeEventUIParam { - /** * Used to get new value. */ @@ -65961,7 +65510,6 @@ interface ValueChangeEvent { } interface ValueChangeEventUIParam { - /** * Used to get new value. */ @@ -65974,7 +65522,6 @@ interface ValueChangeEventUIParam { } interface IgRating { - /** * Gets a vertical or horizontal orientation for the votes. * Change of that option is not supported after igRating was created. @@ -66101,7 +65648,7 @@ interface IgRating { /** * Event which is raised before hover value is changed. * If application returns false, then action is canceled and hover value stays unchanged. - * + * * Function takes arguments evt and ui. * Use ui.value to get new value. * Use ui.oldValue to get old value. @@ -66111,7 +65658,7 @@ interface IgRating { /** * Event which is raised before (selected) value is changed. * If application returns false, then action is canceled and value stays unchanged. - * + * * Function takes arguments evt and ui. * Use ui.value to get new value. * Use ui.oldValue to get old value. @@ -66124,7 +65671,6 @@ interface IgRating { [optionName: string]: any; } interface IgRatingMethods { - /** * Gets reference to [igValidator](ui.igvalidator) used by igRating. * @@ -66169,7 +65715,7 @@ interface IgRatingMethods { destroy(): Object; } interface JQuery { - data(propertyName: "igRating"):IgRatingMethods; + data(propertyName: "igRating"): IgRatingMethods; } interface JQuery { @@ -66450,7 +65996,7 @@ interface JQuery { /** * Event which is raised before hover value is changed. * If application returns false, then action is canceled and hover value stays unchanged. - * + * * Function takes arguments evt and ui. * Use ui.value to get new value. * Use ui.oldValue to get old value. @@ -66460,7 +66006,7 @@ interface JQuery { /** * Event which is raised before hover value is changed. * If application returns false, then action is canceled and hover value stays unchanged. - * + * * Function takes arguments evt and ui. * Use ui.value to get new value. * Use ui.oldValue to get old value. @@ -66472,7 +66018,7 @@ interface JQuery { /** * Event which is raised before (selected) value is changed. * If application returns false, then action is canceled and value stays unchanged. - * + * * Function takes arguments evt and ui. * Use ui.value to get new value. * Use ui.oldValue to get old value. @@ -66482,7 +66028,7 @@ interface JQuery { /** * Event which is raised before (selected) value is changed. * If application returns false, then action is canceled and value stays unchanged. - * + * * Function takes arguments evt and ui. * Use ui.value to get new value. * Use ui.oldValue to get old value. @@ -66501,7 +66047,6 @@ interface ScrollingEvent { } interface ScrollingEventUIParam { - /** * Used to obtain reference to igScroll. */ @@ -66538,7 +66083,6 @@ interface ScrolledEvent { } interface ScrolledEventUIParam { - /** * Used to obtain reference to igScroll. */ @@ -66565,7 +66109,6 @@ interface ThumbDragStartEvent { } interface ThumbDragStartEventUIParam { - /** * Used to obtain reference to igScroll. */ @@ -66582,7 +66125,6 @@ interface ThumbDragMoveEvent { } interface ThumbDragMoveEventUIParam { - /** * Used to obtain reference to igScroll. */ @@ -66609,7 +66151,6 @@ interface ThumbDragEndEvent { } interface ThumbDragEndEventUIParam { - /** * Used to obtain reference to igScroll. */ @@ -66622,7 +66163,6 @@ interface ThumbDragEndEventUIParam { } interface IgScroll { - /** * Sets or gets if the scrollbars should be always visible (on all environments). Otherwise it will be the default behavior. Note: this option is only for the custom scrollbars set through the scrollbarType option. * @@ -66858,7 +66398,7 @@ interface IgScrollMethods { destroy(): void; } interface JQuery { - data(propertyName: "igScroll"):IgScrollMethods; + data(propertyName: "igScroll"): IgScrollMethods; } interface JQuery { @@ -67391,11 +66931,10 @@ interface IgLoadingMethods { destroy(): void; } interface JQuery { - data(propertyName: "igLoading"):IgLoadingMethods; + data(propertyName: "igLoading"): IgLoadingMethods; } interface IgSliderBookmarks { - /** * Get or set the bookmark value. Should be between slider min and max values. */ @@ -67465,7 +67004,6 @@ interface BookmarkClickEventUIParam { } interface IgSlider { - /** * Get or set whether the slide handle will animate when it is moved. */ @@ -67553,7 +67091,7 @@ interface IgSliderMethods { value(newValue: Object): void; } interface JQuery { - data(propertyName: "igSlider"):IgSliderMethods; + data(propertyName: "igSlider"): IgSliderMethods; } interface IgProgressBar { @@ -67585,7 +67123,7 @@ interface IgProgressBarMethods { value(newValue: Object): void; } interface JQuery { - data(propertyName: "igProgressBar"):IgProgressBarMethods; + data(propertyName: "igProgressBar"): IgProgressBarMethods; } interface IgButtonLink { @@ -67631,7 +67169,7 @@ interface IgButtonMethods { destroy(): void; } interface JQuery { - data(propertyName: "igButton"):IgButtonMethods; + data(propertyName: "igButton"): IgButtonMethods; } interface IgTooltip { @@ -67647,7 +67185,7 @@ interface IgTooltipMethods { destroy(): void; } interface JQuery { - data(propertyName: "igTooltip"):IgTooltipMethods; + data(propertyName: "igTooltip"): IgTooltipMethods; } interface CaptureEvent { @@ -67675,11 +67213,10 @@ interface MouseWrapperMethods { destroy(): void; } interface JQuery { - data(propertyName: "mouseWrapper"):MouseWrapperMethods; + data(propertyName: "mouseWrapper"): MouseWrapperMethods; } interface IgResponsiveContainer { - /** * The time between two resize checks in milliseconds. */ @@ -67691,7 +67228,6 @@ interface IgResponsiveContainer { [optionName: string]: any; } interface IgResponsiveContainerMethods { - /** * Destroys the ResponsiveContainer widget */ @@ -67725,7 +67261,7 @@ interface IgResponsiveContainerMethods { addCallback(callback: Function, owner: Object, reactionStep: number, reactionDirection: Object): void; } interface JQuery { - data(propertyName: "igResponsiveContainer"):IgResponsiveContainerMethods; + data(propertyName: "igResponsiveContainer"): IgResponsiveContainerMethods; } interface JQuery { @@ -68253,7 +67789,6 @@ interface JQuery { igResponsiveContainer(methodName: string, ...methodParams: any[]): any; } interface IgSparkline { - /** * The width of the sparkline. It can be set as a number in pixels, string (px) or percentage (%). */ @@ -68328,7 +67863,7 @@ interface IgSparkline { * Gets or sets the display state of the horizontal axis. * * Valid values: - * "visible" + * "visible" * "collapsed" */ horizontalAxisVisibility?: string; @@ -68337,7 +67872,7 @@ interface IgSparkline { * Gets or sets the display state of the vertical axis. * * Valid values: - * "visible" + * "visible" * "collapsed" */ verticalAxisVisibility?: string; @@ -68346,7 +67881,7 @@ interface IgSparkline { * Gets or sets the marker visibility of the sparkline. * * Valid values: - * "visible" + * "visible" * "collapsed" */ markerVisibility?: string; @@ -68355,7 +67890,7 @@ interface IgSparkline { * Gets or sets the negative marker visibility of the sparkline. * * Valid values: - * "visible" + * "visible" * "collapsed" */ negativeMarkerVisibility?: string; @@ -68364,7 +67899,7 @@ interface IgSparkline { * Gets or sets the first marker visibility of the sparkline. * * Valid values: - * "visible" + * "visible" * "collapsed" */ firstMarkerVisibility?: string; @@ -68373,7 +67908,7 @@ interface IgSparkline { * Gets or sets the last marker visibility of the sparkline. * * Valid values: - * "visible" + * "visible" * "collapsed" */ lastMarkerVisibility?: string; @@ -68382,7 +67917,7 @@ interface IgSparkline { * Gets or sets the low marker visibility of the sparkline. * * Valid values: - * "visible" + * "visible" * "collapsed" */ lowMarkerVisibility?: string; @@ -68391,7 +67926,7 @@ interface IgSparkline { * Gets or sets the high marker visibility of the sparkline. * * Valid values: - * "visible" + * "visible" * "collapsed" */ highMarkerVisibility?: string; @@ -68400,7 +67935,7 @@ interface IgSparkline { * Gets or sets the normal range visibility of the sparkline. * * Valid values: - * "visible" + * "visible" * "collapsed" */ normalRangeVisibility?: string; @@ -68459,19 +67994,19 @@ 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" + * "none" + * "linearFit" + * "quadraticFit" + * "cubicFit" + * "quarticFit" + * "quinticFit" + * "logarithmicFit" + * "exponentialFit" + * "powerLawFit" + * "simpleAverage" + * "exponentialAverage" + * "modifiedAverage" + * "cumulativeAverage" * "weightedAverage" */ trendLineType?: string; @@ -68511,7 +68046,7 @@ interface IgSparkline { * Gets or sets the way null values are interpreted. * * Valid values: - * "linearInterpolate" + * "linearInterpolate" * "dontPlot" */ unknownValuePlotting?: string; @@ -68718,7 +68253,7 @@ interface IgSparklineMethods { dataBind(): void; } interface JQuery { - data(propertyName: "igSparkline"):IgSparklineMethods; + data(propertyName: "igSparkline"): IgSparklineMethods; } interface JQuery { @@ -69449,7 +68984,6 @@ interface JQuery { igSparkline(methodName: string, ...methodParams: any[]): any; } interface IgSplitButtonItem { - /** * Item name */ @@ -69472,7 +69006,6 @@ interface IgSplitButtonItem { } interface IgSplitButton { - /** * Button items. * @@ -69493,7 +69026,7 @@ interface IgSplitButton { /** * Event fired when the button is clicked. - * + * * Function takes arguments evt and ui. * Use ui.item to get a reference the igSplitButton element. */ @@ -69501,7 +69034,7 @@ interface IgSplitButton { /** * Event fired after the button is expanded. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. */ @@ -69509,7 +69042,7 @@ interface IgSplitButton { /** * Event fired before a button item is expanded. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. */ @@ -69517,7 +69050,7 @@ interface IgSplitButton { /** * Event fired after the button is collapsed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. */ @@ -69525,7 +69058,7 @@ interface IgSplitButton { /** * Event fired before a button item is collapsed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. */ @@ -69537,7 +69070,6 @@ interface IgSplitButton { [optionName: string]: any; } interface IgSplitButtonMethods { - /** * Switch to given igToolbar button. * @@ -69573,7 +69105,7 @@ interface IgSplitButtonMethods { destroy(): void; } interface JQuery { - data(propertyName: "igSplitButton"):IgSplitButtonMethods; + data(propertyName: "igSplitButton"): IgSplitButtonMethods; } interface JQuery { @@ -69628,7 +69160,7 @@ interface JQuery { /** * Event fired when the button is clicked. - * + * * Function takes arguments evt and ui. * Use ui.item to get a reference the igSplitButton element. */ @@ -69636,7 +69168,7 @@ interface JQuery { /** * Event fired when the button is clicked. - * + * * Function takes arguments evt and ui. * Use ui.item to get a reference the igSplitButton element. * @@ -69646,7 +69178,7 @@ interface JQuery { /** * Event fired after the button is expanded. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. */ @@ -69654,7 +69186,7 @@ interface JQuery { /** * Event fired after the button is expanded. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. * @@ -69664,7 +69196,7 @@ interface JQuery { /** * Event fired before a button item is expanded. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. */ @@ -69672,7 +69204,7 @@ interface JQuery { /** * Event fired before a button item is expanded. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. * @@ -69682,7 +69214,7 @@ interface JQuery { /** * Event fired after the button is collapsed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. */ @@ -69690,7 +69222,7 @@ interface JQuery { /** * Event fired after the button is collapsed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. * @@ -69700,7 +69232,7 @@ interface JQuery { /** * Event fired before a button item is collapsed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. */ @@ -69708,7 +69240,7 @@ interface JQuery { /** * Event fired before a button item is collapsed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. * @@ -69722,7 +69254,6 @@ interface JQuery { igSplitButton(methodName: string, ...methodParams: any[]): any; } interface IgSplitterPanel { - /** * Gets the size of the panel * @@ -69770,7 +69301,6 @@ interface ResizeStartedEvent { } interface ResizeStartedEventUIParam { - /** * Used to get a reference to the splitter instance. */ @@ -69782,7 +69312,6 @@ interface ResizingEvent { } interface ResizingEventUIParam { - /** * Used to get a reference to the splitter instance. */ @@ -69794,7 +69323,6 @@ interface ResizeEndedEvent { } interface ResizeEndedEventUIParam { - /** * Used to get a reference to the splitter instance. */ @@ -69806,7 +69334,6 @@ interface LayoutRefreshingEvent { } interface LayoutRefreshingEventUIParam { - /** * Used to get a reference to the splitter instance. */ @@ -69818,7 +69345,6 @@ interface LayoutRefreshedEvent { } interface LayoutRefreshedEventUIParam { - /** * Used to get a reference to the splitter instance. */ @@ -69826,7 +69352,6 @@ interface LayoutRefreshedEventUIParam { } interface IgSplitter { - /** * Gets/Sets the width of the container. * @@ -69875,7 +69400,7 @@ interface IgSplitter { /** * Fired after collapsing is performed - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. * Use ui.index to get an index of collapsed panel. @@ -69884,7 +69409,7 @@ interface IgSplitter { /** * Fired after expanding is performed - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. * Use ui.index to get an index of expanded panel. @@ -69893,7 +69418,7 @@ interface IgSplitter { /** * Fired before split bar move is performed - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. */ @@ -69901,7 +69426,7 @@ interface IgSplitter { /** * Fired while split bar move is performed - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. */ @@ -69909,7 +69434,7 @@ interface IgSplitter { /** * Fired after split bar move is performed - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. */ @@ -69917,7 +69442,7 @@ interface IgSplitter { /** * Fired before the panels are refreshed because of browser"s resizing. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. */ @@ -69925,7 +69450,7 @@ interface IgSplitter { /** * Fired after the panels are refreshed because of browser"s resizing. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. */ @@ -69937,7 +69462,6 @@ interface IgSplitter { [optionName: string]: any; } interface IgSplitterMethods { - /** * Returns the element that represents this widget. */ @@ -69992,7 +69516,7 @@ interface IgSplitterMethods { destroy(): void; } interface JQuery { - data(propertyName: "igSplitter"):IgSplitterMethods; + data(propertyName: "igSplitter"): IgSplitterMethods; } interface JQuery { @@ -70092,7 +69616,7 @@ interface JQuery { /** * Fired after collapsing is performed - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. * Use ui.index to get an index of collapsed panel. @@ -70101,7 +69625,7 @@ interface JQuery { /** * Fired after collapsing is performed - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. * Use ui.index to get an index of collapsed panel. @@ -70112,7 +69636,7 @@ interface JQuery { /** * Fired after expanding is performed - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. * Use ui.index to get an index of expanded panel. @@ -70121,7 +69645,7 @@ interface JQuery { /** * Fired after expanding is performed - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. * Use ui.index to get an index of expanded panel. @@ -70132,7 +69656,7 @@ interface JQuery { /** * Fired before split bar move is performed - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. */ @@ -70140,7 +69664,7 @@ interface JQuery { /** * Fired before split bar move is performed - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. * @@ -70150,7 +69674,7 @@ interface JQuery { /** * Fired while split bar move is performed - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. */ @@ -70158,7 +69682,7 @@ interface JQuery { /** * Fired while split bar move is performed - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. * @@ -70168,7 +69692,7 @@ interface JQuery { /** * Fired after split bar move is performed - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. */ @@ -70176,7 +69700,7 @@ interface JQuery { /** * Fired after split bar move is performed - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. * @@ -70186,7 +69710,7 @@ interface JQuery { /** * Fired before the panels are refreshed because of browser"s resizing. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. */ @@ -70194,7 +69718,7 @@ interface JQuery { /** * Fired before the panels are refreshed because of browser"s resizing. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. * @@ -70204,7 +69728,7 @@ interface JQuery { /** * Fired after the panels are refreshed because of browser"s resizing. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. */ @@ -70212,7 +69736,7 @@ interface JQuery { /** * Fired after the panels are refreshed because of browser"s resizing. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. * @@ -70226,10 +69750,9 @@ interface JQuery { igSplitter(methodName: string, ...methodParams: any[]): any; } interface IgTileManagerSplitterOptionsEvents { - /** * Event fired after collapsing is performed. Not cancellable. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. * Use ui.index to get an index of collased panel. @@ -70238,7 +69761,7 @@ interface IgTileManagerSplitterOptionsEvents { /** * Event fired after expanding is performed. Not cancellable. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. * Use ui.index to get an index of expanded panel. @@ -70252,7 +69775,6 @@ interface IgTileManagerSplitterOptionsEvents { } interface IgTileManagerSplitterOptions { - /** * Gets/Sets whether the splitter should be enabled. * @@ -70288,7 +69810,6 @@ interface TileRenderingEvent { } interface TileRenderingEventUIParam { - /** * Used to get a reference to the tile manager performing rendering. */ @@ -70305,7 +69826,6 @@ interface TileRenderedEvent { } interface TileRenderedEventUIParam { - /** * Used to get a reference to the tile manager performing rendering. */ @@ -70322,7 +69842,6 @@ interface TileMaximizingEvent { } interface TileMaximizingEventUIParam { - /** * Used to get a reference to the tile manager performing the maximizing the tile belongs to. */ @@ -70344,7 +69863,6 @@ interface TileMaximizedEvent { } interface TileMaximizedEventUIParam { - /** * Used to get a reference to the tile manager the maximized tile belongs to. */ @@ -70361,7 +69879,6 @@ interface TileMinimizingEvent { } interface TileMinimizingEventUIParam { - /** * Used to get a reference to the tile manager performing the minimizing the tile belongs to. */ @@ -70383,7 +69900,6 @@ interface TileMinimizedEvent { } interface TileMinimizedEventUIParam { - /** * Used to get a reference to the tile manager the minimized tile belongs to. */ @@ -70396,9 +69912,8 @@ interface TileMinimizedEventUIParam { } interface IgTileManager { - /** - * + * * * Valid values: * "string" The container width can be set in pixels (px) and percentage (%). @@ -70461,14 +69976,14 @@ interface IgTileManager { /** * Gets/Sets the horizontal spacing between tiles. - * + * * number The horizontal spacing between tiles can be set as a number. */ marginLeft?: number; /** * Gets/Sets the vertical spacing between tiles. - * + * * number The vertical spacing between tiles can be set as a number. */ marginTop?: number; @@ -70625,7 +70140,7 @@ interface IgTileManager { /** * Fired before databinding is performed - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing databinding. * Use ui.dataSource to get a reference to the [$.ig.DataSource](ig.datasource) the tile manager is to be databound to. @@ -70634,7 +70149,7 @@ interface IgTileManager { /** * Fired after databinding is complete - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing databinding. * Use ui.dataView to get a reference to the data the tile manager is databound to. @@ -70645,7 +70160,7 @@ interface IgTileManager { /** * Fired before rendering of the tile manager begins. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing rendering. * Use ui.tiles to get a reference to the tiles the tile manager is going to render. If using data source this referes to the data provided. @@ -70655,7 +70170,7 @@ interface IgTileManager { /** * Fired after rendering of the tile manager completes. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing rendering. */ @@ -70663,7 +70178,7 @@ interface IgTileManager { /** * Event fired before a tile is rendered in the container - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing rendering. * Use ui.tile to get a reference to the tile being rendered @@ -70672,7 +70187,7 @@ interface IgTileManager { /** * Event Fired after a tile has been rendered in the container - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing rendering. * Use ui.tile to get a reference to the rendered tile @@ -70681,7 +70196,7 @@ interface IgTileManager { /** * Fired before a tile in the tile manager is maximized. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing the maximizing the tile belongs to. * Use ui.tile to get the jQuery element of the tile being maximized @@ -70691,7 +70206,7 @@ interface IgTileManager { /** * Fired after a tile in the tile manager is maximized. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager the maximized tile belongs to. * Use ui.tile to get the jQuery element of the maximized tile @@ -70700,7 +70215,7 @@ interface IgTileManager { /** * Fired before a tile in the tile manager is minimized. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing the minimizing the tile belongs to. * Use ui.tile to get the jQuery element of the tile being minimized @@ -70710,7 +70225,7 @@ interface IgTileManager { /** * Fired after a tile in the tile manager is minimized. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager the minimized tile belongs to. * Use ui.tile to get the jQuery element of the minimized tile @@ -70723,7 +70238,6 @@ interface IgTileManager { [optionName: string]: any; } interface IgTileManagerMethods { - /** * Maximizes a given tile. * @@ -70790,7 +70304,7 @@ interface IgTileManagerMethods { destroy(): Object; } interface JQuery { - data(propertyName: "igTileManager"):IgTileManagerMethods; + data(propertyName: "igTileManager"): IgTileManagerMethods; } interface JQuery { @@ -70889,14 +70403,14 @@ interface JQuery { /** * Gets/Sets the horizontal spacing between tiles. - * + * * number The horizontal spacing between tiles can be set as a number. */ igTileManager(optionLiteral: 'option', optionName: "marginLeft"): number; /** * /Sets the horizontal spacing between tiles. - * + * * number The horizontal spacing between tiles can be set as a number. * * @optionValue New value to be set. @@ -70905,14 +70419,14 @@ interface JQuery { /** * Gets/Sets the vertical spacing between tiles. - * + * * number The vertical spacing between tiles can be set as a number. */ igTileManager(optionLiteral: 'option', optionName: "marginTop"): number; /** * /Sets the vertical spacing between tiles. - * + * * number The vertical spacing between tiles can be set as a number. * * @optionValue New value to be set. @@ -71187,7 +70701,7 @@ interface JQuery { /** * Fired before databinding is performed - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing databinding. * Use ui.dataSource to get a reference to the [$.ig.DataSource](ig.datasource) the tile manager is to be databound to. @@ -71196,7 +70710,7 @@ interface JQuery { /** * Fired before databinding is performed - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing databinding. * Use ui.dataSource to get a reference to the [$.ig.DataSource](ig.datasource) the tile manager is to be databound to. @@ -71207,7 +70721,7 @@ interface JQuery { /** * Fired after databinding is complete - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing databinding. * Use ui.dataView to get a reference to the data the tile manager is databound to. @@ -71218,7 +70732,7 @@ interface JQuery { /** * Fired after databinding is complete - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing databinding. * Use ui.dataView to get a reference to the data the tile manager is databound to. @@ -71231,7 +70745,7 @@ interface JQuery { /** * Fired before rendering of the tile manager begins. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing rendering. * Use ui.tiles to get a reference to the tiles the tile manager is going to render. If using data source this referes to the data provided. @@ -71241,7 +70755,7 @@ interface JQuery { /** * Fired before rendering of the tile manager begins. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing rendering. * Use ui.tiles to get a reference to the tiles the tile manager is going to render. If using data source this referes to the data provided. @@ -71253,7 +70767,7 @@ interface JQuery { /** * Fired after rendering of the tile manager completes. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing rendering. */ @@ -71261,7 +70775,7 @@ interface JQuery { /** * Fired after rendering of the tile manager completes. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing rendering. * @@ -71271,7 +70785,7 @@ interface JQuery { /** * Event fired before a tile is rendered in the container - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing rendering. * Use ui.tile to get a reference to the tile being rendered @@ -71280,7 +70794,7 @@ interface JQuery { /** * Event fired before a tile is rendered in the container - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing rendering. * Use ui.tile to get a reference to the tile being rendered @@ -71291,7 +70805,7 @@ interface JQuery { /** * Event Fired after a tile has been rendered in the container - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing rendering. * Use ui.tile to get a reference to the rendered tile @@ -71300,7 +70814,7 @@ interface JQuery { /** * Event Fired after a tile has been rendered in the container - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing rendering. * Use ui.tile to get a reference to the rendered tile @@ -71311,7 +70825,7 @@ interface JQuery { /** * Fired before a tile in the tile manager is maximized. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing the maximizing the tile belongs to. * Use ui.tile to get the jQuery element of the tile being maximized @@ -71321,7 +70835,7 @@ interface JQuery { /** * Fired before a tile in the tile manager is maximized. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing the maximizing the tile belongs to. * Use ui.tile to get the jQuery element of the tile being maximized @@ -71333,7 +70847,7 @@ interface JQuery { /** * Fired after a tile in the tile manager is maximized. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager the maximized tile belongs to. * Use ui.tile to get the jQuery element of the maximized tile @@ -71342,7 +70856,7 @@ interface JQuery { /** * Fired after a tile in the tile manager is maximized. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager the maximized tile belongs to. * Use ui.tile to get the jQuery element of the maximized tile @@ -71353,7 +70867,7 @@ interface JQuery { /** * Fired before a tile in the tile manager is minimized. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing the minimizing the tile belongs to. * Use ui.tile to get the jQuery element of the tile being minimized @@ -71363,7 +70877,7 @@ interface JQuery { /** * Fired before a tile in the tile manager is minimized. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing the minimizing the tile belongs to. * Use ui.tile to get the jQuery element of the tile being minimized @@ -71375,7 +70889,7 @@ interface JQuery { /** * Fired after a tile in the tile manager is minimized. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager the minimized tile belongs to. * Use ui.tile to get the jQuery element of the minimized tile @@ -71384,7 +70898,7 @@ interface JQuery { /** * Fired after a tile in the tile manager is minimized. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager the minimized tile belongs to. * Use ui.tile to get the jQuery element of the minimized tile @@ -71462,7 +70976,6 @@ interface WindowResizedEventUIParam { } interface IgToolbar { - /** * Set/Get the widget height. * @@ -71588,7 +71101,6 @@ interface IgToolbar { [optionName: string]: any; } interface IgToolbarMethods { - /** * Returns the element on which the widget was instantiated */ @@ -71642,7 +71154,7 @@ interface IgToolbarMethods { destroy(): void; } interface JQuery { - data(propertyName: "igToolbar"):IgToolbarMethods; + data(propertyName: "igToolbar"): IgToolbarMethods; } interface JQuery { @@ -71947,7 +71459,6 @@ interface ActivatingEvent { } interface ActivatingEventUIParam { - /** * Used to get reference to this igToolbarButton. */ @@ -71959,7 +71470,6 @@ interface ActivatedEvent { } interface ActivatedEventUIParam { - /** * Used to get reference to this igToolbarButton. */ @@ -71971,7 +71481,6 @@ interface DeactivatingEvent { } interface DeactivatingEventUIParam { - /** * Used to get reference to this igToolbarButton. */ @@ -71983,7 +71492,6 @@ interface DeactivatedEvent { } interface DeactivatedEventUIParam { - /** * Used to get reference to this igToolbarButton. */ @@ -71991,7 +71499,6 @@ interface DeactivatedEventUIParam { } interface IgToolbarButton { - /** * Enable/Disable the "Toggling" of a button. * @@ -72038,7 +71545,6 @@ interface IgToolbarButton { [optionName: string]: any; } interface IgToolbarButtonMethods { - /** * Toggle toolbar button */ @@ -72047,14 +71553,14 @@ interface IgToolbarButtonMethods { /** * Activate toolbar button * - * @param event + * @param event */ activate(event: Object): void; /** * Deactivate toolbar button * - * @param event + * @param event */ deactivate(event: Object): void; @@ -72069,7 +71575,7 @@ interface IgToolbarButtonMethods { destroy(): void; } interface JQuery { - data(propertyName: "igToolbarButton"):IgToolbarButtonMethods; + data(propertyName: "igToolbarButton"): IgToolbarButtonMethods; } interface JQuery { @@ -72177,7 +71683,6 @@ interface JQuery { igToolbarButton(methodName: string, ...methodParams: any[]): any; } interface IgTreeGridColumnFixing { - /** * Option for igTreeGridColumnFixing */ @@ -72187,7 +71692,7 @@ interface IgTreeGridColumnFixingMethods { destroy(): void; } interface JQuery { - data(propertyName: "igTreeGridColumnFixing"):IgTreeGridColumnFixingMethods; + data(propertyName: "igTreeGridColumnFixing"): IgTreeGridColumnFixingMethods; } interface JQuery { @@ -72199,7 +71704,6 @@ interface JQuery { igTreeGridColumnFixing(methodName: string, ...methodParams: any[]): any; } interface IgTreeGridColumnMoving { - /** * Option for igTreeGridColumnMoving */ @@ -72209,7 +71713,7 @@ interface IgTreeGridColumnMovingMethods { destroy(): void; } interface JQuery { - data(propertyName: "igTreeGridColumnMoving"):IgTreeGridColumnMovingMethods; + data(propertyName: "igTreeGridColumnMoving"): IgTreeGridColumnMovingMethods; } interface JQuery { @@ -72221,7 +71725,6 @@ interface JQuery { igTreeGridColumnMoving(methodName: string, ...methodParams: any[]): any; } interface IgTreeGridFiltering { - /** * The property in the response that will hold the total number of records in the data source * @@ -72271,7 +71774,6 @@ interface IgTreeGridFiltering { [optionName: string]: any; } interface IgTreeGridFilteringMethods { - /** * Returns the count of data records that match filtering conditions */ @@ -72279,7 +71781,7 @@ interface IgTreeGridFilteringMethods { destroy(): void; } interface JQuery { - data(propertyName: "igTreeGridFiltering"):IgTreeGridFilteringMethods; + data(propertyName: "igTreeGridFiltering"): IgTreeGridFilteringMethods; } interface JQuery { @@ -72390,7 +71892,6 @@ interface JQuery { igTreeGridFiltering(methodName: string, ...methodParams: any[]): any; } interface IgTreeGridHiding { - /** * A list of column settings that specifies hiding options on a per column basis. * @@ -72405,7 +71906,7 @@ interface IgTreeGridHiding { /** * Controls containment behavior. - * + * * owner The column chooser dialog will be draggable only in the grid area * window The column chooser dialog will be draggable in the whole window area */ @@ -72736,7 +72237,7 @@ interface IgTreeGridHidingMethods { removeColumnChooserResetButton(): void; } interface JQuery { - data(propertyName: "igTreeGridHiding"):IgTreeGridHidingMethods; + data(propertyName: "igTreeGridHiding"): IgTreeGridHidingMethods; } interface JQuery { @@ -72782,7 +72283,7 @@ interface JQuery { /** * Controls containment behavior. - * + * * owner The column chooser dialog will be draggable only in the grid area * window The column chooser dialog will be draggable in the whole window area */ @@ -72790,7 +72291,7 @@ interface JQuery { /** * Controls containment behavior. - * + * * owner The column chooser dialog will be draggable only in the grid area * window The column chooser dialog will be draggable in the whole window area * @@ -73364,7 +72865,6 @@ interface JQuery { igTreeGridHiding(methodName: string, ...methodParams: any[]): any; } interface IgTreeGridDataSourceSettings { - /** * The name of the property that keeps track of the expansion state of a data item. Defaults to __ig_options.expanded. * @@ -73390,7 +72890,6 @@ interface IgTreeGridDataSourceSettings { } interface IgTreeGrid { - /** * Specifies 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. * @@ -73519,7 +73018,6 @@ interface IgTreeGrid { [optionName: string]: any; } interface IgTreeGridMethods { - /** * Clears the transaction log (delegates to igDataSource). Note that this does not update the UI. In case the UI must be updated, set the second parameter "updateUI" to true, which will trigger a call to dataBind() to re-render the contents. * @@ -73571,7 +73069,7 @@ interface IgTreeGridMethods { destroy(): Object; } interface JQuery { - data(propertyName: "igTreeGrid"):IgTreeGridMethods; + data(propertyName: "igTreeGrid"): IgTreeGridMethods; } interface JQuery { @@ -73869,7 +73367,6 @@ interface JQuery { igTreeGrid(methodName: string, ...methodParams: any[]): any; } interface IgTreeGridMultiColumnHeaders { - /** * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. */ @@ -73956,7 +73453,7 @@ interface IgTreeGridMultiColumnHeadersMethods { getMultiColumnHeaders(): any[]; } interface JQuery { - data(propertyName: "igTreeGridMultiColumnHeaders"):IgTreeGridMultiColumnHeadersMethods; + data(propertyName: "igTreeGridMultiColumnHeaders"): IgTreeGridMultiColumnHeadersMethods; } interface JQuery { @@ -74076,7 +73573,6 @@ interface ContextRowRenderingEvent { } interface ContextRowRenderingEventUIParam { - /** * Used to get reference to igTreeGridPaging. */ @@ -74103,7 +73599,6 @@ interface ContextRowRenderedEvent { } interface ContextRowRenderedEventUIParam { - /** * Used to get reference to igTreeGridPaging. */ @@ -74131,7 +73626,6 @@ interface ContextRowRenderedEventUIParam { } interface IgTreeGridPaging { - /** * Sets gets paging mode. * @@ -74396,7 +73890,7 @@ interface IgTreeGridPaging { persist?: boolean; /** - * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. + * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. * */ inherit?: boolean; @@ -74488,7 +73982,6 @@ interface IgTreeGridPaging { [optionName: string]: any; } interface IgTreeGridPagingMethods { - /** * Destroys the igTreeGridPaging feature by removing all elements in the pager area, unbinding events, and resetting data to discard data filtering on paging */ @@ -74519,7 +74012,7 @@ interface IgTreeGridPagingMethods { pageSize(size?: number): number; } interface JQuery { - data(propertyName: "igTreeGridPaging"):IgTreeGridPagingMethods; + data(propertyName: "igTreeGridPaging"): IgTreeGridPagingMethods; } interface JQuery { @@ -75104,13 +74597,13 @@ interface JQuery { igTreeGridPaging(optionLiteral: 'option', optionName: "persist", optionValue: boolean): void; /** - * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. + * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. * */ igTreeGridPaging(optionLiteral: 'option', optionName: "inherit"): boolean; /** - * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. + * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. * * * @optionValue New value to be set. @@ -75301,7 +74794,6 @@ interface JQuery { igTreeGridPaging(methodName: string, ...methodParams: any[]): any; } interface IgTreeGridResizing { - /** * Resize the column to the size of the longest currently visible cell value. * @@ -75382,7 +74874,7 @@ interface IgTreeGridResizingMethods { resize(column: Object, width?: Object): void; } interface JQuery { - data(propertyName: "igTreeGridResizing"):IgTreeGridResizingMethods; + data(propertyName: "igTreeGridResizing"): IgTreeGridResizingMethods; } interface JQuery { @@ -75537,7 +75029,6 @@ interface JQuery { igTreeGridResizing(methodName: string, ...methodParams: any[]): any; } interface IgTreeGridRowSelectors { - /** * Determines row numbering format. * @@ -75577,7 +75068,7 @@ interface IgTreeGridRowSelectors { rowNumberingSeed?: number; /** - * + * * * Valid values: * "string" The row selector column width can be set in pixels (px) and percentage (%) @@ -75729,12 +75220,12 @@ interface IgTreeGridRowSelectorsMethods { /** * Returns the check state of the row by id. * - * @param rowId + * @param rowId */ checkStateById(rowId: Object): string; } interface JQuery { - data(propertyName: "igTreeGridRowSelectors"):IgTreeGridRowSelectorsMethods; + data(propertyName: "igTreeGridRowSelectors"): IgTreeGridRowSelectorsMethods; } interface JQuery { @@ -76028,7 +75519,6 @@ interface JQuery { igTreeGridRowSelectors(methodName: string, ...methodParams: any[]): any; } interface IgTreeGridSelection { - /** * Enables / Disables multiple selection of cells and rows - depending on the mode * @@ -76292,28 +75782,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. */ 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; @@ -76329,7 +75819,7 @@ interface IgTreeGridSelectionMethods { activeRow(): Object; } interface JQuery { - data(propertyName: "igTreeGridSelection"):IgTreeGridSelectionMethods; + data(propertyName: "igTreeGridSelection"): IgTreeGridSelectionMethods; } interface JQuery { @@ -76756,7 +76246,6 @@ interface JQuery { igTreeGridSelection(methodName: string, ...methodParams: any[]): any; } interface IgTreeGridSorting { - /** * Specifies from which data bound level to be applied sorting - 0 is the first level * @@ -76958,7 +76447,7 @@ interface IgTreeGridSorting { /** * Controls containment behavior of multiple sorting dialog. - * + * * owner The multi sorting dialog will be draggable only in the grid area * window The multi sorting dialog will be draggable in the whole window area */ @@ -77120,7 +76609,6 @@ interface IgTreeGridSorting { [optionName: string]: any; } interface IgTreeGridSortingMethods { - /** * Returns whether a column with the specified columnKey is sorted(taken from the data source sorting expressions) * @@ -77134,7 +76622,7 @@ interface IgTreeGridSortingMethods { * * @param index Column key (string) or index (number) - for multi-row grid only column key can be used. Specifies the column which we want to sort. If the mode is multiple, previous sorting states are not cleared. * @param direction Specifies sorting direction (ascending or descending) - * @param header + * @param header */ sortColumn(index: Object, direction: Object, header: Object): void; @@ -77169,7 +76657,7 @@ interface IgTreeGridSortingMethods { /** * Renders content of multiple sorting dialog - sorted and unsorted columns. * - * @param isToCallEvents + * @param isToCallEvents */ renderMultipleSortingDialogContent(isToCallEvents: Object): void; @@ -77179,7 +76667,7 @@ interface IgTreeGridSortingMethods { removeDialogClearButton(): void; } interface JQuery { - data(propertyName: "igTreeGridSorting"):IgTreeGridSortingMethods; + data(propertyName: "igTreeGridSorting"): IgTreeGridSortingMethods; } interface JQuery { @@ -77614,7 +77102,7 @@ interface JQuery { /** * Controls containment behavior of multiple sorting dialog. - * + * * owner The multi sorting dialog will be draggable only in the grid area * window The multi sorting dialog will be draggable in the whole window area */ @@ -77622,7 +77110,7 @@ interface JQuery { /** * Controls containment behavior of multiple sorting dialog. - * + * * owner The multi sorting dialog will be draggable only in the grid area * window The multi sorting dialog will be draggable in the whole window area * @@ -77968,7 +77456,6 @@ interface JQuery { igTreeGridSorting(methodName: string, ...methodParams: any[]): any; } interface IgTreeGridTooltips { - /** * determines the tooltip visibility option * @@ -78095,7 +77582,7 @@ interface IgTreeGridTooltipsMethods { id(): string; } interface JQuery { - data(propertyName: "igTreeGridTooltips"):IgTreeGridTooltipsMethods; + data(propertyName: "igTreeGridTooltips"): IgTreeGridTooltipsMethods; } interface JQuery { @@ -78340,7 +77827,6 @@ interface JQuery { igTreeGridTooltips(methodName: string, ...methodParams: any[]): any; } interface IgTreeGridUpdating { - /** * Specifies whether to enable or disable adding children to rows. * @@ -78735,7 +78221,6 @@ interface IgTreeGridUpdating { [optionName: string]: any; } interface IgTreeGridUpdatingMethods { - /** * Adds a new child to a specific row. It also creates a transaction and updates the UI. * @@ -78860,7 +78345,7 @@ interface IgTreeGridUpdatingMethods { hideDeleteButton(): void; } interface JQuery { - data(propertyName: "igTreeGridUpdating"):IgTreeGridUpdatingMethods; + data(propertyName: "igTreeGridUpdating"): IgTreeGridUpdatingMethods; } interface JQuery { @@ -79770,11 +79255,10 @@ interface IgBrowseButtonMethods { destroy(): void; } interface JQuery { - data(propertyName: "igBrowseButton"):IgBrowseButtonMethods; + data(propertyName: "igBrowseButton"): IgBrowseButtonMethods; } interface IgUploadFileExtensionIcons { - /** * Array of string for file extensions */ @@ -79801,7 +79285,6 @@ interface FileSelectingEvent { } interface FileSelectingEventUIParam { - /** * Used to access the igUpload widget object. */ @@ -79813,7 +79296,6 @@ interface FileSelectedEvent { } interface FileSelectedEventUIParam { - /** * Used to get unique identifier of the file */ @@ -79835,7 +79317,6 @@ interface FileUploadingEvent { } interface FileUploadingEventUIParam { - /** * Used to get unique identifier of the file */ @@ -79877,7 +79358,6 @@ interface FileUploadedEvent { } interface FileUploadedEventUIParam { - /** * Used to get unique identifier of the file */ @@ -79909,7 +79389,6 @@ interface FileUploadAbortedEvent { } interface FileUploadAbortedEventUIParam { - /** * Used to get unique identifier of the file */ @@ -79946,7 +79425,6 @@ interface CancelAllClickedEvent { } interface CancelAllClickedEventUIParam { - /** * Used to access the igUpload widget object. */ @@ -79958,7 +79436,6 @@ interface OnErrorEvent { } interface OnErrorEventUIParam { - /** * Used to get current errorCode */ @@ -79995,7 +79472,6 @@ interface FileExtensionsValidatingEvent { } interface FileExtensionsValidatingEventUIParam { - /** * Used to get the full file name */ @@ -80017,7 +79493,6 @@ interface OnXHRLoadEvent { } interface OnXHRLoadEventUIParam { - /** * Used to get unique identifier of the file */ @@ -80044,7 +79519,6 @@ interface OnFormDataSubmitEvent { } interface OnFormDataSubmitEventUIParam { - /** * Used to get unique identifier of the file */ @@ -80072,7 +79546,6 @@ interface OnFormDataSubmitEventUIParam { } interface IgUpload { - /** * Get or set width of the main container of the file upload control. Main container contains all buttons, progressbar, etc. * @@ -80421,7 +79894,6 @@ interface IgUpload { [optionName: string]: any; } interface IgUploadMethods { - /** * Return jquery object of fileupload container - html DOM element */ @@ -80491,7 +79963,7 @@ interface IgUploadMethods { getFileInfo(fileIndex: number): Object; } interface JQuery { - data(propertyName: "igUpload"):IgUploadMethods; + data(propertyName: "igUpload"): IgUploadMethods; } interface JQuery { @@ -81335,7 +80807,6 @@ interface JQuery { igUpload(methodName: string, ...methodParams: any[]): any; } interface IgValidatorField { - /** * Gets the target element (input or control target) to be validated. This field setting is required. * @@ -81357,7 +80828,6 @@ interface ValidatingEvent { } interface ValidatingEventUIParam { - /** * Used to get reference to the igValidator widget. */ @@ -81374,7 +80844,6 @@ interface ValidatedEvent { } interface ValidatedEventUIParam { - /** * Used to get reference to the igValidator widget. */ @@ -81401,7 +80870,6 @@ interface SuccessEvent { } interface SuccessEventUIParam { - /** * Used to get reference to the igValidator widget. */ @@ -81428,7 +80896,6 @@ interface ErrorEvent { } interface ErrorEventUIParam { - /** * Used to get reference to the igValidator widget. */ @@ -81455,7 +80922,6 @@ interface ErrorShowingEvent { } interface ErrorShowingEventUIParam { - /** * Used to get reference to the igValidator widget. */ @@ -81477,7 +80943,6 @@ interface ErrorHidingEvent { } interface ErrorHidingEventUIParam { - /** * Used to get reference to the igValidator widget. */ @@ -81499,7 +80964,6 @@ interface ErrorShownEvent { } interface ErrorShownEventUIParam { - /** * Used to get reference to the igValidator widget. */ @@ -81521,7 +80985,6 @@ interface ErrorHiddenEvent { } interface ErrorHiddenEventUIParam { - /** * Used to get reference to the igValidator widget. */ @@ -81543,7 +81006,6 @@ interface SuccessShowingEvent { } interface SuccessShowingEventUIParam { - /** * Used to get reference to the igValidator widget. */ @@ -81565,7 +81027,6 @@ interface SuccessHidingEvent { } interface SuccessHidingEventUIParam { - /** * Used to get reference to the igValidator widget. */ @@ -81587,7 +81048,6 @@ interface SuccessShownEvent { } interface SuccessShownEventUIParam { - /** * Used to get reference to the igValidator widget. */ @@ -81609,7 +81069,6 @@ interface SuccessHiddenEvent { } interface SuccessHiddenEventUIParam { - /** * Used to get reference to the igValidator widget. */ @@ -81631,7 +81090,6 @@ interface FormValidatingEvent { } interface FormValidatingEventUIParam { - /** * Used to get reference to the igValidator widget. */ @@ -81648,7 +81106,6 @@ interface FormValidatedEvent { } interface FormValidatedEventUIParam { - /** * Used to get reference to the igValidator widget. */ @@ -81670,7 +81127,6 @@ interface FormErrorEvent { } interface FormErrorEventUIParam { - /** * Used to get reference to the igValidator widget. */ @@ -81687,7 +81143,6 @@ interface FormSuccessEvent { } interface FormSuccessEventUIParam { - /** * Used to get reference to the igValidator widget. */ @@ -81700,7 +81155,6 @@ interface FormSuccessEventUIParam { } interface IgValidator { - /** * Gets/Sets whether validation is triggered when the text in editor changes. * Note that this is more appropriate for selection controls such as checkbox, combo or rating. @@ -81734,7 +81188,7 @@ interface IgValidator { /** * Gets/Sets number validation rule options.Default separators for decimals and thousands are '.' and ',' respectively and are defined in the "$.ui.igValidator.defaults" object. - * + * * * * Valid values: @@ -81745,7 +81199,7 @@ interface IgValidator { /** * Gets/Sets date validation rule options. This can additionally help guide the [valueRange](ui.igvalidator#options:valueRange) validation.Note: Dependat on JavaScript Date parsing which will accept a wide range of values. - * + * * * * Valid values: @@ -81786,7 +81240,7 @@ interface IgValidator { /** * Gets/Sets Credit Card number validation rule options.Note: This rule will only validate the checksum of the number using Luhn algorithm irregardless of card type. - * + * * * * Valid values: @@ -81881,7 +81335,7 @@ interface IgValidator { /** * Event which is raised on validation before default validation logic is applied. * Return false in order to cancel the event and consider the field valid. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.value to get current value in target. @@ -81891,7 +81345,7 @@ interface IgValidator { /** * Event which is raised after value was validated but before any action takes effect. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.value to get current value in target. @@ -81905,7 +81359,7 @@ interface IgValidator { /** * Event raised for valid field after value was validated but before any action takes effect. * Function takes arguments evt and ui. - * + * * Use ui.owner to get reference to the igValidator widget. * Use ui.value to get current value in target. * Use ui.valid to determine the outcome of the validation. @@ -81917,7 +81371,7 @@ interface IgValidator { /** * Event raised for invalid field after value was validated but before any action takes effect. * Function takes arguments evt and ui. - * + * * Use ui.owner to get reference to the igValidator widget. * Use ui.value to get current value in target. * Use ui.valid to determine the outcome of the validation. @@ -81930,7 +81384,7 @@ interface IgValidator { /** * Event which is raised before error message is displayed. * Return false in order to prevent error message display. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -81942,7 +81396,7 @@ interface IgValidator { /** * Event which is raised before error message is hidden. * Return false in order to keep the error message displayed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -81953,7 +81407,7 @@ interface IgValidator { /** * Event which is raised after error message was displayed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -81964,7 +81418,7 @@ interface IgValidator { /** * Event which is raised after error message was hidden. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -81976,7 +81430,7 @@ interface IgValidator { /** * Event which is raised before success message is displayed. * Return false in order to prevent success message display. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -81988,7 +81442,7 @@ interface IgValidator { /** * Event which is raised before success message is hidden. * Return false in order to keep success message displayed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -81999,7 +81453,7 @@ interface IgValidator { /** * Event which is raised after success message was displayed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -82010,7 +81464,7 @@ interface IgValidator { /** * Event which is raised after success message was hidden. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -82022,7 +81476,7 @@ interface IgValidator { /** * Event triggered on Validator instance level before handling a form submit event. * Return false to cancel to skip validating and potentially allow the submit if no other other validators return erros. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.target to get reference of the event target form. @@ -82031,7 +81485,7 @@ interface IgValidator { /** * Event triggered on Validator instance level after validation on form submit event.. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.target to get reference of the event target form. @@ -82041,7 +81495,7 @@ interface IgValidator { /** * Event triggered on Validator instance level after failed validation on form submit event. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.target to get reference of the event target form. @@ -82050,7 +81504,7 @@ interface IgValidator { /** * Event triggered on Validator instance level after successful validation on form submit event. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.target to get reference of the event target form. @@ -82063,7 +81517,6 @@ interface IgValidator { [optionName: string]: any; } interface IgValidatorMethods { - /** * Trigger validation and show errors for invalid fields. * @@ -82137,372 +81590,372 @@ interface IgValidatorMethods { destroy(): void; } interface JQuery { - data(propertyName: "igValidator"):IgValidatorMethods; + data(propertyName: "igValidator"): IgValidatorMethods; } -declare module Infragistics { -export class IgValidatorBaseRule { - constructor(name: string); - constructor(formatItems: any[]); +declare namespace Infragistics { + 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 module Infragistics { -export class IgValidatorRequiredRule { - constructor(name: string); - constructor(groupTypes: any[]); - constructor(groupMessageName: string); - constructor(formatItems: any[]); - getMessageType(options: Object): void; - isValid(options: Object, value: Object): void; +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; - /** - * 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 module Infragistics { -export class IgValidatorControlRule { - constructor(name: string); - constructor(formatItems: any[]); - getMessageType(): void; +declare namespace Infragistics { + 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 module Infragistics { -export class IgValidatorNumberRule { - constructor(name: string); - constructor(formatItems: any[]); - isValid(options: Object, value: Object): void; +declare namespace Infragistics { + 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 module Infragistics { -export class IgValidatorDateRule { - constructor(name: string); - constructor(formatItems: any[]); - isValid(options: Object, value: Object): void; +declare namespace Infragistics { + 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 module Infragistics { -export class IgValidatorLengthRule { - constructor(name: string); - constructor(formatItems: any[]); - getMessageType(): void; - isValid(options: Object, value: Object): void; +declare namespace Infragistics { + 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 module Infragistics { -export class IgValidatorValueRule { - constructor(name: string); - constructor(formatItems: any[]); - getMessageType(): void; - isValid(options: Object, value: Object): void; -} +declare namespace Infragistics { + 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 module Infragistics { -export class IgValidatorEqualToRule { - constructor(name: string); - constructor(formatItems: any[]); - isValid(options: Object, value: Object): void; +declare namespace Infragistics { + 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 module Infragistics { -export class IgValidatorEmailRule { - constructor(name: string); - constructor(formatItems: any[]); - isValid(options: Object, value: Object): void; +declare namespace Infragistics { + 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 module Infragistics { -export class IgValidatorPatternRule { - constructor(name: string); - constructor(formatItems: any[]); - isValid(options: Object, value: Object): void; +declare namespace Infragistics { + 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 module Infragistics { -export class IgValidatorCustomRule { - constructor(name: string); - constructor(formatItems: any[]); - getMessageType(): void; - isValid(options: Object, value: Object): void; +declare namespace Infragistics { + 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 module Infragistics { -export class IgValidatorCreditCardRule { - constructor(name: string); - constructor(formatItems: any[]); +declare namespace Infragistics { + class IgValidatorCreditCardRule { + constructor(name: string); + constructor(formatItems: any[]); - /** - * Based on ASP.NET CreditCardAttribute check, - * https://github.com/Microsoft/referencesource/blob/master/System.ComponentModel.DataAnnotations/DataAnnotations/CreditCardAttribute.cs - * using Luhn algorithm https://en.wikipedia.org/wiki/Luhn_algorithm - * - * @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 { @@ -82581,14 +82034,14 @@ interface JQuery { /** * Gets/Sets number validation rule options.Default separators for decimals and thousands are '.' and ',' respectively and are defined in the "$.ui.igValidator.defaults" object. - * + * * */ igValidator(optionLiteral: 'option', optionName: "number"): boolean|Object; /** * /Sets number validation rule options.Default separators for decimals and thousands are '.' and ',' respectively and are defined in the "$.ui.igValidator.defaults" object. - * + * * * * @optionValue New value to be set. @@ -82597,14 +82050,14 @@ interface JQuery { /** * Gets/Sets date validation rule options. This can additionally help guide the [valueRange](ui.igvalidator#options:valueRange) validation.Note: Dependat on JavaScript Date parsing which will accept a wide range of values. - * + * * */ igValidator(optionLiteral: 'option', optionName: "date"): boolean|Object; /** * /Sets date validation rule options. This can additionally help guide the [valueRange](ui.igvalidator#options:valueRange) validation.Note: Dependat on JavaScript Date parsing which will accept a wide range of values. - * + * * * * @optionValue New value to be set. @@ -82655,14 +82108,14 @@ interface JQuery { /** * Gets/Sets Credit Card number validation rule options.Note: This rule will only validate the checksum of the number using Luhn algorithm irregardless of card type. - * + * * */ igValidator(optionLiteral: 'option', optionName: "creditCard"): boolean|Object; /** * /Sets Credit Card number validation rule options.Note: This rule will only validate the checksum of the number using Luhn algorithm irregardless of card type. - * + * * * * @optionValue New value to be set. @@ -82834,7 +82287,7 @@ interface JQuery { /** * Event which is raised on validation before default validation logic is applied. * Return false in order to cancel the event and consider the field valid. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.value to get current value in target. @@ -82845,7 +82298,7 @@ interface JQuery { /** * Event which is raised on validation before default validation logic is applied. * Return false in order to cancel the event and consider the field valid. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.value to get current value in target. @@ -82857,7 +82310,7 @@ interface JQuery { /** * Event which is raised after value was validated but before any action takes effect. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.value to get current value in target. @@ -82870,7 +82323,7 @@ interface JQuery { /** * Event which is raised after value was validated but before any action takes effect. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.value to get current value in target. @@ -82886,7 +82339,7 @@ interface JQuery { /** * Event raised for valid field after value was validated but before any action takes effect. * Function takes arguments evt and ui. - * + * * Use ui.owner to get reference to the igValidator widget. * Use ui.value to get current value in target. * Use ui.valid to determine the outcome of the validation. @@ -82898,7 +82351,7 @@ interface JQuery { /** * Event raised for valid field after value was validated but before any action takes effect. * Function takes arguments evt and ui. - * + * * Use ui.owner to get reference to the igValidator widget. * Use ui.value to get current value in target. * Use ui.valid to determine the outcome of the validation. @@ -82912,7 +82365,7 @@ interface JQuery { /** * Event raised for invalid field after value was validated but before any action takes effect. * Function takes arguments evt and ui. - * + * * Use ui.owner to get reference to the igValidator widget. * Use ui.value to get current value in target. * Use ui.valid to determine the outcome of the validation. @@ -82925,7 +82378,7 @@ interface JQuery { /** * Event raised for invalid field after value was validated but before any action takes effect. * Function takes arguments evt and ui. - * + * * Use ui.owner to get reference to the igValidator widget. * Use ui.value to get current value in target. * Use ui.valid to determine the outcome of the validation. @@ -82940,7 +82393,7 @@ interface JQuery { /** * Event which is raised before error message is displayed. * Return false in order to prevent error message display. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -82952,7 +82405,7 @@ interface JQuery { /** * Event which is raised before error message is displayed. * Return false in order to prevent error message display. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -82966,7 +82419,7 @@ interface JQuery { /** * Event which is raised before error message is hidden. * Return false in order to keep the error message displayed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -82978,7 +82431,7 @@ interface JQuery { /** * Event which is raised before error message is hidden. * Return false in order to keep the error message displayed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -82991,7 +82444,7 @@ interface JQuery { /** * Event which is raised after error message was displayed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -83002,7 +82455,7 @@ interface JQuery { /** * Event which is raised after error message was displayed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -83015,7 +82468,7 @@ interface JQuery { /** * Event which is raised after error message was hidden. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -83026,7 +82479,7 @@ interface JQuery { /** * Event which is raised after error message was hidden. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -83040,7 +82493,7 @@ interface JQuery { /** * Event which is raised before success message is displayed. * Return false in order to prevent success message display. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -83052,7 +82505,7 @@ interface JQuery { /** * Event which is raised before success message is displayed. * Return false in order to prevent success message display. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -83066,7 +82519,7 @@ interface JQuery { /** * Event which is raised before success message is hidden. * Return false in order to keep success message displayed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -83078,7 +82531,7 @@ interface JQuery { /** * Event which is raised before success message is hidden. * Return false in order to keep success message displayed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -83091,7 +82544,7 @@ interface JQuery { /** * Event which is raised after success message was displayed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -83102,7 +82555,7 @@ interface JQuery { /** * Event which is raised after success message was displayed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -83115,7 +82568,7 @@ interface JQuery { /** * Event which is raised after success message was hidden. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -83126,7 +82579,7 @@ interface JQuery { /** * Event which is raised after success message was hidden. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -83140,7 +82593,7 @@ interface JQuery { /** * Event triggered on Validator instance level before handling a form submit event. * Return false to cancel to skip validating and potentially allow the submit if no other other validators return erros. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.target to get reference of the event target form. @@ -83150,7 +82603,7 @@ interface JQuery { /** * Event triggered on Validator instance level before handling a form submit event. * Return false to cancel to skip validating and potentially allow the submit if no other other validators return erros. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.target to get reference of the event target form. @@ -83161,7 +82614,7 @@ interface JQuery { /** * Event triggered on Validator instance level after validation on form submit event.. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.target to get reference of the event target form. @@ -83171,7 +82624,7 @@ interface JQuery { /** * Event triggered on Validator instance level after validation on form submit event.. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.target to get reference of the event target form. @@ -83183,7 +82636,7 @@ interface JQuery { /** * Event triggered on Validator instance level after failed validation on form submit event. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.target to get reference of the event target form. @@ -83192,7 +82645,7 @@ interface JQuery { /** * Event triggered on Validator instance level after failed validation on form submit event. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.target to get reference of the event target form. @@ -83203,7 +82656,7 @@ interface JQuery { /** * Event triggered on Validator instance level after successful validation on form submit event. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.target to get reference of the event target form. @@ -83212,7 +82665,7 @@ interface JQuery { /** * Event triggered on Validator instance level after successful validation on form submit event. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.target to get reference of the event target form. @@ -83227,7 +82680,6 @@ interface JQuery { igValidator(methodName: string, ...methodParams: any[]): any; } interface IgVideoPlayerBookmark { - /** * Gets/Sets where the bookmark will be positioned. Should be between 0 and movie duration in seconds. * @@ -83253,7 +82705,6 @@ interface IgVideoPlayerBookmark { } interface IgVideoPlayerRelatedVideo { - /** * Gets/Sets the URL of the related video image. * @@ -83303,7 +82754,6 @@ interface IgVideoPlayerRelatedVideo { } interface IgVideoPlayerBanner { - /** * Gets/Sets the banner image url. * @@ -83383,7 +82833,6 @@ interface IgVideoPlayerBanner { } interface IgVideoPlayerCommercialsLinkedCommercial { - /** * Gets/Sets the sources of the linked commercial video. * @@ -83415,7 +82864,6 @@ interface IgVideoPlayerCommercialsLinkedCommercial { } interface IgVideoPlayerCommercialsEmbeddedCommercial { - /** * Gets/Sets the start second of the embedded commercial. * @@ -83447,7 +82895,6 @@ interface IgVideoPlayerCommercialsEmbeddedCommercial { } interface IgVideoPlayerCommercialsAdMessage { - /** * Gets/Sets whether to apply an animation effect when showing or hiding the ad message. If set to true, the animation is played for [animationDuration](ui.igvideoplayer#options:commercials.adMessage.animationDuration) in milliseconds. * @@ -83479,7 +82926,6 @@ interface IgVideoPlayerCommercialsAdMessage { } interface IgVideoPlayerCommercials { - /** * Gets/Sets an array of linked commercial objects. A linked commercial is a separate video file that will be played in the specified position of the original movie clip by [startTime](ui.igvideoplayer#options:commercials.linkedCommercials.startTime). This feature is useful if you have frequently changing outside commercial sources. * @@ -83521,7 +82967,6 @@ interface EndedEvent { } interface EndedEventUIParam { - /** * Used to get the url of the playing video. */ @@ -83538,7 +82983,6 @@ interface PlayingEvent { } interface PlayingEventUIParam { - /** * Used to get the url of the playing video. */ @@ -83555,7 +82999,6 @@ interface PausedEvent { } interface PausedEventUIParam { - /** * Used to get the url of the playing video. */ @@ -83572,7 +83015,6 @@ interface BufferingEvent { } interface BufferingEventUIParam { - /** * Used to get the url of the playing video. */ @@ -83589,7 +83031,6 @@ interface ProgressEvent { } interface ProgressEventUIParam { - /** * Used to get the url of the playing video. */ @@ -83611,7 +83052,6 @@ interface WaitingEvent { } interface WaitingEventUIParam { - /** * Used to get the url of the playing video. */ @@ -83633,7 +83073,6 @@ interface EnterFullScreenEvent { } interface EnterFullScreenEventUIParam { - /** * Used to get the url of the playing video. */ @@ -83645,7 +83084,6 @@ interface ExitFullScreenEvent { } interface ExitFullScreenEventUIParam { - /** * Used to get the url of the playing video. */ @@ -83657,7 +83095,6 @@ interface RelatedVideoClickEvent { } interface RelatedVideoClickEventUIParam { - /** * Used to get the relatedVideo object from the relatedVideos array. */ @@ -83674,7 +83111,6 @@ interface BannerVisibleEvent { } interface BannerVisibleEventUIParam { - /** * Used to get the banner index in the banners array. */ @@ -83696,7 +83132,6 @@ interface BannerHiddenEvent { } interface BannerHiddenEventUIParam { - /** * Used to get the banner index in the banners array. */ @@ -83718,7 +83153,6 @@ interface BannerClickEvent { } interface BannerClickEventUIParam { - /** * Used to get the banner html element in the DOM. */ @@ -83726,7 +83160,6 @@ interface BannerClickEventUIParam { } interface IgVideoPlayer { - /** * Gets/Sets a list of video sources to choose from. Best coded/format is automatically detected by the control. Supported types are depending on the browser and could be one of the following mov, mp4, webm, ogg. * @@ -83855,7 +83288,7 @@ interface IgVideoPlayer { /** * Occurs when video has ended. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.duration to get the video duration in seconds. @@ -83864,7 +83297,7 @@ interface IgVideoPlayer { /** * Occurs when video gets playing. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.duration to get the video duration in seconds. @@ -83873,7 +83306,7 @@ interface IgVideoPlayer { /** * Occurs when video is paused. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.duration to get the video duration in seconds. @@ -83882,7 +83315,7 @@ interface IgVideoPlayer { /** * Occurs when a chunk of data is buffered. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.buffered to get buffered percentage. @@ -83891,7 +83324,7 @@ interface IgVideoPlayer { /** * Occurs when video has advanced the playback position. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.currentTime to get current position in the video at which the event was fired. @@ -83901,7 +83334,7 @@ interface IgVideoPlayer { /** * Occurs when igVideoPlayer is waiting for data from the server. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.currentTime to get current position in the video at which the event was fired. @@ -83911,7 +83344,7 @@ interface IgVideoPlayer { /** * Occurs when the bookmark is hit. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.bookmark to get the bookmark object from the bookmarks array. @@ -83921,7 +83354,7 @@ interface IgVideoPlayer { /** * Occurs when the bookmark is clicked. - * + * * Function takes arguments evt and ui. * Use ui.bookmark to get the bookmark object from the bookmarks array. * Use ui.bookmarkElement to get the html element in the DOM. @@ -83930,7 +83363,7 @@ interface IgVideoPlayer { /** * Occurs when igVideoPlayer enters full screen mode. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. */ @@ -83938,7 +83371,7 @@ interface IgVideoPlayer { /** * Occurs when igVideoPlayer exits full screen mode. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. */ @@ -83946,7 +83379,7 @@ interface IgVideoPlayer { /** * Occurs when related video is clicked. - * + * * Function takes arguments evt and ui. * Use ui.relatedVideo to get the relatedVideo object from the relatedVideos array. * Use ui.relatedVideoElement to get the relatedVideo html element in the DOM. @@ -83955,7 +83388,7 @@ interface IgVideoPlayer { /** * Defines the name of the player banner visible event. Fired when the banner has been displayed. - * + * * Function takes arguments evt and ui. * Use ui.index to get the banner index in the banners array. * Use ui.banner to get the banner object from the banners array. @@ -83965,7 +83398,7 @@ interface IgVideoPlayer { /** * Occurs when the banner is hidden. - * + * * Function takes arguments evt and ui. * Use ui.index to get the banner index in the banners array. * Use ui.banner to get the banner object from the banners array. @@ -83975,7 +83408,7 @@ interface IgVideoPlayer { /** * Occurs when the banner is clicked. - * + * * Function takes arguments evt and ui. * Use ui.bannerElement to get the banner html element in the DOM. */ @@ -83992,7 +83425,6 @@ interface IgVideoPlayer { [optionName: string]: any; } interface IgVideoPlayerMethods { - /** * Returns the element on which the widget was instantiated */ @@ -84104,7 +83536,7 @@ interface IgVideoPlayerMethods { destroy(): void; } interface JQuery { - data(propertyName: "igVideoPlayer"):IgVideoPlayerMethods; + data(propertyName: "igVideoPlayer"): IgVideoPlayerMethods; } interface JQuery { @@ -84425,7 +83857,7 @@ interface JQuery { /** * Occurs when video has ended. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.duration to get the video duration in seconds. @@ -84434,7 +83866,7 @@ interface JQuery { /** * Occurs when video has ended. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.duration to get the video duration in seconds. @@ -84445,7 +83877,7 @@ interface JQuery { /** * Occurs when video gets playing. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.duration to get the video duration in seconds. @@ -84454,7 +83886,7 @@ interface JQuery { /** * Occurs when video gets playing. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.duration to get the video duration in seconds. @@ -84465,7 +83897,7 @@ interface JQuery { /** * Occurs when video is paused. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.duration to get the video duration in seconds. @@ -84474,7 +83906,7 @@ interface JQuery { /** * Occurs when video is paused. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.duration to get the video duration in seconds. @@ -84485,7 +83917,7 @@ interface JQuery { /** * Occurs when a chunk of data is buffered. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.buffered to get buffered percentage. @@ -84494,7 +83926,7 @@ interface JQuery { /** * Occurs when a chunk of data is buffered. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.buffered to get buffered percentage. @@ -84505,7 +83937,7 @@ interface JQuery { /** * Occurs when video has advanced the playback position. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.currentTime to get current position in the video at which the event was fired. @@ -84515,7 +83947,7 @@ interface JQuery { /** * Occurs when video has advanced the playback position. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.currentTime to get current position in the video at which the event was fired. @@ -84527,7 +83959,7 @@ interface JQuery { /** * Occurs when igVideoPlayer is waiting for data from the server. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.currentTime to get current position in the video at which the event was fired. @@ -84537,7 +83969,7 @@ interface JQuery { /** * Occurs when igVideoPlayer is waiting for data from the server. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.currentTime to get current position in the video at which the event was fired. @@ -84549,7 +83981,7 @@ interface JQuery { /** * Occurs when the bookmark is hit. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.bookmark to get the bookmark object from the bookmarks array. @@ -84559,7 +83991,7 @@ interface JQuery { /** * Occurs when the bookmark is hit. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.bookmark to get the bookmark object from the bookmarks array. @@ -84571,7 +84003,7 @@ interface JQuery { /** * Occurs when the bookmark is clicked. - * + * * Function takes arguments evt and ui. * Use ui.bookmark to get the bookmark object from the bookmarks array. * Use ui.bookmarkElement to get the html element in the DOM. @@ -84580,7 +84012,7 @@ interface JQuery { /** * Occurs when the bookmark is clicked. - * + * * Function takes arguments evt and ui. * Use ui.bookmark to get the bookmark object from the bookmarks array. * Use ui.bookmarkElement to get the html element in the DOM. @@ -84591,7 +84023,7 @@ interface JQuery { /** * Occurs when igVideoPlayer enters full screen mode. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. */ @@ -84599,7 +84031,7 @@ interface JQuery { /** * Occurs when igVideoPlayer enters full screen mode. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * @@ -84609,7 +84041,7 @@ interface JQuery { /** * Occurs when igVideoPlayer exits full screen mode. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. */ @@ -84617,7 +84049,7 @@ interface JQuery { /** * Occurs when igVideoPlayer exits full screen mode. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * @@ -84627,7 +84059,7 @@ interface JQuery { /** * Occurs when related video is clicked. - * + * * Function takes arguments evt and ui. * Use ui.relatedVideo to get the relatedVideo object from the relatedVideos array. * Use ui.relatedVideoElement to get the relatedVideo html element in the DOM. @@ -84636,7 +84068,7 @@ interface JQuery { /** * Occurs when related video is clicked. - * + * * Function takes arguments evt and ui. * Use ui.relatedVideo to get the relatedVideo object from the relatedVideos array. * Use ui.relatedVideoElement to get the relatedVideo html element in the DOM. @@ -84647,7 +84079,7 @@ interface JQuery { /** * Defines the name of the player banner visible event. Fired when the banner has been displayed. - * + * * Function takes arguments evt and ui. * Use ui.index to get the banner index in the banners array. * Use ui.banner to get the banner object from the banners array. @@ -84657,7 +84089,7 @@ interface JQuery { /** * Defines the name of the player banner visible event. Fired when the banner has been displayed. - * + * * Function takes arguments evt and ui. * Use ui.index to get the banner index in the banners array. * Use ui.banner to get the banner object from the banners array. @@ -84669,7 +84101,7 @@ interface JQuery { /** * Occurs when the banner is hidden. - * + * * Function takes arguments evt and ui. * Use ui.index to get the banner index in the banners array. * Use ui.banner to get the banner object from the banners array. @@ -84679,7 +84111,7 @@ interface JQuery { /** * Occurs when the banner is hidden. - * + * * Function takes arguments evt and ui. * Use ui.index to get the banner index in the banners array. * Use ui.banner to get the banner object from the banners array. @@ -84691,7 +84123,7 @@ interface JQuery { /** * Occurs when the banner is clicked. - * + * * Function takes arguments evt and ui. * Use ui.bannerElement to get the banner html element in the DOM. */ @@ -84699,7 +84131,7 @@ interface JQuery { /** * Occurs when the banner is clicked. - * + * * Function takes arguments evt and ui. * Use ui.bannerElement to get the banner html element in the DOM. * @@ -84725,7 +84157,6 @@ interface JQuery { igVideoPlayer(methodName: string, ...methodParams: any[]): any; } interface IgZoombarDefaultZoomWindow { - /** * The left component of the zoom window in percentages. * @@ -84749,7 +84180,6 @@ interface ZoomChangingEvent { } interface ZoomChangingEventUIParam { - /** * Used to get reference to igZoombar. */ @@ -84761,7 +84191,6 @@ interface ZoomChangedEvent { } interface ZoomChangedEventUIParam { - /** * Used to get reference to igZoombar. */ @@ -84773,7 +84202,6 @@ interface ProviderCreatedEvent { } interface ProviderCreatedEventUIParam { - /** * Used to get the reference the created provider */ @@ -84790,7 +84218,6 @@ interface WindowDragStartingEvent { } interface WindowDragStartingEventUIParam { - /** * Used to get reference to igZoombar. */ @@ -84802,7 +84229,6 @@ interface WindowDragStartedEvent { } interface WindowDragStartedEventUIParam { - /** * Used to get reference to igZoombar. */ @@ -84814,7 +84240,6 @@ interface WindowDraggingEvent { } interface WindowDraggingEventUIParam { - /** * Used to get reference to igZoombar. */ @@ -84826,7 +84251,6 @@ interface WindowDragEndingEvent { } interface WindowDragEndingEventUIParam { - /** * Used to get reference to igZoombar. */ @@ -84838,7 +84262,6 @@ interface WindowDragEndedEvent { } interface WindowDragEndedEventUIParam { - /** * Used to get reference to igZoombar. */ @@ -84850,7 +84273,6 @@ interface WindowResizingEvent { } interface WindowResizingEventUIParam { - /** * Used to get reference to igZoombar. */ @@ -84858,7 +84280,6 @@ interface WindowResizingEventUIParam { } interface IgZoombar { - /** * Specifies a provider class which interfaces the widget that is being zoomed. * object Provider class to use. The provider should implement all methods in the $.ig.ZoombarProviderDefault class and is suggested to be extended from it. @@ -85048,7 +84469,6 @@ interface IgZoombar { [optionName: string]: any; } interface IgZoombarMethods { - /** * Destroys the Zoombar widget */ @@ -85083,11 +84503,10 @@ interface IgZoombarMethods { zoom(left?: number, width?: number): Object; } interface JQuery { - data(propertyName: "igZoombar"):IgZoombarMethods; + data(propertyName: "igZoombar"): IgZoombarMethods; } interface ZoombarProviderDefaultSettings { - /** * Contains the target component's instance */ @@ -85113,99 +84532,99 @@ interface ZoombarProviderDefaultSettings { [optionName: string]: any; } -declare module Infragistics { -export class ZoombarProviderDefault { - constructor(settings: ZoombarProviderDefaultSettings); +declare namespace Infragistics { + 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 module Infragistics { -export 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; -} +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; + } } interface IgniteUIStatic { -ZoombarProviderDataChart: typeof Infragistics.ZoombarProviderDataChart; + ZoombarProviderDataChart: typeof Infragistics.ZoombarProviderDataChart; } interface JQuery { diff --git a/types/ignite-ui/tslint.json b/types/ignite-ui/tslint.json index 71f9eaad3f..a04d4ac95d 100644 --- a/types/ignite-ui/tslint.json +++ b/types/ignite-ui/tslint.json @@ -1,8 +1,11 @@ { "extends": "../tslint.json", "rules": { + "array-type": false, "dt-header": false, - "forbidden-types": false, + "ban-types": false, + "callable-types": false, + "no-empty-interface": false, "unified-signatures": false, "max-line-length": false, "whitespace": false diff --git a/types/jasmine-ajax/index.d.ts b/types/jasmine-ajax/index.d.ts index 4e227add1b..4762ba085a 100644 --- a/types/jasmine-ajax/index.d.ts +++ b/types/jasmine-ajax/index.d.ts @@ -21,7 +21,7 @@ interface JasmineAjaxRequest extends XMLHttpRequest { password: string; requestHeaders: { [key: string]: string }; overriddenMimeType: string; - data: () => string; + data(): string; respondWith(response: JasmineAjaxResponse): void; } diff --git a/types/jasmine-ajax/tslint.json b/types/jasmine-ajax/tslint.json index fe03bea79d..6e33505955 100644 --- a/types/jasmine-ajax/tslint.json +++ b/types/jasmine-ajax/tslint.json @@ -1,7 +1,7 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false, + "ban-types": false, "unified-signatures": false } } diff --git a/types/jquery-mask-plugin/tslint.json b/types/jquery-mask-plugin/tslint.json index f05741c59b..b0e7084e94 100644 --- a/types/jquery-mask-plugin/tslint.json +++ b/types/jquery-mask-plugin/tslint.json @@ -1,6 +1,6 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false + "ban-types": false } } diff --git a/types/jquery.validation/index.d.ts b/types/jquery.validation/index.d.ts index bbe55f2c93..9b77a80e23 100644 --- a/types/jquery.validation/index.d.ts +++ b/types/jquery.validation/index.d.ts @@ -5,18 +5,16 @@ /// -declare namespace JQueryValidation -{ - type RulesDictionary = { [name: string]: any }; +declare namespace JQueryValidation { + interface RulesDictionary { [name: string]: any; } type ValidatePredicate = ((element: HTMLElement, event: JQueryEventObject) => void); type ShouldValidatePredicate = boolean|ValidatePredicate; - interface ValidationOptions - { + interface ValidationOptions { /** - * Enables debug mode. If true, the form is not submitted and certain errors are displayed on the console + * Enables debug mode. If true, the form is not submitted and certain errors are displayed on the console * (will check if a window.console property exists). Try to enable when a form is just submitted instead of validation stopping the submit. * * default: false @@ -48,24 +46,24 @@ declare namespace JQueryValidation * * default: Places the error label after the invalid element */ - errorPlacement?: (error: JQuery, element: JQuery) => void; + errorPlacement?(error: JQuery, element: JQuery): void; /** - * If enabled, removes the errorClass from the invalid elements and hides all error messages whenever the element is focused. + * If enabled, removes the errorClass from the invalid elements and hides all error messages whenever the element is focused. * Avoid combination with focusInvalid. * * default: false */ focusCleanup?: boolean; /** - * Focus the last active or first invalid element on submit via validator.focusInvalid(). The last active element is the one - * that had focus when the form was submitted, avoiding stealing its focus. If there was no element focused, the first one + * Focus the last active or first invalid element on submit via validator.focusInvalid(). The last active element is the one + * that had focus when the form was submitted, avoiding stealing its focus. If there was no element focused, the first one * in the form gets it, unless this option is turned off. * * default: true */ focusInvalid?: boolean; /** - * Specify grouping of error messages. A group consists of an arbitrary group name as the key and a space separated list of + * Specify grouping of error messages. A group consists of an arbitrary group name as the key and a space separated list of * element names as the value. Use errorPlacement to control where the group message is placed. */ groups?: { [groupName: string]: string }; @@ -74,29 +72,29 @@ declare namespace JQueryValidation * * default: Adds errorClass (see the option) to the element */ - highlight?: (element: HTMLElement, errorClass: string, validClass: string) => void; + highlight?(element: HTMLElement, errorClass: string, validClass: string): void; /** - * Elements to ignore when validating, simply filtering them out. jQuery's not-method is used, therefore everything that is + * Elements to ignore when validating, simply filtering them out. jQuery's not-method is used, therefore everything that is * accepted by not() can be passed as this option. Inputs of type submit and reset are always ignored, so are disabled elements. */ ignore?: string; /** - * Set to skip reading messages from the title attribute, helps to avoid issues with Google Toolbar; default is false for compability, + * Set to skip reading messages from the title attribute, helps to avoid issues with Google Toolbar; default is false for compability, * the message-from-title is likely to be completely removed in a future release. * * default: false */ ignoreTitle?: boolean; /** - * Callback for custom code when an invalid form is submitted. Called with an event object as the first argument, and the validator + * Callback for custom code when an invalid form is submitted. Called with an event object as the first argument, and the validator * as the second. */ - invalidHandler?: (event: JQueryEventObject, validator: Validator) => void; + invalidHandler?(event: JQueryEventObject, validator: Validator): void; /** - * Key/value pairs defining custom messages. Key is the name of an element, value the message to display for that element. Instead - * of a plain message, another map with specific messages for each rule can be used. Overrides the title attribute of an element or - * the default message for the method (in that order). Each message can be a String or a Callback. The callback is called in the scope - * of the validator, with the rule's parameters as the first argument and the element as the second, and must return a String to display + * Key/value pairs defining custom messages. Key is the name of an element, value the message to display for that element. Instead + * of a plain message, another map with specific messages for each rule can be used. Overrides the title attribute of an element or + * the default message for the method (in that order). Each message can be a String or a Callback. The callback is called in the scope + * of the validator, with the rule's parameters as the first argument and the element as the second, and must return a String to display * as the message. * * default: the default message for the method used @@ -111,8 +109,8 @@ declare namespace JQueryValidation */ onclick?: ShouldValidatePredicate; /** - * Function. Validate elements when user focuses in. If omitted hides all other fields marked as invalid. - * + * Function. Validate elements when user focuses in. If omitted hides all other fields marked as invalid. + * * Set to a custom Function to decide for yourself when to run validation. */ onfocusin?: ValidatePredicate; @@ -124,7 +122,7 @@ declare namespace JQueryValidation */ onfocusout?: ShouldValidatePredicate; /** - * Boolean or Function. Validate elements on keyup. As long as the field is not marked as invalid, nothing happens. + * Boolean or Function. Validate elements on keyup. As long as the field is not marked as invalid, nothing happens. * Otherwise, all rules are checked on each key up event. Set to false to disable. * * Set to a Function to decide for yourself when to run validation. @@ -140,36 +138,36 @@ declare namespace JQueryValidation */ onsubmit?: boolean; /** - * A custom message display handler. Gets the map of errors as the first argument and an array of errors as the second, - * called in the context of the validator object. The arguments contain only those elements currently validated, - * which can be a single element when doing validation onblur/keyup. You can trigger (in addition to your own messages) + * A custom message display handler. Gets the map of errors as the first argument and an array of errors as the second, + * called in the context of the validator object. The arguments contain only those elements currently validated, + * which can be a single element when doing validation onblur/keyup. You can trigger (in addition to your own messages) * the default behaviour by calling this.defaultShowErrors(). */ rules?: RulesDictionary; /** - * A custom message display handler. Gets the map of errors as the first argument and an array of errors as the second, - * called in the context of the validator object. The arguments contain only those elements currently validated, which can - * be a single element when doing validation onblur/keyup. You can trigger (in addition to your own messages) the default + * A custom message display handler. Gets the map of errors as the first argument and an array of errors as the second, + * called in the context of the validator object. The arguments contain only those elements currently validated, which can + * be a single element when doing validation onblur/keyup. You can trigger (in addition to your own messages) the default * behaviour by calling this.defaultShowErrors(). */ - showErrors?: (errorMap: ErrorDictionary, errorList: ErrorListItem[]) => void; + showErrors?(errorMap: ErrorDictionary, errorList: ErrorListItem[]): void; /** - * Callback for handling the actual submit when the form is valid. Gets the form and the event object. Replaces the default submit. + * Callback for handling the actual submit when the form is valid. Gets the form and the event object. Replaces the default submit. * The right place to submit a form via Ajax after it is validated. */ - submitHandler?: (form: HTMLFormElement, event?: JQueryEventObject) => void; + submitHandler?(form: HTMLFormElement, event?: JQueryEventObject): void; /** - * String or Function. If specified, the error label is displayed to show a valid element. If a String is given, it is added as - * a class to the label. If a Function is given, it is called with the label (as a jQuery object) and the validated input (as a DOM element). + * String or Function. If specified, the error label is displayed to show a valid element. If a String is given, it is added as + * a class to the label. If a Function is given, it is called with the label (as a jQuery object) and the validated input (as a DOM element). * The label can be used to add a text like "ok!". */ - success?: string|{($label: JQuery, validatedInput: HTMLElement): void}; + success?: string | (($label: JQuery, validatedInput: HTMLElement) => void); /** * Called to revert changes made by option highlight, same arguments as highlight. * * default: Removes the errorClass */ - unhighlight?: (element: HTMLElement, errorClass: string, validClass: string) => void; + unhighlight?(element: HTMLElement, errorClass: string, validClass: string): void; /** * This class is added to an element after it was validated and considered valid. * @@ -184,19 +182,16 @@ declare namespace JQueryValidation wrapper?: string; } - interface ErrorDictionary - { + interface ErrorDictionary { [name: string]: string; } - interface ErrorListItem - { + interface ErrorListItem { message: string; element: HTMLElement; } - interface ValidatorStatic - { + interface ValidatorStatic { /** * Add a compound class method - useful to refactor common combinations of rules into a single class. * @@ -236,8 +231,7 @@ declare namespace JQueryValidation methods: { [index: string]: Function }; } - interface Validator - { + interface Validator { element(element: string|JQuery): boolean; checkForm(): boolean; /** @@ -277,8 +271,7 @@ declare namespace JQueryValidation } } -interface JQuery -{ +interface JQuery { /** * Remove the specified attributes from the first matched element and return them. * @@ -288,7 +281,7 @@ interface JQuery // tslint:disable:unified-signatures /** * Adds the specified rules and returns all rules for the first matched element. Requires that the parent form is validated, that is, $( "form" ).validate() is called first. - * + * * @param command "remove" or "add" * @param rules The rules to add. Accepts the same format as the rules-option of the validate-method. */ @@ -317,8 +310,7 @@ interface JQuery validate(options?: JQueryValidation.ValidationOptions): JQueryValidation.Validator; } -interface JQueryStatic -{ +interface JQueryStatic { /** * Replaces {n} placeholders with arguments. * diff --git a/types/jquery.validation/jquery.validation-tests.ts b/types/jquery.validation/jquery.validation-tests.ts index 8d73db97d5..08bc439973 100644 --- a/types/jquery.validation/jquery.validation-tests.ts +++ b/types/jquery.validation/jquery.validation-tests.ts @@ -12,9 +12,9 @@ function test_validate() { }); $(".selector").validate({ invalidHandler: (form, validator) => { - var errors = validator.numberOfInvalids(); + const errors = validator.numberOfInvalids(); if (errors) { - var message = errors == 1 + const message = errors === 1 ? 'You missed 1 field. It has been highlighted' : 'You missed ' + errors + ' fields. They have been highlighted'; $("div.error span").html(message); @@ -55,8 +55,8 @@ function test_validate() { username: "fname lname" }, errorPlacement: (error, element) => { - if (element.attr("name") == "fname" - || element.attr("name") == "lname") + if (element.attr("name") === "fname" + || element.attr("name") === "lname") error.insertAfter("#lastname"); else error.insertAfter(element); @@ -97,7 +97,7 @@ function test_validate() { }); $("#myform").validate({ meta: "validate", - submitHandler: () => { alert("Submitted!") } + submitHandler: () => { alert("Submitted!"); } }); $(".selector").validate({ errorClass: "invalid" @@ -114,13 +114,13 @@ function test_validate() { $("#myform").validate({ errorLabelContainer: "#messageBox", wrapper: "li", - submitHandler: () => { alert("Submitted!") } + submitHandler: () => { alert("Submitted!"); } }); $("#myform").validate({ errorContainer: "#messageBox1, #messageBox2", errorLabelContainer: "#messageBox1 ul", wrapper: "li", debug: true, - submitHandler: () => { alert("Submitted!") } + submitHandler: () => { alert("Submitted!"); } }); $(".selector").validate({ showErrors: (errorMap: JQueryValidation.ErrorDictionary, errorList: JQueryValidation.ErrorListItem[]) => { @@ -136,13 +136,13 @@ function test_validate() { }); $("#myform").validate({ success: "valid", - submitHandler: () => { alert("Submitted!") } + submitHandler: () => { alert("Submitted!"); } }); $("#myform").validate({ success: (label) => { - label.addClass("valid").text("Ok!") + label.addClass("valid").text("Ok!"); }, - submitHandler: () => { alert("Submitted!") } + submitHandler: () => { alert("Submitted!"); } }); $(".selector").validate({ highlight: (element, errorClass) => { @@ -176,7 +176,7 @@ function test_validate() { $('.selector').validate({ onfocusout: () => {}, onkeyup: () => {}, - onclick: (elt) => { return 2; } + onclick: elt => 2, }); } @@ -205,7 +205,7 @@ function test_methods() { } }); $("#skip").click(() => { - var rules = $("#myinput").removeAttrs("min max"); + const rules = $("#myinput").removeAttrs("min max"); $("#myform").submit(); $("#myinput").attr(rules); }); @@ -213,25 +213,25 @@ function test_methods() { $("#myform").validate().form(); $("#myform").validate().element("#myselect"); $("#myform").validate().element($("#myselect")); - var validator = $("#myform").validate(); + const validator = $("#myform").validate(); validator.resetForm(); - validator.showErrors({ "firstname": "I know that your firstname is Pete, Pete!" }); + validator.showErrors({ firstname: "I know that your firstname is Pete, Pete!" }); validator.hideErrors(); - var isValid: boolean = validator.valid(); - var size: number = validator.size(); - var errorMap: JQueryValidation.ErrorDictionary = validator.errorMap; - var errorList: JQueryValidation.ErrorListItem[] = validator.errorList; + const isValid: boolean = validator.valid(); + const size: number = validator.size(); + const errorMap: JQueryValidation.ErrorDictionary = validator.errorMap; + const errorList: JQueryValidation.ErrorListItem[] = validator.errorList; $("#summary").text(validator.numberOfInvalids() + " field(s) are invalid"); - var invalidElements: HTMLElement[] = validator.invalidElements(); - var validElements: HTMLElement[] = validator.validElements(); + const invalidElements: HTMLElement[] = validator.invalidElements(); + const validElements: HTMLElement[] = validator.validElements(); } function test_static_methods() { jQuery.validator.setDefaults({ debug: true }); - jQuery.validator.addMethod("domain", function (value, element) { + jQuery.validator.addMethod("domain", function(value, element) { return this.optional(element) || /^http:\/\/mycorporatedomain.com/.test(value); }, "Please specify the correct domain for your documents"); jQuery.validator.addClassRules({ diff --git a/types/jquery.validation/tslint.json b/types/jquery.validation/tslint.json index f05741c59b..b0e7084e94 100644 --- a/types/jquery.validation/tslint.json +++ b/types/jquery.validation/tslint.json @@ -1,6 +1,6 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false + "ban-types": false } } diff --git a/types/js-data-http/index.d.ts b/types/js-data-http/index.d.ts index 2a2fafcedb..62a2c1e25b 100644 --- a/types/js-data-http/index.d.ts +++ b/types/js-data-http/index.d.ts @@ -7,9 +7,9 @@ import * as JSData from 'js-data'; declare module 'js-data' { interface DSHttpAdapterOptions { - serialize?: (resourceName: string, data: any) => any; - deserialize?: (resourceName: string, data: any) => any; - queryTransform?: (resourceName: string, params: DSFilterParams) => any; + serialize?(resourceName: string, data: any): any; + deserialize?(resourceName: string, data: any): any; + queryTransform?(resourceName: string, params: DSFilterParams): any; httpConfig?: any; forceTrailingSlash?: boolean; log?: boolean | ((message?: any, ...optionalParams: any[]) => void); diff --git a/types/js-data-http/tslint.json b/types/js-data-http/tslint.json index 394d3ce319..27b52dc1e1 100644 --- a/types/js-data-http/tslint.json +++ b/types/js-data-http/tslint.json @@ -1,7 +1,7 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false, + "ban-types": false, "no-misused-new": false } } diff --git a/types/jui-grid/index.d.ts b/types/jui-grid/index.d.ts index 31b3ca2b51..8ced2164e4 100644 --- a/types/jui-grid/index.d.ts +++ b/types/jui-grid/index.d.ts @@ -71,7 +71,7 @@ export interface GridRow { type: "open"|"fold"; /** @property {Function} [type="null"] State value that indicates whether a child row is shown or hidden. */ - tpl?: () => void; + tpl?(): void; setIndex(rownum: number|string): void; reload(columns: GridColumn[], seq: any, xssFilter: any): void; diff --git a/types/jui-grid/tslint.json b/types/jui-grid/tslint.json index f05741c59b..b0e7084e94 100644 --- a/types/jui-grid/tslint.json +++ b/types/jui-grid/tslint.json @@ -1,6 +1,6 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false + "ban-types": false } } diff --git a/types/koa-views/index.d.ts b/types/koa-views/index.d.ts index 5d9d88b647..c06be87dfb 100644 --- a/types/koa-views/index.d.ts +++ b/types/koa-views/index.d.ts @@ -23,11 +23,9 @@ =============================================== */ - import * as Koa from "koa"; declare function views(dir: string, opts?: { - /* * default extension for your views */ @@ -44,13 +42,11 @@ declare function views(dir: string, opts?: { * replace consolidate as default engine source */ engineSource?: any, - }): Koa.Middleware; declare namespace views { } export = views; - import * as koa from "koa"; declare module 'koa' { diff --git a/types/koa-views/koa-views-tests.ts b/types/koa-views/koa-views-tests.ts index f025f55d93..65d6be7e1f 100644 --- a/types/koa-views/koa-views-tests.ts +++ b/types/koa-views/koa-views-tests.ts @@ -16,4 +16,4 @@ app.use((ctx: Koa.Context) => { ctx.render('user', { user: 'John' }).then(() => console.log('done render call')); -}); \ No newline at end of file +}); diff --git a/types/koa-views/tslint.json b/types/koa-views/tslint.json index 0f47deabb4..3bfbe8c142 100644 --- a/types/koa-views/tslint.json +++ b/types/koa-views/tslint.json @@ -1,6 +1,6 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false + "ban-types": false } } \ No newline at end of file diff --git a/types/leaflet-curve/package.json b/types/leaflet-curve/package.json deleted file mode 100644 index 711ba15e43..0000000000 --- a/types/leaflet-curve/package.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "dependencies": { - "@types/leaflet": "^0.7" - } -} \ No newline at end of file diff --git a/types/leaflet-curve/tsconfig.json b/types/leaflet-curve/tsconfig.json index b093c40509..06ed09cdd1 100644 --- a/types/leaflet-curve/tsconfig.json +++ b/types/leaflet-curve/tsconfig.json @@ -9,6 +9,9 @@ "noImplicitThis": true, "strictNullChecks": false, "baseUrl": "../", + "typeRoots": [ + "../" + ], "types": [], "noEmit": true, "forceConsistentCasingInFileNames": true diff --git a/types/leaflet-editable/index.d.ts b/types/leaflet-editable/index.d.ts index 3d8c84d93f..f66b45a9b8 100644 --- a/types/leaflet-editable/index.d.ts +++ b/types/leaflet-editable/index.d.ts @@ -3,9 +3,9 @@ // Definitions by: Dominic Alie // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -/// +import * as Leaflet from "leaflet"; -declare namespace L { +declare global { namespace L { /** * Make geometries editable in Leaflet. * @@ -43,12 +43,12 @@ declare namespace L { /** * Layer used to store edit tools (vertex, line guide…). */ - editLayer?: L.LayerGroup; + editLayer?: Leaflet.LayerGroup; /** * Default layer used to store drawn features (marker, polyline…). */ - featuresLayer?: L.LayerGroup; + featuresLayer?: Leaflet.LayerGroup; /** * Class to be used as vertex, for path editing. @@ -104,20 +104,20 @@ declare namespace L { * Start drawing a polyline. If latlng is given, a first point will be added. In any case, continuing on user * click. If options is given, it will be passed to the polyline class constructor. */ - startPolyline(latLng?: LatLng, options?: L.PolylineOptions): L.Polyline; + startPolyline(latLng?: LatLng, options?: Leaflet.PolylineOptions): L.Polyline; /** * Start drawing a polygon. If latlng is given, a first point will be added. In any case, continuing on user * click. If options is given, it will be passed to the polygon class constructor. */ - startPolygon(latLng?: LatLng, options?: L.PolylineOptions): L.Polygon; + startPolygon(latLng?: LatLng, options?: Leaflet.PolylineOptions): L.Polygon; /** * Start adding a marker. If latlng is given, the marker will be shown first at this point. In any case, it * will follow the user mouse, and will have a final latlng on next click (or touch). If options is given, * it will be passed to the marker class constructor. */ - startMarker(latLng?: LatLng, options?: L.MarkerOptions): L.Marker; + startMarker(latLng?: LatLng, options?: Leaflet.MarkerOptions): L.Marker; /** * When you need to stop any ongoing drawing, without needing to know which editor is active. @@ -255,4 +255,4 @@ declare namespace L { export interface Polygon extends EditableMixin, PolygonEditor { } -} +} } diff --git a/types/leaflet-editable/leaflet-editable-tests.ts b/types/leaflet-editable/leaflet-editable-tests.ts index b8ff8744db..09728add47 100644 --- a/types/leaflet-editable/leaflet-editable-tests.ts +++ b/types/leaflet-editable/leaflet-editable-tests.ts @@ -1,4 +1,11 @@ - +class MarkerClass { } +class MarkerEditorClass { } +class MiddleMarkerClass { } +class PolygonClass { } +class PolygonEditorClass { } +class PolylineClass { } +class PolylineEditorClass { } +class VertexMarkerClass { } var map: L.Map = L.map('div', { editable: true, @@ -46,12 +53,3 @@ enabled = polygon.editEnabled(); polygon.newHole(L.latLng(0, 0)); polygon.reset(); polygon.toggleEdit(); - -class MarkerClass { } -class MarkerEditorClass { } -class MiddleMarkerClass { } -class PolygonClass { } -class PolygonEditorClass { } -class PolylineClass { } -class PolylineEditorClass { } -class VertexMarkerClass { } \ No newline at end of file diff --git a/types/leaflet-editable/package.json b/types/leaflet-editable/package.json deleted file mode 100644 index 711ba15e43..0000000000 --- a/types/leaflet-editable/package.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "dependencies": { - "@types/leaflet": "^0.7" - } -} \ No newline at end of file diff --git a/types/leaflet-editable/tsconfig.json b/types/leaflet-editable/tsconfig.json index 264f610f6e..4ae40d6774 100644 --- a/types/leaflet-editable/tsconfig.json +++ b/types/leaflet-editable/tsconfig.json @@ -9,7 +9,15 @@ "noImplicitThis": true, "strictNullChecks": false, "baseUrl": "../", + "typeRoots": [ + "../" + ], "types": [], + "paths": { + "leaflet": [ + "leaflet/v0" + ] + }, "noEmit": true, "forceConsistentCasingInFileNames": true }, diff --git a/types/leaflet-fullscreen/package.json b/types/leaflet-fullscreen/package.json deleted file mode 100644 index 8501cf4dbc..0000000000 --- a/types/leaflet-fullscreen/package.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "dependencies": { - "@types/leaflet": "^1.0.58" - } -} \ No newline at end of file diff --git a/types/leaflet-fullscreen/tsconfig.json b/types/leaflet-fullscreen/tsconfig.json index a47f7af1bd..0da8d35169 100644 --- a/types/leaflet-fullscreen/tsconfig.json +++ b/types/leaflet-fullscreen/tsconfig.json @@ -9,6 +9,9 @@ "noImplicitThis": true, "strictNullChecks": true, "baseUrl": "../", + "typeRoots": [ + "../" + ], "types": [], "noEmit": true, "forceConsistentCasingInFileNames": true diff --git a/types/leaflet-geocoder-mapzen/index.d.ts b/types/leaflet-geocoder-mapzen/index.d.ts index 934c67b563..390a751360 100644 --- a/types/leaflet-geocoder-mapzen/index.d.ts +++ b/types/leaflet-geocoder-mapzen/index.d.ts @@ -3,18 +3,18 @@ // Definitions by: Leonard Lausen // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -/// +import * as Leaflet from "leaflet"; -declare namespace L { +declare global { namespace L { namespace Control { - export interface GeocoderStatic extends ClassStatic { + export interface GeocoderStatic extends Leaflet.ClassStatic { /** * Creates a geocoder control. */ new (options?: GeocoderOptions): Geocoder; } - export interface Geocoder extends L.Control { + export interface Geocoder extends Leaflet.Control { } export interface GeocoderOptions { @@ -32,7 +32,7 @@ declare namespace L { * * Default value: false. */ - bounds?: LatLngBounds | boolean; + bounds?: Leaflet.LatLngBounds | boolean; /** * If true, search and autocomplete prioritizes results near the center @@ -42,7 +42,7 @@ declare namespace L { * * Default value: 'true'. */ - focus?: LatLng | boolean; + focus?: Leaflet.LatLng | boolean; /** * Filters results by layers (documentation). @@ -77,7 +77,7 @@ declare namespace L { * * Default value: 'topleft'. */ - position?: L.PositionString; + position?: Leaflet.PositionString; /** * Attribution text to include. @@ -126,7 +126,7 @@ declare namespace L { * * Default value: true */ - markers?: MarkerOptions | boolean; + markers?: Leaflet.MarkerOptions | boolean; /** * If true, the input box will expand to take up the full width of the map container. @@ -173,4 +173,4 @@ declare namespace L { */ export function geocoder(api_key: string, options?: Control.GeocoderOptions): L.Control.Geocoder; } -} +} } diff --git a/types/leaflet-geocoder-mapzen/package.json b/types/leaflet-geocoder-mapzen/package.json deleted file mode 100644 index 711ba15e43..0000000000 --- a/types/leaflet-geocoder-mapzen/package.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "dependencies": { - "@types/leaflet": "^0.7" - } -} \ No newline at end of file diff --git a/types/leaflet-geocoder-mapzen/tsconfig.json b/types/leaflet-geocoder-mapzen/tsconfig.json index 1737c5b81c..b5786e4cda 100644 --- a/types/leaflet-geocoder-mapzen/tsconfig.json +++ b/types/leaflet-geocoder-mapzen/tsconfig.json @@ -9,7 +9,15 @@ "noImplicitThis": true, "strictNullChecks": false, "baseUrl": "../", + "typeRoots": [ + "../" + ], "types": [], + "paths": { + "leaflet": [ + "leaflet/v0" + ] + }, "noEmit": true, "forceConsistentCasingInFileNames": true }, diff --git a/types/leaflet-label/index.d.ts b/types/leaflet-label/index.d.ts index da3fafd1a1..e1e96b717a 100644 --- a/types/leaflet-label/index.d.ts +++ b/types/leaflet-label/index.d.ts @@ -3,7 +3,7 @@ // Definitions by: Wim Looman // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -/// +import * as Leaflet from "leaflet"; declare global { namespace L { diff --git a/types/leaflet-label/package.json b/types/leaflet-label/package.json deleted file mode 100644 index 711ba15e43..0000000000 --- a/types/leaflet-label/package.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "dependencies": { - "@types/leaflet": "^0.7" - } -} \ No newline at end of file diff --git a/types/leaflet-label/tsconfig.json b/types/leaflet-label/tsconfig.json index c9232660a0..a3e17b8d51 100644 --- a/types/leaflet-label/tsconfig.json +++ b/types/leaflet-label/tsconfig.json @@ -9,7 +9,15 @@ "noImplicitThis": true, "strictNullChecks": false, "baseUrl": "../", + "typeRoots": [ + "../" + ], "types": [], + "paths": { + "leaflet": [ + "leaflet/v0" + ] + }, "noEmit": true, "forceConsistentCasingInFileNames": true }, diff --git a/types/leaflet-markercluster/package.json b/types/leaflet-markercluster/package.json deleted file mode 100644 index b06daabe04..0000000000 --- a/types/leaflet-markercluster/package.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "dependencies": { - "@types/leaflet": "^1.0" - } -} \ No newline at end of file diff --git a/types/leaflet.awesome-markers/index.d.ts b/types/leaflet.awesome-markers/index.d.ts index 1c2762f672..ee6b65eaa4 100644 --- a/types/leaflet.awesome-markers/index.d.ts +++ b/types/leaflet.awesome-markers/index.d.ts @@ -3,15 +3,15 @@ // Definitions by: Egor Komarov // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -/// +import * as Leaflet from "leaflet"; -declare module L { +declare global { namespace L { module AwesomeMarkers { var version: string; function icon(options: AwesomeMarkers.IconOptions): AwesomeMarkers.Icon; - interface IconStatic extends L.IconStatic { + interface IconStatic extends Leaflet.IconStatic { /** * Creates an icon instance with the given options. */ @@ -27,11 +27,11 @@ declare module L { }; } - interface Icon extends L.Icon { + interface Icon extends Leaflet.Icon { options: AwesomeMarkers.IconOptions; } - interface IconOptions extends L.IconOptions { + interface IconOptions extends Leaflet.IconOptions { /** * Name of the icon. See glyphicons or font-awesome. */ @@ -65,4 +65,4 @@ declare module L { var Icon: AwesomeMarkers.IconStatic; } -} +} } diff --git a/types/leaflet.awesome-markers/package.json b/types/leaflet.awesome-markers/package.json deleted file mode 100644 index 711ba15e43..0000000000 --- a/types/leaflet.awesome-markers/package.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "dependencies": { - "@types/leaflet": "^0.7" - } -} \ No newline at end of file diff --git a/types/leaflet.awesome-markers/tsconfig.json b/types/leaflet.awesome-markers/tsconfig.json index a58d69863e..74df02c260 100644 --- a/types/leaflet.awesome-markers/tsconfig.json +++ b/types/leaflet.awesome-markers/tsconfig.json @@ -9,7 +9,15 @@ "noImplicitThis": true, "strictNullChecks": false, "baseUrl": "../", + "typeRoots": [ + "../" + ], "types": [], + "paths": { + "leaflet": [ + "leaflet/v0" + ] + }, "noEmit": true, "forceConsistentCasingInFileNames": true }, diff --git a/types/leaflet.fullscreen/package.json b/types/leaflet.fullscreen/package.json deleted file mode 100644 index 711ba15e43..0000000000 --- a/types/leaflet.fullscreen/package.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "dependencies": { - "@types/leaflet": "^0.7" - } -} \ No newline at end of file diff --git a/types/leaflet.fullscreen/tsconfig.json b/types/leaflet.fullscreen/tsconfig.json index c877e598cf..3ca1cc4de7 100644 --- a/types/leaflet.fullscreen/tsconfig.json +++ b/types/leaflet.fullscreen/tsconfig.json @@ -9,6 +9,9 @@ "noImplicitThis": true, "strictNullChecks": false, "baseUrl": "../", + "typeRoots": [ + "../" + ], "types": [], "noEmit": true, "forceConsistentCasingInFileNames": true diff --git a/types/leaflet.locatecontrol/package.json b/types/leaflet.locatecontrol/package.json deleted file mode 100644 index 8afe476d51..0000000000 --- a/types/leaflet.locatecontrol/package.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "dependencies": { - "@types/leaflet": "^1.0.58" - } -} diff --git a/types/leaflet.locatecontrol/tsconfig.json b/types/leaflet.locatecontrol/tsconfig.json index 0637d48285..0ccab11228 100644 --- a/types/leaflet.locatecontrol/tsconfig.json +++ b/types/leaflet.locatecontrol/tsconfig.json @@ -9,6 +9,9 @@ "noImplicitThis": true, "strictNullChecks": true, "baseUrl": "../", + "typeRoots": [ + "../" + ], "types": [], "noEmit": true, "forceConsistentCasingInFileNames": true diff --git a/types/libpq/tslint.json b/types/libpq/tslint.json index f05741c59b..b0e7084e94 100644 --- a/types/libpq/tslint.json +++ b/types/libpq/tslint.json @@ -1,6 +1,6 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false + "ban-types": false } } diff --git a/types/linkify-it/index.d.ts b/types/linkify-it/index.d.ts new file mode 100644 index 0000000000..00b564bff6 --- /dev/null +++ b/types/linkify-it/index.d.ts @@ -0,0 +1,50 @@ +// Type definitions for tweezer.js 2.0 +// Project: https://github.com/markdown-it/linkify-it +// Definitions by: Lindsey Smith , Robert Coie +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare const LinkifyIt: { + (schemas?: LinkifyIt.SchemaRules, options?: LinkifyIt.Options): LinkifyIt.LinkifyIt; + new (schemas?: LinkifyIt.SchemaRules, options?: LinkifyIt.Options): LinkifyIt.LinkifyIt; +}; + +declare namespace LinkifyIt { + export interface FullRule { + validate: (text: string, pos: number, self: LinkifyIt) => number; + normalize?: (match: string) => string; + } + + export type Rule = string | RegExp | FullRule; + + export interface SchemaRules { + [schema: string]: Rule; + } + + export interface Options { + fuzzyLink?: boolean; + fuzzyIP?: boolean; + fuzzyEmail?: boolean; + } + + export interface Match { + index: number; + lastIndex: number; + raw: string; + schema: string; + text: string; + url: string; + } + + export interface LinkifyIt { + add(schema: string, rule: Rule): LinkifyIt; + match(text: string): Match[]; + normalize(raw: string): string; + pretest(text: string): boolean; + set(options: Options): LinkifyIt; + test(text: string): boolean; + testSchemaAt(text: string, schemaName: string, pos: number): number; + tlds(list: string | string[], keepOld?: boolean): LinkifyIt; + } +} + +export = LinkifyIt; diff --git a/types/linkify-it/linkify-it-tests.ts b/types/linkify-it/linkify-it-tests.ts new file mode 100644 index 0000000000..c4366321cf --- /dev/null +++ b/types/linkify-it/linkify-it-tests.ts @@ -0,0 +1,24 @@ +import LinkifyIt = require('linkify-it'); + +// fluent interface +const linkifier = new LinkifyIt(); + +linkifier + .add('git:', 'http:') + .set({ fuzzyIP: true }) + .tlds('onion', true) + .test("https://github.com/DefinitelyTyped/DefinitelyTyped/"); + +// match +const matches = linkifier.match("https://github.com/DefinitelyTyped/DefinitelyTyped/"); +matches.forEach(({index, lastIndex, raw, schema, text, url}) => {}); + +// complex rule +linkifier.add('@', { + validate: (text, pos, self) => { + return 42; + }, + normalize: (match) => { + return 'forty-two'; + } +}); diff --git a/types/linkify-it/tsconfig.json b/types/linkify-it/tsconfig.json new file mode 100644 index 0000000000..d773912f34 --- /dev/null +++ b/types/linkify-it/tsconfig.json @@ -0,0 +1,22 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "linkify-it-tests.ts" + ] +} diff --git a/react-onsenui/tslint.json b/types/linkify-it/tslint.json similarity index 100% rename from react-onsenui/tslint.json rename to types/linkify-it/tslint.json diff --git a/types/lodash/add/index.d.ts b/types/lodash/add/index.d.ts index f6b8ffe169..bfe1d46805 100644 --- a/types/lodash/add/index.d.ts +++ b/types/lodash/add/index.d.ts @@ -1,2 +1,2 @@ import { add } from "../index"; -export = add; \ No newline at end of file +export = add; diff --git a/types/lodash/after/index.d.ts b/types/lodash/after/index.d.ts index 646ac91611..eea017f6fd 100644 --- a/types/lodash/after/index.d.ts +++ b/types/lodash/after/index.d.ts @@ -1,2 +1,2 @@ import { after } from "../index"; -export = after; \ No newline at end of file +export = after; diff --git a/types/lodash/ary/index.d.ts b/types/lodash/ary/index.d.ts index c5281575ea..2b86cf6d4e 100644 --- a/types/lodash/ary/index.d.ts +++ b/types/lodash/ary/index.d.ts @@ -1,2 +1,2 @@ import { ary } from "../index"; -export = ary; \ No newline at end of file +export = ary; diff --git a/types/lodash/assign/index.d.ts b/types/lodash/assign/index.d.ts index 204edbb182..b38bbc5bb6 100644 --- a/types/lodash/assign/index.d.ts +++ b/types/lodash/assign/index.d.ts @@ -1,2 +1,2 @@ import { assign } from "../index"; -export = assign; \ No newline at end of file +export = assign; diff --git a/types/lodash/assignIn/index.d.ts b/types/lodash/assignIn/index.d.ts index da3f4f123b..2f182e7e90 100644 --- a/types/lodash/assignIn/index.d.ts +++ b/types/lodash/assignIn/index.d.ts @@ -1,2 +1,2 @@ import { assignIn } from "../index"; -export = assignIn; \ No newline at end of file +export = assignIn; diff --git a/types/lodash/assignInWith/index.d.ts b/types/lodash/assignInWith/index.d.ts index 1159a8d998..5b092fa13c 100644 --- a/types/lodash/assignInWith/index.d.ts +++ b/types/lodash/assignInWith/index.d.ts @@ -1,2 +1,2 @@ import { assignInWith } from "../index"; -export = assignInWith; \ No newline at end of file +export = assignInWith; diff --git a/types/lodash/assignWith/index.d.ts b/types/lodash/assignWith/index.d.ts index 29c0c36681..9424c4e75a 100644 --- a/types/lodash/assignWith/index.d.ts +++ b/types/lodash/assignWith/index.d.ts @@ -1,2 +1,2 @@ import { assignWith } from "../index"; -export = assignWith; \ No newline at end of file +export = assignWith; diff --git a/types/lodash/at/index.d.ts b/types/lodash/at/index.d.ts index e613328596..fc009ef6c8 100644 --- a/types/lodash/at/index.d.ts +++ b/types/lodash/at/index.d.ts @@ -1,2 +1,2 @@ import { at } from "../index"; -export = at; \ No newline at end of file +export = at; diff --git a/types/lodash/attempt/index.d.ts b/types/lodash/attempt/index.d.ts index 26849500cb..991d4605cf 100644 --- a/types/lodash/attempt/index.d.ts +++ b/types/lodash/attempt/index.d.ts @@ -1,2 +1,2 @@ import { attempt } from "../index"; -export = attempt; \ No newline at end of file +export = attempt; diff --git a/types/lodash/before/index.d.ts b/types/lodash/before/index.d.ts index 6595204ea2..c9ccdbbb41 100644 --- a/types/lodash/before/index.d.ts +++ b/types/lodash/before/index.d.ts @@ -1,2 +1,2 @@ import { before } from "../index"; -export = before; \ No newline at end of file +export = before; diff --git a/types/lodash/bind/index.d.ts b/types/lodash/bind/index.d.ts index 61ac4bb6fd..bfae1efa26 100644 --- a/types/lodash/bind/index.d.ts +++ b/types/lodash/bind/index.d.ts @@ -1,2 +1,2 @@ import { bind } from "../index"; -export = bind; \ No newline at end of file +export = bind; diff --git a/types/lodash/bindAll/index.d.ts b/types/lodash/bindAll/index.d.ts index 4b54d76b2e..90b7f67bcc 100644 --- a/types/lodash/bindAll/index.d.ts +++ b/types/lodash/bindAll/index.d.ts @@ -1,2 +1,2 @@ import { bindAll } from "../index"; -export = bindAll; \ No newline at end of file +export = bindAll; diff --git a/types/lodash/bindKey/index.d.ts b/types/lodash/bindKey/index.d.ts index d5c6217cc0..711b02f0e1 100644 --- a/types/lodash/bindKey/index.d.ts +++ b/types/lodash/bindKey/index.d.ts @@ -1,2 +1,2 @@ import { bindKey } from "../index"; -export = bindKey; \ No newline at end of file +export = bindKey; diff --git a/types/lodash/camelCase/index.d.ts b/types/lodash/camelCase/index.d.ts index 8dbf939e8a..99cc4f8b36 100644 --- a/types/lodash/camelCase/index.d.ts +++ b/types/lodash/camelCase/index.d.ts @@ -1,2 +1,2 @@ import { camelCase } from "../index"; -export = camelCase; \ No newline at end of file +export = camelCase; diff --git a/types/lodash/capitalize/index.d.ts b/types/lodash/capitalize/index.d.ts index c8da4286b7..035d00ce94 100644 --- a/types/lodash/capitalize/index.d.ts +++ b/types/lodash/capitalize/index.d.ts @@ -1,2 +1,2 @@ import { capitalize } from "../index"; -export = capitalize; \ No newline at end of file +export = capitalize; diff --git a/types/lodash/castArray/index.d.ts b/types/lodash/castArray/index.d.ts index 6b508b8a98..f278e73a40 100644 --- a/types/lodash/castArray/index.d.ts +++ b/types/lodash/castArray/index.d.ts @@ -1,2 +1,2 @@ import { castArray } from "../index"; -export = castArray; \ No newline at end of file +export = castArray; diff --git a/types/lodash/ceil/index.d.ts b/types/lodash/ceil/index.d.ts index 5e048b3d1d..732861a411 100644 --- a/types/lodash/ceil/index.d.ts +++ b/types/lodash/ceil/index.d.ts @@ -1,2 +1,2 @@ import { ceil } from "../index"; -export = ceil; \ No newline at end of file +export = ceil; diff --git a/types/lodash/chain/index.d.ts b/types/lodash/chain/index.d.ts index 4b73db1c6c..2be62c817e 100644 --- a/types/lodash/chain/index.d.ts +++ b/types/lodash/chain/index.d.ts @@ -1,2 +1,2 @@ import { chain } from "../index"; -export = chain; \ No newline at end of file +export = chain; diff --git a/types/lodash/chunk/index.d.ts b/types/lodash/chunk/index.d.ts index 732721395b..27254c0cce 100644 --- a/types/lodash/chunk/index.d.ts +++ b/types/lodash/chunk/index.d.ts @@ -1,2 +1,2 @@ import { chunk } from "../index"; -export = chunk; \ No newline at end of file +export = chunk; diff --git a/types/lodash/clamp/index.d.ts b/types/lodash/clamp/index.d.ts index 4d42abd905..a14ebc3edd 100644 --- a/types/lodash/clamp/index.d.ts +++ b/types/lodash/clamp/index.d.ts @@ -1,2 +1,2 @@ import { clamp } from "../index"; -export = clamp; \ No newline at end of file +export = clamp; diff --git a/types/lodash/clone/index.d.ts b/types/lodash/clone/index.d.ts index ba68623796..7ec6d46f62 100644 --- a/types/lodash/clone/index.d.ts +++ b/types/lodash/clone/index.d.ts @@ -1,2 +1,2 @@ import { clone } from "../index"; -export = clone; \ No newline at end of file +export = clone; diff --git a/types/lodash/cloneDeep/index.d.ts b/types/lodash/cloneDeep/index.d.ts index 4e416a08f7..7ec0d7cc22 100644 --- a/types/lodash/cloneDeep/index.d.ts +++ b/types/lodash/cloneDeep/index.d.ts @@ -1,2 +1,2 @@ import { cloneDeep } from "../index"; -export = cloneDeep; \ No newline at end of file +export = cloneDeep; diff --git a/types/lodash/cloneDeepWith/index.d.ts b/types/lodash/cloneDeepWith/index.d.ts index 795155856f..387559395b 100644 --- a/types/lodash/cloneDeepWith/index.d.ts +++ b/types/lodash/cloneDeepWith/index.d.ts @@ -1,2 +1,2 @@ import { cloneDeepWith } from "../index"; -export = cloneDeepWith; \ No newline at end of file +export = cloneDeepWith; diff --git a/types/lodash/cloneWith/index.d.ts b/types/lodash/cloneWith/index.d.ts index d1fa9863cd..070f583fc7 100644 --- a/types/lodash/cloneWith/index.d.ts +++ b/types/lodash/cloneWith/index.d.ts @@ -1,2 +1,2 @@ import { cloneWith } from "../index"; -export = cloneWith; \ No newline at end of file +export = cloneWith; diff --git a/types/lodash/compact/index.d.ts b/types/lodash/compact/index.d.ts index 9d7b1fade1..e1617e88da 100644 --- a/types/lodash/compact/index.d.ts +++ b/types/lodash/compact/index.d.ts @@ -1,2 +1,2 @@ import { compact } from "../index"; -export = compact; \ No newline at end of file +export = compact; diff --git a/types/lodash/concat/index.d.ts b/types/lodash/concat/index.d.ts index 26e6c184cc..309b54cc8f 100644 --- a/types/lodash/concat/index.d.ts +++ b/types/lodash/concat/index.d.ts @@ -1,2 +1,2 @@ import { concat } from "../index"; -export = concat; \ No newline at end of file +export = concat; diff --git a/types/lodash/constant/index.d.ts b/types/lodash/constant/index.d.ts index 16adcbe902..e812062c91 100644 --- a/types/lodash/constant/index.d.ts +++ b/types/lodash/constant/index.d.ts @@ -1,2 +1,2 @@ import { constant } from "../index"; -export = constant; \ No newline at end of file +export = constant; diff --git a/types/lodash/countBy/index.d.ts b/types/lodash/countBy/index.d.ts index 062ea86901..d44affd3b1 100644 --- a/types/lodash/countBy/index.d.ts +++ b/types/lodash/countBy/index.d.ts @@ -1,2 +1,2 @@ import { countBy } from "../index"; -export = countBy; \ No newline at end of file +export = countBy; diff --git a/types/lodash/create/index.d.ts b/types/lodash/create/index.d.ts index 4040edabf3..54cec6e4cb 100644 --- a/types/lodash/create/index.d.ts +++ b/types/lodash/create/index.d.ts @@ -1,2 +1,2 @@ import { create } from "../index"; -export = create; \ No newline at end of file +export = create; diff --git a/types/lodash/curry/index.d.ts b/types/lodash/curry/index.d.ts index b5132423ba..a6ab8c799c 100644 --- a/types/lodash/curry/index.d.ts +++ b/types/lodash/curry/index.d.ts @@ -1,2 +1,2 @@ import { curry } from "../index"; -export = curry; \ No newline at end of file +export = curry; diff --git a/types/lodash/curryRight/index.d.ts b/types/lodash/curryRight/index.d.ts index 999330fa63..c179a26dbd 100644 --- a/types/lodash/curryRight/index.d.ts +++ b/types/lodash/curryRight/index.d.ts @@ -1,2 +1,2 @@ import { curryRight } from "../index"; -export = curryRight; \ No newline at end of file +export = curryRight; diff --git a/types/lodash/debounce/index.d.ts b/types/lodash/debounce/index.d.ts index 2817fce4e1..98fc36743a 100644 --- a/types/lodash/debounce/index.d.ts +++ b/types/lodash/debounce/index.d.ts @@ -1,2 +1,2 @@ import { debounce } from "../index"; -export = debounce; \ No newline at end of file +export = debounce; diff --git a/types/lodash/deburr/index.d.ts b/types/lodash/deburr/index.d.ts index 8bcee7b151..4b5fdbf028 100644 --- a/types/lodash/deburr/index.d.ts +++ b/types/lodash/deburr/index.d.ts @@ -1,2 +1,2 @@ import { deburr } from "../index"; -export = deburr; \ No newline at end of file +export = deburr; diff --git a/types/lodash/defaults/index.d.ts b/types/lodash/defaults/index.d.ts index 9a93890329..c80d5d318d 100644 --- a/types/lodash/defaults/index.d.ts +++ b/types/lodash/defaults/index.d.ts @@ -1,2 +1,2 @@ import { defaults } from "../index"; -export = defaults; \ No newline at end of file +export = defaults; diff --git a/types/lodash/defaultsDeep/index.d.ts b/types/lodash/defaultsDeep/index.d.ts index 35ca6cc3bc..5ee0aa1854 100644 --- a/types/lodash/defaultsDeep/index.d.ts +++ b/types/lodash/defaultsDeep/index.d.ts @@ -1,2 +1,2 @@ import { defaultsDeep } from "../index"; -export = defaultsDeep; \ No newline at end of file +export = defaultsDeep; diff --git a/types/lodash/defer/index.d.ts b/types/lodash/defer/index.d.ts index a3dab9837a..4e0bffe6d0 100644 --- a/types/lodash/defer/index.d.ts +++ b/types/lodash/defer/index.d.ts @@ -1,2 +1,2 @@ import { defer } from "../index"; -export = defer; \ No newline at end of file +export = defer; diff --git a/types/lodash/delay/index.d.ts b/types/lodash/delay/index.d.ts index e5569f3b67..1aecd0124c 100644 --- a/types/lodash/delay/index.d.ts +++ b/types/lodash/delay/index.d.ts @@ -1,2 +1,2 @@ import { delay } from "../index"; -export = delay; \ No newline at end of file +export = delay; diff --git a/types/lodash/difference/index.d.ts b/types/lodash/difference/index.d.ts index 2d9e1d1569..f188c1695c 100644 --- a/types/lodash/difference/index.d.ts +++ b/types/lodash/difference/index.d.ts @@ -1,2 +1,2 @@ import { difference } from "../index"; -export = difference; \ No newline at end of file +export = difference; diff --git a/types/lodash/differenceBy/index.d.ts b/types/lodash/differenceBy/index.d.ts index 35cc4325ad..fc4fbb97cd 100644 --- a/types/lodash/differenceBy/index.d.ts +++ b/types/lodash/differenceBy/index.d.ts @@ -1,2 +1,2 @@ import { differenceBy } from "../index"; -export = differenceBy; \ No newline at end of file +export = differenceBy; diff --git a/types/lodash/differenceWith/index.d.ts b/types/lodash/differenceWith/index.d.ts index 37fe7fd014..c13a1a5356 100644 --- a/types/lodash/differenceWith/index.d.ts +++ b/types/lodash/differenceWith/index.d.ts @@ -1,2 +1,2 @@ import { differenceWith } from "../index"; -export = differenceWith; \ No newline at end of file +export = differenceWith; diff --git a/types/lodash/drop/index.d.ts b/types/lodash/drop/index.d.ts index b6e3653747..a20de1c85e 100644 --- a/types/lodash/drop/index.d.ts +++ b/types/lodash/drop/index.d.ts @@ -1,2 +1,2 @@ import { drop } from "../index"; -export = drop; \ No newline at end of file +export = drop; diff --git a/types/lodash/dropRight/index.d.ts b/types/lodash/dropRight/index.d.ts index 12d8f9a466..eddbac88af 100644 --- a/types/lodash/dropRight/index.d.ts +++ b/types/lodash/dropRight/index.d.ts @@ -1,2 +1,2 @@ import { dropRight } from "../index"; -export = dropRight; \ No newline at end of file +export = dropRight; diff --git a/types/lodash/dropRightWhile/index.d.ts b/types/lodash/dropRightWhile/index.d.ts index 913a3d2264..e7b0bb4855 100644 --- a/types/lodash/dropRightWhile/index.d.ts +++ b/types/lodash/dropRightWhile/index.d.ts @@ -1,2 +1,2 @@ import { dropRightWhile } from "../index"; -export = dropRightWhile; \ No newline at end of file +export = dropRightWhile; diff --git a/types/lodash/dropWhile/index.d.ts b/types/lodash/dropWhile/index.d.ts index 758a605fd7..4ffa087cc5 100644 --- a/types/lodash/dropWhile/index.d.ts +++ b/types/lodash/dropWhile/index.d.ts @@ -1,2 +1,2 @@ import { dropWhile } from "../index"; -export = dropWhile; \ No newline at end of file +export = dropWhile; diff --git a/types/lodash/each/index.d.ts b/types/lodash/each/index.d.ts index f7408a03ba..4a6ea0af51 100644 --- a/types/lodash/each/index.d.ts +++ b/types/lodash/each/index.d.ts @@ -1,2 +1,2 @@ import { each } from "../index"; -export = each; \ No newline at end of file +export = each; diff --git a/types/lodash/eachRight/index.d.ts b/types/lodash/eachRight/index.d.ts index 976747a4fe..2e04a5c9f8 100644 --- a/types/lodash/eachRight/index.d.ts +++ b/types/lodash/eachRight/index.d.ts @@ -1,2 +1,2 @@ import { eachRight } from "../index"; -export = eachRight; \ No newline at end of file +export = eachRight; diff --git a/types/lodash/endsWith/index.d.ts b/types/lodash/endsWith/index.d.ts index 96a03e5e2d..6fb61e7f4b 100644 --- a/types/lodash/endsWith/index.d.ts +++ b/types/lodash/endsWith/index.d.ts @@ -1,2 +1,2 @@ import { endsWith } from "../index"; -export = endsWith; \ No newline at end of file +export = endsWith; diff --git a/types/lodash/eq/index.d.ts b/types/lodash/eq/index.d.ts index 70fc8dcc9b..87d4de60ed 100644 --- a/types/lodash/eq/index.d.ts +++ b/types/lodash/eq/index.d.ts @@ -1,2 +1,2 @@ import { eq } from "../index"; -export = eq; \ No newline at end of file +export = eq; diff --git a/types/lodash/escape/index.d.ts b/types/lodash/escape/index.d.ts index 462727c1dd..3766a06712 100644 --- a/types/lodash/escape/index.d.ts +++ b/types/lodash/escape/index.d.ts @@ -1,2 +1,2 @@ import { escape } from "../index"; -export = escape; \ No newline at end of file +export = escape; diff --git a/types/lodash/escapeRegExp/index.d.ts b/types/lodash/escapeRegExp/index.d.ts index edd6c1f5f2..6419043fb3 100644 --- a/types/lodash/escapeRegExp/index.d.ts +++ b/types/lodash/escapeRegExp/index.d.ts @@ -1,2 +1,2 @@ import { escapeRegExp } from "../index"; -export = escapeRegExp; \ No newline at end of file +export = escapeRegExp; diff --git a/types/lodash/every/index.d.ts b/types/lodash/every/index.d.ts index 71a4c3d65b..a6cc43aa14 100644 --- a/types/lodash/every/index.d.ts +++ b/types/lodash/every/index.d.ts @@ -1,2 +1,2 @@ import { every } from "../index"; -export = every; \ No newline at end of file +export = every; diff --git a/types/lodash/extend/index.d.ts b/types/lodash/extend/index.d.ts index d86ec7d7b3..0f46cd5b85 100644 --- a/types/lodash/extend/index.d.ts +++ b/types/lodash/extend/index.d.ts @@ -1,2 +1,2 @@ import { extend } from "../index"; -export = extend; \ No newline at end of file +export = extend; diff --git a/types/lodash/extendWith/index.d.ts b/types/lodash/extendWith/index.d.ts index c4c3383e12..0274ebff23 100644 --- a/types/lodash/extendWith/index.d.ts +++ b/types/lodash/extendWith/index.d.ts @@ -1,2 +1,2 @@ import { extendWith } from "../index"; -export = extendWith; \ No newline at end of file +export = extendWith; diff --git a/types/lodash/fill/index.d.ts b/types/lodash/fill/index.d.ts index 06cade9a02..06dc85a9d9 100644 --- a/types/lodash/fill/index.d.ts +++ b/types/lodash/fill/index.d.ts @@ -1,2 +1,2 @@ import { fill } from "../index"; -export = fill; \ No newline at end of file +export = fill; diff --git a/types/lodash/filter/index.d.ts b/types/lodash/filter/index.d.ts index 164a9ccfa5..0b257c4dfc 100644 --- a/types/lodash/filter/index.d.ts +++ b/types/lodash/filter/index.d.ts @@ -1,2 +1,2 @@ import { filter } from "../index"; -export = filter; \ No newline at end of file +export = filter; diff --git a/types/lodash/find/index.d.ts b/types/lodash/find/index.d.ts index 6a22162c86..5dacac0168 100644 --- a/types/lodash/find/index.d.ts +++ b/types/lodash/find/index.d.ts @@ -1,2 +1,2 @@ import { find } from "../index"; -export = find; \ No newline at end of file +export = find; diff --git a/types/lodash/findIndex/index.d.ts b/types/lodash/findIndex/index.d.ts index e716bfd130..3c973bdfc5 100644 --- a/types/lodash/findIndex/index.d.ts +++ b/types/lodash/findIndex/index.d.ts @@ -1,2 +1,2 @@ import { findIndex } from "../index"; -export = findIndex; \ No newline at end of file +export = findIndex; diff --git a/types/lodash/findKey/index.d.ts b/types/lodash/findKey/index.d.ts index 503e047fb5..faca19e1cc 100644 --- a/types/lodash/findKey/index.d.ts +++ b/types/lodash/findKey/index.d.ts @@ -1,2 +1,2 @@ import { findKey } from "../index"; -export = findKey; \ No newline at end of file +export = findKey; diff --git a/types/lodash/findLast/index.d.ts b/types/lodash/findLast/index.d.ts index 91e5b6a3d9..f4f896790c 100644 --- a/types/lodash/findLast/index.d.ts +++ b/types/lodash/findLast/index.d.ts @@ -1,2 +1,2 @@ import { findLast } from "../index"; -export = findLast; \ No newline at end of file +export = findLast; diff --git a/types/lodash/findLastIndex/index.d.ts b/types/lodash/findLastIndex/index.d.ts index 8a24b5e8c3..122be1450f 100644 --- a/types/lodash/findLastIndex/index.d.ts +++ b/types/lodash/findLastIndex/index.d.ts @@ -1,2 +1,2 @@ import { findLastIndex } from "../index"; -export = findLastIndex; \ No newline at end of file +export = findLastIndex; diff --git a/types/lodash/findLastKey/index.d.ts b/types/lodash/findLastKey/index.d.ts index ce65fa5b51..52d9f8adde 100644 --- a/types/lodash/findLastKey/index.d.ts +++ b/types/lodash/findLastKey/index.d.ts @@ -1,2 +1,2 @@ import { findLastKey } from "../index"; -export = findLastKey; \ No newline at end of file +export = findLastKey; diff --git a/types/lodash/first/index.d.ts b/types/lodash/first/index.d.ts index cb8d284bf2..b743ed962d 100644 --- a/types/lodash/first/index.d.ts +++ b/types/lodash/first/index.d.ts @@ -1,2 +1,2 @@ import { first } from "../index"; -export = first; \ No newline at end of file +export = first; diff --git a/types/lodash/flatMap/index.d.ts b/types/lodash/flatMap/index.d.ts index 7d7f65be20..7ac8502c20 100644 --- a/types/lodash/flatMap/index.d.ts +++ b/types/lodash/flatMap/index.d.ts @@ -1,2 +1,2 @@ import { flatMap } from "../index"; -export = flatMap; \ No newline at end of file +export = flatMap; diff --git a/types/lodash/flatten/index.d.ts b/types/lodash/flatten/index.d.ts index 33f1490358..708c89ad86 100644 --- a/types/lodash/flatten/index.d.ts +++ b/types/lodash/flatten/index.d.ts @@ -1,2 +1,2 @@ import { flatten } from "../index"; -export = flatten; \ No newline at end of file +export = flatten; diff --git a/types/lodash/flattenDeep/index.d.ts b/types/lodash/flattenDeep/index.d.ts index 7da0a2b110..8bf39277bd 100644 --- a/types/lodash/flattenDeep/index.d.ts +++ b/types/lodash/flattenDeep/index.d.ts @@ -1,2 +1,2 @@ import { flattenDeep } from "../index"; -export = flattenDeep; \ No newline at end of file +export = flattenDeep; diff --git a/types/lodash/flattenDepth/index.d.ts b/types/lodash/flattenDepth/index.d.ts index 0a619cc924..38491c47fe 100644 --- a/types/lodash/flattenDepth/index.d.ts +++ b/types/lodash/flattenDepth/index.d.ts @@ -1,2 +1,2 @@ import { flattenDepth } from "../index"; -export = flattenDepth; \ No newline at end of file +export = flattenDepth; diff --git a/types/lodash/flip/index.d.ts b/types/lodash/flip/index.d.ts index b13716ca19..e5fd68e0e8 100644 --- a/types/lodash/flip/index.d.ts +++ b/types/lodash/flip/index.d.ts @@ -1,2 +1,2 @@ import { flip } from "../index"; -export = flip; \ No newline at end of file +export = flip; diff --git a/types/lodash/floor/index.d.ts b/types/lodash/floor/index.d.ts index 39e00a9eee..da725ee51d 100644 --- a/types/lodash/floor/index.d.ts +++ b/types/lodash/floor/index.d.ts @@ -1,2 +1,2 @@ import { floor } from "../index"; -export = floor; \ No newline at end of file +export = floor; diff --git a/types/lodash/flow/index.d.ts b/types/lodash/flow/index.d.ts index 681601a616..31bd309be5 100644 --- a/types/lodash/flow/index.d.ts +++ b/types/lodash/flow/index.d.ts @@ -1,2 +1,2 @@ import { flow } from "../index"; -export = flow; \ No newline at end of file +export = flow; diff --git a/types/lodash/flowRight/index.d.ts b/types/lodash/flowRight/index.d.ts index d787765c55..65fe107bde 100644 --- a/types/lodash/flowRight/index.d.ts +++ b/types/lodash/flowRight/index.d.ts @@ -1,2 +1,2 @@ import { flowRight } from "../index"; -export = flowRight; \ No newline at end of file +export = flowRight; diff --git a/types/lodash/forEach/index.d.ts b/types/lodash/forEach/index.d.ts index cd50458a13..bdcae5ac8a 100644 --- a/types/lodash/forEach/index.d.ts +++ b/types/lodash/forEach/index.d.ts @@ -1,2 +1,2 @@ import { forEach } from "../index"; -export = forEach; \ No newline at end of file +export = forEach; diff --git a/types/lodash/forEachRight/index.d.ts b/types/lodash/forEachRight/index.d.ts index 3c579e867d..16bfc91bd8 100644 --- a/types/lodash/forEachRight/index.d.ts +++ b/types/lodash/forEachRight/index.d.ts @@ -1,2 +1,2 @@ import { forEachRight } from "../index"; -export = forEachRight; \ No newline at end of file +export = forEachRight; diff --git a/types/lodash/forIn/index.d.ts b/types/lodash/forIn/index.d.ts index 8ce44be7b3..176b0bc3c4 100644 --- a/types/lodash/forIn/index.d.ts +++ b/types/lodash/forIn/index.d.ts @@ -1,2 +1,2 @@ import { forIn } from "../index"; -export = forIn; \ No newline at end of file +export = forIn; diff --git a/types/lodash/forInRight/index.d.ts b/types/lodash/forInRight/index.d.ts index c8a8b63da3..791c1ae43a 100644 --- a/types/lodash/forInRight/index.d.ts +++ b/types/lodash/forInRight/index.d.ts @@ -1,2 +1,2 @@ import { forInRight } from "../index"; -export = forInRight; \ No newline at end of file +export = forInRight; diff --git a/types/lodash/forOwn/index.d.ts b/types/lodash/forOwn/index.d.ts index 5a8fb41203..41230e4df0 100644 --- a/types/lodash/forOwn/index.d.ts +++ b/types/lodash/forOwn/index.d.ts @@ -1,2 +1,2 @@ import { forOwn } from "../index"; -export = forOwn; \ No newline at end of file +export = forOwn; diff --git a/types/lodash/forOwnRight/index.d.ts b/types/lodash/forOwnRight/index.d.ts index c50c88ffcb..cf09aaea78 100644 --- a/types/lodash/forOwnRight/index.d.ts +++ b/types/lodash/forOwnRight/index.d.ts @@ -1,2 +1,2 @@ import { forOwnRight } from "../index"; -export = forOwnRight; \ No newline at end of file +export = forOwnRight; diff --git a/types/lodash/fromPairs/index.d.ts b/types/lodash/fromPairs/index.d.ts index 0a9528aa6e..007dd84c4f 100644 --- a/types/lodash/fromPairs/index.d.ts +++ b/types/lodash/fromPairs/index.d.ts @@ -1,2 +1,2 @@ import { fromPairs } from "../index"; -export = fromPairs; \ No newline at end of file +export = fromPairs; diff --git a/types/lodash/functions/index.d.ts b/types/lodash/functions/index.d.ts index 1d85c6d363..ecb9881d1f 100644 --- a/types/lodash/functions/index.d.ts +++ b/types/lodash/functions/index.d.ts @@ -1,2 +1,2 @@ import { functions } from "../index"; -export = functions; \ No newline at end of file +export = functions; diff --git a/types/lodash/functionsIn/index.d.ts b/types/lodash/functionsIn/index.d.ts index 93e45415db..e3d733ae40 100644 --- a/types/lodash/functionsIn/index.d.ts +++ b/types/lodash/functionsIn/index.d.ts @@ -1,2 +1,2 @@ import { functionsIn } from "../index"; -export = functionsIn; \ No newline at end of file +export = functionsIn; diff --git a/types/lodash/get/index.d.ts b/types/lodash/get/index.d.ts index 435d3df99d..d38d6753aa 100644 --- a/types/lodash/get/index.d.ts +++ b/types/lodash/get/index.d.ts @@ -1,2 +1,2 @@ import { get } from "../index"; -export = get; \ No newline at end of file +export = get; diff --git a/types/lodash/groupBy/index.d.ts b/types/lodash/groupBy/index.d.ts index e04afa237b..2d09926b8f 100644 --- a/types/lodash/groupBy/index.d.ts +++ b/types/lodash/groupBy/index.d.ts @@ -1,2 +1,2 @@ import { groupBy } from "../index"; -export = groupBy; \ No newline at end of file +export = groupBy; diff --git a/types/lodash/gt/index.d.ts b/types/lodash/gt/index.d.ts index 9601fc765b..842d6c11f2 100644 --- a/types/lodash/gt/index.d.ts +++ b/types/lodash/gt/index.d.ts @@ -1,2 +1,2 @@ import { gt } from "../index"; -export = gt; \ No newline at end of file +export = gt; diff --git a/types/lodash/gte/index.d.ts b/types/lodash/gte/index.d.ts index c329cb2544..ffdf651d58 100644 --- a/types/lodash/gte/index.d.ts +++ b/types/lodash/gte/index.d.ts @@ -1,2 +1,2 @@ import { gte } from "../index"; -export = gte; \ No newline at end of file +export = gte; diff --git a/types/lodash/has/index.d.ts b/types/lodash/has/index.d.ts index ef4607fd00..56a5f39b91 100644 --- a/types/lodash/has/index.d.ts +++ b/types/lodash/has/index.d.ts @@ -1,2 +1,2 @@ import { has } from "../index"; -export = has; \ No newline at end of file +export = has; diff --git a/types/lodash/hasIn/index.d.ts b/types/lodash/hasIn/index.d.ts index 28e46e8d42..bcacce21c1 100644 --- a/types/lodash/hasIn/index.d.ts +++ b/types/lodash/hasIn/index.d.ts @@ -1,2 +1,2 @@ import { hasIn } from "../index"; -export = hasIn; \ No newline at end of file +export = hasIn; diff --git a/types/lodash/head/index.d.ts b/types/lodash/head/index.d.ts index f9cdf839d6..686e6372a8 100644 --- a/types/lodash/head/index.d.ts +++ b/types/lodash/head/index.d.ts @@ -1,2 +1,2 @@ import { head } from "../index"; -export = head; \ No newline at end of file +export = head; diff --git a/types/lodash/identity/index.d.ts b/types/lodash/identity/index.d.ts index 26894a8e4e..92a3e32afb 100644 --- a/types/lodash/identity/index.d.ts +++ b/types/lodash/identity/index.d.ts @@ -1,2 +1,2 @@ import { identity } from "../index"; -export = identity; \ No newline at end of file +export = identity; diff --git a/types/lodash/inRange/index.d.ts b/types/lodash/inRange/index.d.ts index 128b554abc..873efdaef4 100644 --- a/types/lodash/inRange/index.d.ts +++ b/types/lodash/inRange/index.d.ts @@ -1,2 +1,2 @@ import { inRange } from "../index"; -export = inRange; \ No newline at end of file +export = inRange; diff --git a/types/lodash/includes/index.d.ts b/types/lodash/includes/index.d.ts index d1c5d94e90..c78736dc58 100644 --- a/types/lodash/includes/index.d.ts +++ b/types/lodash/includes/index.d.ts @@ -1,2 +1,2 @@ import { includes } from "../index"; -export = includes; \ No newline at end of file +export = includes; diff --git a/types/lodash/index.d.ts b/types/lodash/index.d.ts index 10326ae888..39dad36ed5 100644 --- a/types/lodash/index.d.ts +++ b/types/lodash/index.d.ts @@ -43,7 +43,6 @@ changes: - [x] Made _.capitalize uppercase the first character & lowercase the rest - [x] Made _.functions return only own method names - added 23 array methods: - [x] _.concat - [x] _.differenceBy @@ -101,7 +100,6 @@ added 13 object methods: - [x] _.omitBy - [x] _.pickBy - added 8 string methods: - [x] _.lowerCase - [x] _.lowerFirst @@ -237,7 +235,6 @@ Methods: - [ ] _.next */ - export = _; export as namespace _; @@ -246,7 +243,6 @@ declare var _: _.LoDashStatic; type PartialObject = Partial; declare namespace _ { - type Many = T | T[]; interface LoDashStatic { @@ -3202,11 +3198,9 @@ declare namespace _ { sortedIndex( value: T ): LoDashExplicitWrapper; - - } - //_.sortedIndexBy + // _.sortedIndexBy interface LoDashStatic { /** * This method is like `_.sortedIndex` except that it accepts `iteratee` @@ -8662,7 +8656,6 @@ declare namespace _ { reduce( collection: NumericDictionary, callback: MemoIterator): TResult; - } interface LoDashImplicitArrayWrapper { @@ -9248,7 +9241,6 @@ declare namespace _ { predicate?: string|[string, any] ): boolean; - /** * @see _.some */ @@ -10517,7 +10509,6 @@ declare namespace _ { flowRight(...funcs: Function[]): LoDashExplicitObjectWrapper; } - //_.memoize interface MemoizedFunction extends Function { cache: MapCache; @@ -11163,7 +11154,6 @@ declare namespace _ { } interface LoDashImplicitArrayWrapper { - /** * @see _.clone */ @@ -11185,7 +11175,6 @@ declare namespace _ { } interface LoDashExplicitArrayWrapper { - /** * @see _.clone */ @@ -13875,7 +13864,6 @@ declare namespace _ { end: number ): boolean; - /** * @see _.inRange */ @@ -14720,7 +14708,6 @@ declare namespace _ { create(properties?: U): LoDashExplicitObjectWrapper; } - //_.defaults interface LoDashStatic { /** @@ -16593,7 +16580,6 @@ declare namespace _ { } interface LoDashImplicitObjectWrapper { - /** * @see _.omit */ @@ -16603,7 +16589,6 @@ declare namespace _ { } interface LoDashExplicitObjectWrapper { - /** * @see _.omit */ @@ -19498,7 +19483,6 @@ declare namespace _ { } } - // Backward compatibility with --target es5 declare global { interface Set { } diff --git a/types/lodash/indexOf/index.d.ts b/types/lodash/indexOf/index.d.ts index ab5c82d8ed..d2f21b9864 100644 --- a/types/lodash/indexOf/index.d.ts +++ b/types/lodash/indexOf/index.d.ts @@ -1,2 +1,2 @@ import { indexOf } from "../index"; -export = indexOf; \ No newline at end of file +export = indexOf; diff --git a/types/lodash/initial/index.d.ts b/types/lodash/initial/index.d.ts index 800c0a6ca2..459fa17ade 100644 --- a/types/lodash/initial/index.d.ts +++ b/types/lodash/initial/index.d.ts @@ -1,2 +1,2 @@ import { initial } from "../index"; -export = initial; \ No newline at end of file +export = initial; diff --git a/types/lodash/intersection/index.d.ts b/types/lodash/intersection/index.d.ts index b44a84ac45..d186c26fc9 100644 --- a/types/lodash/intersection/index.d.ts +++ b/types/lodash/intersection/index.d.ts @@ -1,2 +1,2 @@ import { intersection } from "../index"; -export = intersection; \ No newline at end of file +export = intersection; diff --git a/types/lodash/intersectionBy/index.d.ts b/types/lodash/intersectionBy/index.d.ts index 82df722083..430bf52bbf 100644 --- a/types/lodash/intersectionBy/index.d.ts +++ b/types/lodash/intersectionBy/index.d.ts @@ -1,2 +1,2 @@ import { intersectionBy } from "../index"; -export = intersectionBy; \ No newline at end of file +export = intersectionBy; diff --git a/types/lodash/intersectionWith/index.d.ts b/types/lodash/intersectionWith/index.d.ts index 6c69b5323b..f6a3ec0dd8 100644 --- a/types/lodash/intersectionWith/index.d.ts +++ b/types/lodash/intersectionWith/index.d.ts @@ -1,2 +1,2 @@ import { intersectionWith } from "../index"; -export = intersectionWith; \ No newline at end of file +export = intersectionWith; diff --git a/types/lodash/invert/index.d.ts b/types/lodash/invert/index.d.ts index 21e2a38243..525a57d57e 100644 --- a/types/lodash/invert/index.d.ts +++ b/types/lodash/invert/index.d.ts @@ -1,2 +1,2 @@ import { invert } from "../index"; -export = invert; \ No newline at end of file +export = invert; diff --git a/types/lodash/invertBy/index.d.ts b/types/lodash/invertBy/index.d.ts index c489f376a2..5e87b4d801 100644 --- a/types/lodash/invertBy/index.d.ts +++ b/types/lodash/invertBy/index.d.ts @@ -1,2 +1,2 @@ import { invertBy } from "../index"; -export = invertBy; \ No newline at end of file +export = invertBy; diff --git a/types/lodash/invoke/index.d.ts b/types/lodash/invoke/index.d.ts index a8ecc5713e..b4457e8b25 100644 --- a/types/lodash/invoke/index.d.ts +++ b/types/lodash/invoke/index.d.ts @@ -1,2 +1,2 @@ import { invoke } from "../index"; -export = invoke; \ No newline at end of file +export = invoke; diff --git a/types/lodash/invokeMap/index.d.ts b/types/lodash/invokeMap/index.d.ts index d4d4ecd4f5..7b2f232247 100644 --- a/types/lodash/invokeMap/index.d.ts +++ b/types/lodash/invokeMap/index.d.ts @@ -1,2 +1,2 @@ import { invokeMap } from "../index"; -export = invokeMap; \ No newline at end of file +export = invokeMap; diff --git a/types/lodash/isArguments/index.d.ts b/types/lodash/isArguments/index.d.ts index c340e2213b..1eab52baf4 100644 --- a/types/lodash/isArguments/index.d.ts +++ b/types/lodash/isArguments/index.d.ts @@ -1,2 +1,2 @@ import { isArguments } from "../index"; -export = isArguments; \ No newline at end of file +export = isArguments; diff --git a/types/lodash/isArray/index.d.ts b/types/lodash/isArray/index.d.ts index cf6bccc392..d25e63b785 100644 --- a/types/lodash/isArray/index.d.ts +++ b/types/lodash/isArray/index.d.ts @@ -1,2 +1,2 @@ import { isArray } from "../index"; -export = isArray; \ No newline at end of file +export = isArray; diff --git a/types/lodash/isArrayBuffer/index.d.ts b/types/lodash/isArrayBuffer/index.d.ts index d7f1adfc48..503f3fffdb 100644 --- a/types/lodash/isArrayBuffer/index.d.ts +++ b/types/lodash/isArrayBuffer/index.d.ts @@ -1,2 +1,2 @@ import { isArrayBuffer } from "../index"; -export = isArrayBuffer; \ No newline at end of file +export = isArrayBuffer; diff --git a/types/lodash/isArrayLike/index.d.ts b/types/lodash/isArrayLike/index.d.ts index 40bfb93a16..706e959347 100644 --- a/types/lodash/isArrayLike/index.d.ts +++ b/types/lodash/isArrayLike/index.d.ts @@ -1,2 +1,2 @@ import { isArrayLike } from "../index"; -export = isArrayLike; \ No newline at end of file +export = isArrayLike; diff --git a/types/lodash/isArrayLikeObject/index.d.ts b/types/lodash/isArrayLikeObject/index.d.ts index 1d0fae7cd8..2336469e2e 100644 --- a/types/lodash/isArrayLikeObject/index.d.ts +++ b/types/lodash/isArrayLikeObject/index.d.ts @@ -1,2 +1,2 @@ import { isArrayLikeObject } from "../index"; -export = isArrayLikeObject; \ No newline at end of file +export = isArrayLikeObject; diff --git a/types/lodash/isBoolean/index.d.ts b/types/lodash/isBoolean/index.d.ts index 641d0a3e24..348c40747c 100644 --- a/types/lodash/isBoolean/index.d.ts +++ b/types/lodash/isBoolean/index.d.ts @@ -1,2 +1,2 @@ import { isBoolean } from "../index"; -export = isBoolean; \ No newline at end of file +export = isBoolean; diff --git a/types/lodash/isBuffer/index.d.ts b/types/lodash/isBuffer/index.d.ts index 96260453e7..2e3f555fbf 100644 --- a/types/lodash/isBuffer/index.d.ts +++ b/types/lodash/isBuffer/index.d.ts @@ -1,2 +1,2 @@ import { isBuffer } from "../index"; -export = isBuffer; \ No newline at end of file +export = isBuffer; diff --git a/types/lodash/isDate/index.d.ts b/types/lodash/isDate/index.d.ts index 671f2f0111..23abc5b9e2 100644 --- a/types/lodash/isDate/index.d.ts +++ b/types/lodash/isDate/index.d.ts @@ -1,2 +1,2 @@ import { isDate } from "../index"; -export = isDate; \ No newline at end of file +export = isDate; diff --git a/types/lodash/isElement/index.d.ts b/types/lodash/isElement/index.d.ts index c533c31990..ccf79d3ad4 100644 --- a/types/lodash/isElement/index.d.ts +++ b/types/lodash/isElement/index.d.ts @@ -1,2 +1,2 @@ import { isElement } from "../index"; -export = isElement; \ No newline at end of file +export = isElement; diff --git a/types/lodash/isEmpty/index.d.ts b/types/lodash/isEmpty/index.d.ts index 8953bc88a5..593a4af122 100644 --- a/types/lodash/isEmpty/index.d.ts +++ b/types/lodash/isEmpty/index.d.ts @@ -1,2 +1,2 @@ import { isEmpty } from "../index"; -export = isEmpty; \ No newline at end of file +export = isEmpty; diff --git a/types/lodash/isEqual/index.d.ts b/types/lodash/isEqual/index.d.ts index 57b5e8eac5..732f1db607 100644 --- a/types/lodash/isEqual/index.d.ts +++ b/types/lodash/isEqual/index.d.ts @@ -1,2 +1,2 @@ import { isEqual } from "../index"; -export = isEqual; \ No newline at end of file +export = isEqual; diff --git a/types/lodash/isEqualWith/index.d.ts b/types/lodash/isEqualWith/index.d.ts index d43f81c209..3f3ffb8d61 100644 --- a/types/lodash/isEqualWith/index.d.ts +++ b/types/lodash/isEqualWith/index.d.ts @@ -1,2 +1,2 @@ import { isEqualWith } from "../index"; -export = isEqualWith; \ No newline at end of file +export = isEqualWith; diff --git a/types/lodash/isError/index.d.ts b/types/lodash/isError/index.d.ts index b56665a1ca..ba36080a20 100644 --- a/types/lodash/isError/index.d.ts +++ b/types/lodash/isError/index.d.ts @@ -1,2 +1,2 @@ import { isError } from "../index"; -export = isError; \ No newline at end of file +export = isError; diff --git a/types/lodash/isFinite/index.d.ts b/types/lodash/isFinite/index.d.ts index bc1dcd04ef..55e07fe26b 100644 --- a/types/lodash/isFinite/index.d.ts +++ b/types/lodash/isFinite/index.d.ts @@ -1,2 +1,2 @@ import { isFinite } from "../index"; -export = isFinite; \ No newline at end of file +export = isFinite; diff --git a/types/lodash/isFunction/index.d.ts b/types/lodash/isFunction/index.d.ts index b67b30d201..3a0f17bae3 100644 --- a/types/lodash/isFunction/index.d.ts +++ b/types/lodash/isFunction/index.d.ts @@ -1,2 +1,2 @@ import { isFunction } from "../index"; -export = isFunction; \ No newline at end of file +export = isFunction; diff --git a/types/lodash/isInteger/index.d.ts b/types/lodash/isInteger/index.d.ts index bdc8732dc6..271a02cbc9 100644 --- a/types/lodash/isInteger/index.d.ts +++ b/types/lodash/isInteger/index.d.ts @@ -1,2 +1,2 @@ import { isInteger } from "../index"; -export = isInteger; \ No newline at end of file +export = isInteger; diff --git a/types/lodash/isLength/index.d.ts b/types/lodash/isLength/index.d.ts index 7d3044c7a7..d930fb357f 100644 --- a/types/lodash/isLength/index.d.ts +++ b/types/lodash/isLength/index.d.ts @@ -1,2 +1,2 @@ import { isLength } from "../index"; -export = isLength; \ No newline at end of file +export = isLength; diff --git a/types/lodash/isMap/index.d.ts b/types/lodash/isMap/index.d.ts index 55fa964b92..579632c190 100644 --- a/types/lodash/isMap/index.d.ts +++ b/types/lodash/isMap/index.d.ts @@ -1,2 +1,2 @@ import { isMap } from "../index"; -export = isMap; \ No newline at end of file +export = isMap; diff --git a/types/lodash/isMatch/index.d.ts b/types/lodash/isMatch/index.d.ts index e0fe216b20..d0ad2c8f4d 100644 --- a/types/lodash/isMatch/index.d.ts +++ b/types/lodash/isMatch/index.d.ts @@ -1,2 +1,2 @@ import { isMatch } from "../index"; -export = isMatch; \ No newline at end of file +export = isMatch; diff --git a/types/lodash/isMatchWith/index.d.ts b/types/lodash/isMatchWith/index.d.ts index 826b89a9d5..07e83bfe93 100644 --- a/types/lodash/isMatchWith/index.d.ts +++ b/types/lodash/isMatchWith/index.d.ts @@ -1,2 +1,2 @@ import { isMatchWith } from "../index"; -export = isMatchWith; \ No newline at end of file +export = isMatchWith; diff --git a/types/lodash/isNaN/index.d.ts b/types/lodash/isNaN/index.d.ts index c3aac0325a..e2c48a8f47 100644 --- a/types/lodash/isNaN/index.d.ts +++ b/types/lodash/isNaN/index.d.ts @@ -1,2 +1,2 @@ import { isNaN } from "../index"; -export = isNaN; \ No newline at end of file +export = isNaN; diff --git a/types/lodash/isNative/index.d.ts b/types/lodash/isNative/index.d.ts index 5ebd0dd433..6f32bd4138 100644 --- a/types/lodash/isNative/index.d.ts +++ b/types/lodash/isNative/index.d.ts @@ -1,2 +1,2 @@ import { isNative } from "../index"; -export = isNative; \ No newline at end of file +export = isNative; diff --git a/types/lodash/isNil/index.d.ts b/types/lodash/isNil/index.d.ts index eb45696d78..46f4928dda 100644 --- a/types/lodash/isNil/index.d.ts +++ b/types/lodash/isNil/index.d.ts @@ -1,2 +1,2 @@ import { isNil } from "../index"; -export = isNil; \ No newline at end of file +export = isNil; diff --git a/types/lodash/isNull/index.d.ts b/types/lodash/isNull/index.d.ts index 534886638c..a8ff0aa678 100644 --- a/types/lodash/isNull/index.d.ts +++ b/types/lodash/isNull/index.d.ts @@ -1,2 +1,2 @@ import { isNull } from "../index"; -export = isNull; \ No newline at end of file +export = isNull; diff --git a/types/lodash/isNumber/index.d.ts b/types/lodash/isNumber/index.d.ts index 5a8b9d82a9..13dd5e71df 100644 --- a/types/lodash/isNumber/index.d.ts +++ b/types/lodash/isNumber/index.d.ts @@ -1,2 +1,2 @@ import { isNumber } from "../index"; -export = isNumber; \ No newline at end of file +export = isNumber; diff --git a/types/lodash/isObject/index.d.ts b/types/lodash/isObject/index.d.ts index 8ffd829177..782c639180 100644 --- a/types/lodash/isObject/index.d.ts +++ b/types/lodash/isObject/index.d.ts @@ -1,2 +1,2 @@ import { isObject } from "../index"; -export = isObject; \ No newline at end of file +export = isObject; diff --git a/types/lodash/isObjectLike/index.d.ts b/types/lodash/isObjectLike/index.d.ts index d8ccba7e88..1f3e27b9e3 100644 --- a/types/lodash/isObjectLike/index.d.ts +++ b/types/lodash/isObjectLike/index.d.ts @@ -1,2 +1,2 @@ import { isObjectLike } from "../index"; -export = isObjectLike; \ No newline at end of file +export = isObjectLike; diff --git a/types/lodash/isPlainObject/index.d.ts b/types/lodash/isPlainObject/index.d.ts index c475c55813..5f474f0259 100644 --- a/types/lodash/isPlainObject/index.d.ts +++ b/types/lodash/isPlainObject/index.d.ts @@ -1,2 +1,2 @@ import { isPlainObject } from "../index"; -export = isPlainObject; \ No newline at end of file +export = isPlainObject; diff --git a/types/lodash/isRegExp/index.d.ts b/types/lodash/isRegExp/index.d.ts index ec98ecb1c5..aa85288df5 100644 --- a/types/lodash/isRegExp/index.d.ts +++ b/types/lodash/isRegExp/index.d.ts @@ -1,2 +1,2 @@ import { isRegExp } from "../index"; -export = isRegExp; \ No newline at end of file +export = isRegExp; diff --git a/types/lodash/isSafeInteger/index.d.ts b/types/lodash/isSafeInteger/index.d.ts index d01b370acc..e3002bd6b9 100644 --- a/types/lodash/isSafeInteger/index.d.ts +++ b/types/lodash/isSafeInteger/index.d.ts @@ -1,2 +1,2 @@ import { isSafeInteger } from "../index"; -export = isSafeInteger; \ No newline at end of file +export = isSafeInteger; diff --git a/types/lodash/isSet/index.d.ts b/types/lodash/isSet/index.d.ts index c08ee683ba..e7f1b52379 100644 --- a/types/lodash/isSet/index.d.ts +++ b/types/lodash/isSet/index.d.ts @@ -1,2 +1,2 @@ import { isSet } from "../index"; -export = isSet; \ No newline at end of file +export = isSet; diff --git a/types/lodash/isString/index.d.ts b/types/lodash/isString/index.d.ts index 2413f17435..1f791b7d92 100644 --- a/types/lodash/isString/index.d.ts +++ b/types/lodash/isString/index.d.ts @@ -1,2 +1,2 @@ import { isString } from "../index"; -export = isString; \ No newline at end of file +export = isString; diff --git a/types/lodash/isSymbol/index.d.ts b/types/lodash/isSymbol/index.d.ts index eba542157f..15c9097d3f 100644 --- a/types/lodash/isSymbol/index.d.ts +++ b/types/lodash/isSymbol/index.d.ts @@ -1,2 +1,2 @@ import { isSymbol } from "../index"; -export = isSymbol; \ No newline at end of file +export = isSymbol; diff --git a/types/lodash/isTypedArray/index.d.ts b/types/lodash/isTypedArray/index.d.ts index 0320879333..8856310cd6 100644 --- a/types/lodash/isTypedArray/index.d.ts +++ b/types/lodash/isTypedArray/index.d.ts @@ -1,2 +1,2 @@ import { isTypedArray } from "../index"; -export = isTypedArray; \ No newline at end of file +export = isTypedArray; diff --git a/types/lodash/isUndefined/index.d.ts b/types/lodash/isUndefined/index.d.ts index 8efbb37b1f..dbb326461e 100644 --- a/types/lodash/isUndefined/index.d.ts +++ b/types/lodash/isUndefined/index.d.ts @@ -1,2 +1,2 @@ import { isUndefined } from "../index"; -export = isUndefined; \ No newline at end of file +export = isUndefined; diff --git a/types/lodash/isWeakMap/index.d.ts b/types/lodash/isWeakMap/index.d.ts index 69caa4c956..954f587ecf 100644 --- a/types/lodash/isWeakMap/index.d.ts +++ b/types/lodash/isWeakMap/index.d.ts @@ -1,2 +1,2 @@ import { isWeakMap } from "../index"; -export = isWeakMap; \ No newline at end of file +export = isWeakMap; diff --git a/types/lodash/isWeakSet/index.d.ts b/types/lodash/isWeakSet/index.d.ts index d0cf33fdd6..28a84390d8 100644 --- a/types/lodash/isWeakSet/index.d.ts +++ b/types/lodash/isWeakSet/index.d.ts @@ -1,2 +1,2 @@ import { isWeakSet } from "../index"; -export = isWeakSet; \ No newline at end of file +export = isWeakSet; diff --git a/types/lodash/iteratee/index.d.ts b/types/lodash/iteratee/index.d.ts index 81764d4ad2..2969a1f3e4 100644 --- a/types/lodash/iteratee/index.d.ts +++ b/types/lodash/iteratee/index.d.ts @@ -1,2 +1,2 @@ import { iteratee } from "../index"; -export = iteratee; \ No newline at end of file +export = iteratee; diff --git a/types/lodash/join/index.d.ts b/types/lodash/join/index.d.ts index 2c2bd4f91e..ba5a4a26a7 100644 --- a/types/lodash/join/index.d.ts +++ b/types/lodash/join/index.d.ts @@ -1,2 +1,2 @@ import { join } from "../index"; -export = join; \ No newline at end of file +export = join; diff --git a/types/lodash/kebabCase/index.d.ts b/types/lodash/kebabCase/index.d.ts index 73576c0249..875a153635 100644 --- a/types/lodash/kebabCase/index.d.ts +++ b/types/lodash/kebabCase/index.d.ts @@ -1,2 +1,2 @@ import { kebabCase } from "../index"; -export = kebabCase; \ No newline at end of file +export = kebabCase; diff --git a/types/lodash/keyBy/index.d.ts b/types/lodash/keyBy/index.d.ts index 80a0a4d7c9..93f370b5a7 100644 --- a/types/lodash/keyBy/index.d.ts +++ b/types/lodash/keyBy/index.d.ts @@ -1,2 +1,2 @@ import { keyBy } from "../index"; -export = keyBy; \ No newline at end of file +export = keyBy; diff --git a/types/lodash/keys/index.d.ts b/types/lodash/keys/index.d.ts index 53693b5705..3a19ec5b7a 100644 --- a/types/lodash/keys/index.d.ts +++ b/types/lodash/keys/index.d.ts @@ -1,2 +1,2 @@ import { keys } from "../index"; -export = keys; \ No newline at end of file +export = keys; diff --git a/types/lodash/keysIn/index.d.ts b/types/lodash/keysIn/index.d.ts index e0747ccc46..159a7e9b8c 100644 --- a/types/lodash/keysIn/index.d.ts +++ b/types/lodash/keysIn/index.d.ts @@ -1,2 +1,2 @@ import { keysIn } from "../index"; -export = keysIn; \ No newline at end of file +export = keysIn; diff --git a/types/lodash/last/index.d.ts b/types/lodash/last/index.d.ts index 2590a6ac4f..8b56dda8bf 100644 --- a/types/lodash/last/index.d.ts +++ b/types/lodash/last/index.d.ts @@ -1,2 +1,2 @@ import { last } from "../index"; -export = last; \ No newline at end of file +export = last; diff --git a/types/lodash/lastIndexOf/index.d.ts b/types/lodash/lastIndexOf/index.d.ts index 8e83b85f3b..47a9e1fef9 100644 --- a/types/lodash/lastIndexOf/index.d.ts +++ b/types/lodash/lastIndexOf/index.d.ts @@ -1,2 +1,2 @@ import { lastIndexOf } from "../index"; -export = lastIndexOf; \ No newline at end of file +export = lastIndexOf; diff --git a/types/lodash/lodash-tests.ts b/types/lodash/lodash-tests.ts index b260df8ee5..a168825dad 100644 --- a/types/lodash/lodash-tests.ts +++ b/types/lodash/lodash-tests.ts @@ -1,4 +1,4 @@ -declare var $: any, jQuery: any; +declare const $: any, jQuery: any; interface IFoodOrganic { name: string; @@ -41,38 +41,38 @@ interface IDictionary { [index: string]: T; } -var foodsOrganic: IFoodOrganic[] = [ +const foodsOrganic: IFoodOrganic[] = [ { name: 'banana', organic: true }, { name: 'beet', organic: false }, ]; -var foodsType: IFoodType[] = [ +const foodsType: IFoodType[] = [ { name: 'apple', type: 'fruit' }, { name: 'banana', type: 'fruit' }, { name: 'beet', type: 'vegetable' } ]; -var foodsCombined: IFoodCombined[] = [ +const foodsCombined: IFoodCombined[] = [ { 'name': 'apple', 'organic': false, 'type': 'fruit' }, { 'name': 'carrot', 'organic': true, 'type': 'vegetable' } ]; -var stoogesQuotes: IStoogesQuote[] = [ +const stoogesQuotes: IStoogesQuote[] = [ { 'name': 'curly', 'quotes': ['Oh, a wise guy, eh?', 'Poifect!'] }, { 'name': 'moe', 'quotes': ['Spread out!', 'You knucklehead!'] } ]; -var stoogesAges: IStoogesAge[] = [ +const stoogesAges: IStoogesAge[] = [ { 'name': 'moe', 'age': 40 }, { 'name': 'larry', 'age': 50 } ]; -var stoogesAgesDict: IDictionary = { +const stoogesAgesDict: IDictionary = { first: { 'name': 'moe', 'age': 40 }, second: { 'name': 'larry', 'age': 50 } }; -var stoogesCombined: IStoogesCombined[] = [ +const stoogesCombined: IStoogesCombined[] = [ { 'name': 'curly', 'age': 30, 'quotes': ['Oh, a wise guy, eh?', 'Poifect!'] }, { 'name': 'moe', 'age': 40, 'quotes': ['Spread out!', 'You knucklehead!'] } ]; -var keys: IKey[] = [ +const keys: IKey[] = [ { 'dir': 'left', 'code': 97 }, { 'dir': 'right', 'code': 100 } ]; @@ -85,9 +85,9 @@ class Dog { } } -var result: any; +let result: any; -var any: any; +let any: any; interface TResult { a: number; @@ -96,7 +96,7 @@ interface TResult { } // _.MapCache -var testMapCache: _.MapCache; +let testMapCache: _.MapCache; result = <(key: string) => boolean>testMapCache.delete; result = <(key: string) => any>testMapCache.get; result = <(key: string) => boolean>testMapCache.has; @@ -498,7 +498,6 @@ namespace TestDropRight { result = _.dropRight(list); result = _.dropRight(list, 42); - } { @@ -1488,7 +1487,6 @@ namespace TestTail { result = _.tail(array); result = _.tail(list); - } { @@ -1562,7 +1560,6 @@ namespace TestSortedIndex { result = _(array).sortedIndex(value); result = _(list).sortedIndex(value); - } { @@ -1573,7 +1570,6 @@ namespace TestSortedIndex { result = _(array).chain().sortedIndex(value); result = _(list).chain().sortedIndex(value); - } } @@ -1749,7 +1745,6 @@ namespace TestTail { result = _.tail(array); result = _.tail(list); - } { @@ -2197,11 +2192,9 @@ namespace TestUniq { result = _(array).chain().uniq(); result = _(list).chain().uniq(); - } } - // _.uniqBy namespace TestUniqBy { type SampleObject = {a: number; b: string; c: boolean}; @@ -2702,7 +2695,7 @@ namespace TestZipObject { interface TestZipWithFn { (a1: number, a2: number): number; } -var testZipWithFn: TestZipWithFn; +let testZipWithFn: TestZipWithFn; result = _.zipWith([1, 2]); result = _.zipWith([1, 2], testZipWithFn); result = _.zipWith([1, 2], [1, 2], testZipWithFn); @@ -5209,7 +5202,6 @@ result = _.sortBy(stoogesAges, 'name', stooge => Math.sin(stooge. result = _(foodsOrganic).sortBy('organic', (food) => food.name, { organic: true }).value(); - // _.orderBy namespace TestorderBy { type SampleObject = {a: number; b: string; c: boolean}; @@ -5533,7 +5525,7 @@ namespace TestBindAll { // _.bindKey namespace TestBindKey { let object: { - foo: (a: number, b: string) => boolean; + foo(a: number, b: string): boolean; } { @@ -5612,14 +5604,14 @@ namespace TestBindKey { } } -var createCallbackObj: { [index: string]: string; } = { name: 'Joe' }; +const createCallbackObj: { [index: string]: string; } = { name: 'Joe' }; result = <() => any>_.createCallback('name'); result = <() => boolean>_.createCallback(createCallbackObj); result = <_.LoDashImplicitObjectWrapper<() => any>>_('name').createCallback(); result = <_.LoDashImplicitObjectWrapper<() => boolean>>_(createCallbackObj).createCallback(); // _.curry -var testCurryFn = (a: number, b: number, c: number) => [a, b, c]; +const testCurryFn = (a: number, b: number, c: number) => [a, b, c]; let curryResult0: number[] let curryResult1: _.CurriedFunction1 let curryResult2: _.CurriedFunction2 @@ -5650,7 +5642,7 @@ curryResult5 = _.curry(testCurry2)("1"); curryResult6 = _.curry(testCurry2); // _.curryRight -var testCurryRightFn = (a: number, b: number, c: number) => [a, b, c]; +const testCurryRightFn = (a: number, b: number, c: number) => [a, b, c]; curryResult0 = _.curryRight(testCurryRightFn)(1, 2, 3); curryResult2 = _.curryRight(testCurryRightFn)(1); curryResult0 = _(testCurryRightFn).curryRight().value()(1, 2, 3); @@ -5996,7 +5988,7 @@ namespace TestNegate { (a1: number, a2: number): boolean; } - var predicate = (a1: number, a2: number) => a1 > a2; + const predicate = (a1: number, a2: number) => a1 > a2; { let result: ResultFn; @@ -6047,14 +6039,13 @@ namespace TestOnce { } } -var greetPartial = (greeting: string, name: string) => greeting + ' ' + name; -var hi = _.partial(greetPartial, 'hi'); +const greetPartial = (greeting: string, name: string) => greeting + ' ' + name; +const hi = _.partial(greetPartial, 'hi'); hi('moe'); +const defaultsDeep = _.partialRight(_.merge, _.defaults); -var defaultsDeep = _.partialRight(_.merge, _.defaults); - -var optionsPartialRight = { +const optionsPartialRight = { 'variable': 'data', 'imports': { 'jq': $ } }; @@ -6062,7 +6053,7 @@ var optionsPartialRight = { defaultsDeep(optionsPartialRight, _.templateSettings); //_.rearg -var testReargFn = (a: string, b: string, c: string) => [a, b, c]; +const testReargFn = (a: string, b: string, c: string) => [a, b, c]; interface TestReargResultFn { (b: string, c: string, a: string): string[]; } @@ -7102,7 +7093,6 @@ namespace TestIsMatch { result = _({}).isMatch({}); } - // _.isMatchWith namespace TestIsMatchWith { let testIsMatchCustiomizerFn: (value: any, other: any, indexOrKey: number|string) => boolean; @@ -7111,7 +7101,6 @@ namespace TestIsMatchWith { result = _.isMatchWith({}, {}, testIsMatchCustiomizerFn); result = _({}).isMatchWith({}, testIsMatchCustiomizerFn); - } // _.isNaN @@ -7634,7 +7623,6 @@ namespace TestToArray { // _.toPlainObject namespace TestToPlainObject { - { let result: TResult; result = _.toPlainObject(); @@ -7877,7 +7865,6 @@ namespace TestMean { result = _.mean(array); result = _(array).mean(); - } // _.min @@ -7892,7 +7879,6 @@ namespace TestMin { result = _(array).min(); result = _(list).min(); - } // _.minBy @@ -8634,7 +8620,6 @@ namespace TestCreate { } } - // _.defaults namespace TestDefaults { interface Obj { a: string }; @@ -8767,12 +8752,11 @@ interface DefaultsDeepResult { age: number; } } -var TestDefaultsDeepObject = { 'user': { 'name': 'barney' } }; -var TestDefaultsDeepSource = { 'user': { 'name': 'fred', 'age': 36 } }; +const TestDefaultsDeepObject = { 'user': { 'name': 'barney' } }; +const TestDefaultsDeepSource = { 'user': { 'name': 'fred', 'age': 36 } }; result = _.defaultsDeep(TestDefaultsDeepObject, TestDefaultsDeepSource); result = _(TestDefaultsDeepObject).defaultsDeep(TestDefaultsDeepSource).value(); - // _.extend namespace TestExtend { type Obj = { a: string }; @@ -8900,7 +8884,6 @@ namespace TestExtend { } } - // _.extendWith namespace TestExtendWith { type Obj = { a: string }; @@ -9038,7 +9021,6 @@ namespace TestFindKey { result = _.findKey<{a: string;}>({a: ''}, predicateFn); - result = _.findKey<{a: string;}>({a: ''}, ''); result = _.findKey<{a: number;}, {a: string;}>({a: ''}, {a: 42}); @@ -9047,7 +9029,6 @@ namespace TestFindKey { result = _<{a: string;}>({a: ''}).findKey(predicateFn); - result = _<{a: string;}>({a: ''}).findKey(''); result = _<{a: string;}>({a: ''}).findKey<{a: number;}>({a: 42}); @@ -9070,7 +9051,6 @@ namespace TestFindKey { result = _<{a: string;}>({a: ''}).chain().findKey(predicateFn); - result = _<{a: string;}>({a: ''}).chain().findKey(''); result = _<{a: string;}>({a: ''}).chain().findKey<{a: number;}>({a: 42}); @@ -9094,7 +9074,6 @@ namespace TestFindLastKey { result = _.findLastKey<{a: string;}>({a: ''}, predicateFn); - result = _.findLastKey<{a: string;}>({a: ''}, ''); result = _.findLastKey<{a: number;}, {a: string;}>({a: ''}, {a: 42}); @@ -9103,7 +9082,6 @@ namespace TestFindLastKey { result = _<{a: string;}>({a: ''}).findLastKey(predicateFn); - result = _<{a: string;}>({a: ''}).findLastKey(''); result = _<{a: string;}>({a: ''}).findLastKey<{a: number;}>({a: 42}); @@ -9126,7 +9104,6 @@ namespace TestFindLastKey { result = _<{a: string;}>({a: ''}).chain().findLastKey(predicateFn); - result = _<{a: string;}>({a: ''}).chain().findLastKey(''); result = _<{a: string;}>({a: ''}).chain().findLastKey<{a: number;}>({a: 42}); @@ -9733,8 +9710,8 @@ namespace TestMerge { type InitialValue = { a : number }; type MergingValue = { b : string }; - var initialValue = { a : 1 }; - var mergingValue = { b : "hi" }; + const initialValue = { a : 1 }; + const mergingValue = { b : "hi" }; type ExpectedResult = { a: number, b: string }; let result: ExpectedResult; @@ -9752,10 +9729,9 @@ namespace TestMerge { // Once we get to the varargs version, you have to specify the result explicitly result = _.merge(initialValue, {}, {}, {}, {}, mergingValue); - type ComplicatedExpectedType = { a: number, b: string, c: {}, d: number[], e: boolean }; - var complicatedResult: ComplicatedExpectedType = _.merge({ a: 1 }, + let complicatedResult: ComplicatedExpectedType = _.merge({ a: 1 }, { b: "string" }, { c: {} }, { d: [1] }, @@ -9764,7 +9740,7 @@ namespace TestMerge { type ExpectedTypeAfterOverriding = { a: boolean }; - var overriddenResult: ExpectedTypeAfterOverriding = _.merge({ a: 1 }, + let overriddenResult: ExpectedTypeAfterOverriding = _.merge({ a: 1 }, { a: "string" }, { a: {} }, { a: [1] }, @@ -9785,14 +9761,14 @@ namespace TestMerge { // Test complex multiple combinations with chaining - var complicatedResult: ComplicatedExpectedType = _({ a: 1 }).merge({ b: "string" }, + complicatedResult = _({ a: 1 }).merge({ b: "string" }, { c: {} }, { d: [1] }, { e: true }).value(); // Test for type overriding with chaining - var overriddenResult: ExpectedTypeAfterOverriding = _({ a: 1 }).merge({ a: "string" }, + overriddenResult = _({ a: 1 }).merge({ a: "string" }, { a: {} }, { a: [1] }, { a: true }).value(); @@ -9824,8 +9800,8 @@ namespace TestMergeWith { type InitialValue = { a : number }; type MergingValue = { b : string }; - var initialValue = { a : 1 }; - var mergingValue = { b : "hi" }; + const initialValue = { a : 1 }; + const mergingValue = { b : "hi" }; type ExpectedResult = { a: number, b: string }; let result: ExpectedResult; @@ -11115,7 +11091,6 @@ namespace TestUnescape { } } - // _.upperCase namespace TestUpperCase { { @@ -11387,7 +11362,6 @@ namespace TestDefaultTo { result = _(null).chain().defaultTo({a : 'a'}); result = _(NaN).chain().defaultTo({a : 'a'}); } - } // _.identity @@ -11643,7 +11617,7 @@ namespace TestMethod { // _.methodOf namespace TestMethodOf { - type SampleObject = {a: {b: () => TResult}[]}; + type SampleObject = { a: { b(): TResult }[] }; type ResultFn = (path: _.StringRepresentable|_.StringRepresentable[]) => TResult; let object: SampleObject; diff --git a/types/lodash/lowerCase/index.d.ts b/types/lodash/lowerCase/index.d.ts index 0f949d854d..792ecb2fca 100644 --- a/types/lodash/lowerCase/index.d.ts +++ b/types/lodash/lowerCase/index.d.ts @@ -1,2 +1,2 @@ import { lowerCase } from "../index"; -export = lowerCase; \ No newline at end of file +export = lowerCase; diff --git a/types/lodash/lowerFirst/index.d.ts b/types/lodash/lowerFirst/index.d.ts index ef7f89f0ad..57d5a9c60e 100644 --- a/types/lodash/lowerFirst/index.d.ts +++ b/types/lodash/lowerFirst/index.d.ts @@ -1,2 +1,2 @@ import { lowerFirst } from "../index"; -export = lowerFirst; \ No newline at end of file +export = lowerFirst; diff --git a/types/lodash/lt/index.d.ts b/types/lodash/lt/index.d.ts index 827f2ea49a..483de251ea 100644 --- a/types/lodash/lt/index.d.ts +++ b/types/lodash/lt/index.d.ts @@ -1,2 +1,2 @@ import { lt } from "../index"; -export = lt; \ No newline at end of file +export = lt; diff --git a/types/lodash/lte/index.d.ts b/types/lodash/lte/index.d.ts index 095b471f0b..62e11824f5 100644 --- a/types/lodash/lte/index.d.ts +++ b/types/lodash/lte/index.d.ts @@ -1,2 +1,2 @@ import { lte } from "../index"; -export = lte; \ No newline at end of file +export = lte; diff --git a/types/lodash/map/index.d.ts b/types/lodash/map/index.d.ts index caf04d4309..055e43250f 100644 --- a/types/lodash/map/index.d.ts +++ b/types/lodash/map/index.d.ts @@ -1,2 +1,2 @@ import { map } from "../index"; -export = map; \ No newline at end of file +export = map; diff --git a/types/lodash/mapKeys/index.d.ts b/types/lodash/mapKeys/index.d.ts index c30ea40d4a..b830255f5e 100644 --- a/types/lodash/mapKeys/index.d.ts +++ b/types/lodash/mapKeys/index.d.ts @@ -1,2 +1,2 @@ import { mapKeys } from "../index"; -export = mapKeys; \ No newline at end of file +export = mapKeys; diff --git a/types/lodash/mapValues/index.d.ts b/types/lodash/mapValues/index.d.ts index 01d43efac4..60df8d2502 100644 --- a/types/lodash/mapValues/index.d.ts +++ b/types/lodash/mapValues/index.d.ts @@ -1,2 +1,2 @@ import { mapValues } from "../index"; -export = mapValues; \ No newline at end of file +export = mapValues; diff --git a/types/lodash/matches/index.d.ts b/types/lodash/matches/index.d.ts index 320bcb1a15..bd88217869 100644 --- a/types/lodash/matches/index.d.ts +++ b/types/lodash/matches/index.d.ts @@ -1,2 +1,2 @@ import { matches } from "../index"; -export = matches; \ No newline at end of file +export = matches; diff --git a/types/lodash/matchesProperty/index.d.ts b/types/lodash/matchesProperty/index.d.ts index 58a98d9619..342aa1c70f 100644 --- a/types/lodash/matchesProperty/index.d.ts +++ b/types/lodash/matchesProperty/index.d.ts @@ -1,2 +1,2 @@ import { matchesProperty } from "../index"; -export = matchesProperty; \ No newline at end of file +export = matchesProperty; diff --git a/types/lodash/max/index.d.ts b/types/lodash/max/index.d.ts index d532530e30..8bce255b0e 100644 --- a/types/lodash/max/index.d.ts +++ b/types/lodash/max/index.d.ts @@ -1,2 +1,2 @@ import { max } from "../index"; -export = max; \ No newline at end of file +export = max; diff --git a/types/lodash/maxBy/index.d.ts b/types/lodash/maxBy/index.d.ts index 2a8f023c94..2a3f4f9e18 100644 --- a/types/lodash/maxBy/index.d.ts +++ b/types/lodash/maxBy/index.d.ts @@ -1,2 +1,2 @@ import { maxBy } from "../index"; -export = maxBy; \ No newline at end of file +export = maxBy; diff --git a/types/lodash/mean/index.d.ts b/types/lodash/mean/index.d.ts index 21e660ab51..0265e22a76 100644 --- a/types/lodash/mean/index.d.ts +++ b/types/lodash/mean/index.d.ts @@ -1,2 +1,2 @@ import { mean } from "../index"; -export = mean; \ No newline at end of file +export = mean; diff --git a/types/lodash/meanBy/index.d.ts b/types/lodash/meanBy/index.d.ts index e4651a4412..58b90c7694 100644 --- a/types/lodash/meanBy/index.d.ts +++ b/types/lodash/meanBy/index.d.ts @@ -1,2 +1,2 @@ import { meanBy } from "../index"; -export = meanBy; \ No newline at end of file +export = meanBy; diff --git a/types/lodash/memoize/index.d.ts b/types/lodash/memoize/index.d.ts index 676d3c7884..ce92f6eba1 100644 --- a/types/lodash/memoize/index.d.ts +++ b/types/lodash/memoize/index.d.ts @@ -1,2 +1,2 @@ import { memoize } from "../index"; -export = memoize; \ No newline at end of file +export = memoize; diff --git a/types/lodash/merge/index.d.ts b/types/lodash/merge/index.d.ts index 5e3ac2b3e1..a2d07fa045 100644 --- a/types/lodash/merge/index.d.ts +++ b/types/lodash/merge/index.d.ts @@ -1,2 +1,2 @@ import { merge } from "../index"; -export = merge; \ No newline at end of file +export = merge; diff --git a/types/lodash/mergeWith/index.d.ts b/types/lodash/mergeWith/index.d.ts index 3141da1f87..bd7b7b2be7 100644 --- a/types/lodash/mergeWith/index.d.ts +++ b/types/lodash/mergeWith/index.d.ts @@ -1,2 +1,2 @@ import { mergeWith } from "../index"; -export = mergeWith; \ No newline at end of file +export = mergeWith; diff --git a/types/lodash/method/index.d.ts b/types/lodash/method/index.d.ts index a2efc6992c..38b265b19a 100644 --- a/types/lodash/method/index.d.ts +++ b/types/lodash/method/index.d.ts @@ -1,2 +1,2 @@ import { method } from "../index"; -export = method; \ No newline at end of file +export = method; diff --git a/types/lodash/methodOf/index.d.ts b/types/lodash/methodOf/index.d.ts index 74c092ea97..817f1518b2 100644 --- a/types/lodash/methodOf/index.d.ts +++ b/types/lodash/methodOf/index.d.ts @@ -1,2 +1,2 @@ import { methodOf } from "../index"; -export = methodOf; \ No newline at end of file +export = methodOf; diff --git a/types/lodash/min/index.d.ts b/types/lodash/min/index.d.ts index 9289b95bbc..1b51b9d6de 100644 --- a/types/lodash/min/index.d.ts +++ b/types/lodash/min/index.d.ts @@ -1,2 +1,2 @@ import { min } from "../index"; -export = min; \ No newline at end of file +export = min; diff --git a/types/lodash/minBy/index.d.ts b/types/lodash/minBy/index.d.ts index 703e8cbf58..4c4b8fb3ae 100644 --- a/types/lodash/minBy/index.d.ts +++ b/types/lodash/minBy/index.d.ts @@ -1,2 +1,2 @@ import { minBy } from "../index"; -export = minBy; \ No newline at end of file +export = minBy; diff --git a/types/lodash/mixin/index.d.ts b/types/lodash/mixin/index.d.ts index fedace0795..7bd81f8005 100644 --- a/types/lodash/mixin/index.d.ts +++ b/types/lodash/mixin/index.d.ts @@ -1,2 +1,2 @@ import { mixin } from "../index"; -export = mixin; \ No newline at end of file +export = mixin; diff --git a/types/lodash/negate/index.d.ts b/types/lodash/negate/index.d.ts index 7020b8f0b1..e538c5cd67 100644 --- a/types/lodash/negate/index.d.ts +++ b/types/lodash/negate/index.d.ts @@ -1,2 +1,2 @@ import { negate } from "../index"; -export = negate; \ No newline at end of file +export = negate; diff --git a/types/lodash/noConflict/index.d.ts b/types/lodash/noConflict/index.d.ts index 1b38b9d530..228f39cae5 100644 --- a/types/lodash/noConflict/index.d.ts +++ b/types/lodash/noConflict/index.d.ts @@ -1,2 +1,2 @@ import { noConflict } from "../index"; -export = noConflict; \ No newline at end of file +export = noConflict; diff --git a/types/lodash/noop/index.d.ts b/types/lodash/noop/index.d.ts index 0ce69cbefa..eb4a36bb7c 100644 --- a/types/lodash/noop/index.d.ts +++ b/types/lodash/noop/index.d.ts @@ -1,2 +1,2 @@ import { noop } from "../index"; -export = noop; \ No newline at end of file +export = noop; diff --git a/types/lodash/now/index.d.ts b/types/lodash/now/index.d.ts index 8f81c014af..b603059fb5 100644 --- a/types/lodash/now/index.d.ts +++ b/types/lodash/now/index.d.ts @@ -1,2 +1,2 @@ import { now } from "../index"; -export = now; \ No newline at end of file +export = now; diff --git a/types/lodash/nth/index.d.ts b/types/lodash/nth/index.d.ts index afbe952398..709c6df8b5 100644 --- a/types/lodash/nth/index.d.ts +++ b/types/lodash/nth/index.d.ts @@ -1,2 +1,2 @@ import { nth } from "../index"; -export = nth; \ No newline at end of file +export = nth; diff --git a/types/lodash/nthArg/index.d.ts b/types/lodash/nthArg/index.d.ts index d2b699e32a..9fd0b4540c 100644 --- a/types/lodash/nthArg/index.d.ts +++ b/types/lodash/nthArg/index.d.ts @@ -1,2 +1,2 @@ import { nthArg } from "../index"; -export = nthArg; \ No newline at end of file +export = nthArg; diff --git a/types/lodash/omit/index.d.ts b/types/lodash/omit/index.d.ts index c474c36895..3c92d6293e 100644 --- a/types/lodash/omit/index.d.ts +++ b/types/lodash/omit/index.d.ts @@ -1,2 +1,2 @@ import { omit } from "../index"; -export = omit; \ No newline at end of file +export = omit; diff --git a/types/lodash/omitBy/index.d.ts b/types/lodash/omitBy/index.d.ts index f91e134545..d92d14852e 100644 --- a/types/lodash/omitBy/index.d.ts +++ b/types/lodash/omitBy/index.d.ts @@ -1,2 +1,2 @@ import { omitBy } from "../index"; -export = omitBy; \ No newline at end of file +export = omitBy; diff --git a/types/lodash/once/index.d.ts b/types/lodash/once/index.d.ts index eca2c3fbc0..369fcc08ac 100644 --- a/types/lodash/once/index.d.ts +++ b/types/lodash/once/index.d.ts @@ -1,2 +1,2 @@ import { once } from "../index"; -export = once; \ No newline at end of file +export = once; diff --git a/types/lodash/orderBy/index.d.ts b/types/lodash/orderBy/index.d.ts index 9283bbba9e..57dc0723d8 100644 --- a/types/lodash/orderBy/index.d.ts +++ b/types/lodash/orderBy/index.d.ts @@ -1,2 +1,2 @@ import { orderBy } from "../index"; -export = orderBy; \ No newline at end of file +export = orderBy; diff --git a/types/lodash/over/index.d.ts b/types/lodash/over/index.d.ts index 631a2a3cc3..0f92ad9429 100644 --- a/types/lodash/over/index.d.ts +++ b/types/lodash/over/index.d.ts @@ -1,2 +1,2 @@ import { over } from "../index"; -export = over; \ No newline at end of file +export = over; diff --git a/types/lodash/overArgs/index.d.ts b/types/lodash/overArgs/index.d.ts index aa8cf236e8..07f93f9698 100644 --- a/types/lodash/overArgs/index.d.ts +++ b/types/lodash/overArgs/index.d.ts @@ -1,2 +1,2 @@ import { overArgs } from "../index"; -export = overArgs; \ No newline at end of file +export = overArgs; diff --git a/types/lodash/overEvery/index.d.ts b/types/lodash/overEvery/index.d.ts index d0fa45c9d3..8533d45602 100644 --- a/types/lodash/overEvery/index.d.ts +++ b/types/lodash/overEvery/index.d.ts @@ -1,2 +1,2 @@ import { overEvery } from "../index"; -export = overEvery; \ No newline at end of file +export = overEvery; diff --git a/types/lodash/overSome/index.d.ts b/types/lodash/overSome/index.d.ts index 3bc6bfff2b..5d27576568 100644 --- a/types/lodash/overSome/index.d.ts +++ b/types/lodash/overSome/index.d.ts @@ -1,2 +1,2 @@ import { overSome } from "../index"; -export = overSome; \ No newline at end of file +export = overSome; diff --git a/types/lodash/pad/index.d.ts b/types/lodash/pad/index.d.ts index 331e55c5cf..00cd386111 100644 --- a/types/lodash/pad/index.d.ts +++ b/types/lodash/pad/index.d.ts @@ -1,2 +1,2 @@ import { pad } from "../index"; -export = pad; \ No newline at end of file +export = pad; diff --git a/types/lodash/padEnd/index.d.ts b/types/lodash/padEnd/index.d.ts index 2223f7a60e..6cc4425148 100644 --- a/types/lodash/padEnd/index.d.ts +++ b/types/lodash/padEnd/index.d.ts @@ -1,2 +1,2 @@ import { padEnd } from "../index"; -export = padEnd; \ No newline at end of file +export = padEnd; diff --git a/types/lodash/padStart/index.d.ts b/types/lodash/padStart/index.d.ts index 1c3da5ff91..e2d9f9bf86 100644 --- a/types/lodash/padStart/index.d.ts +++ b/types/lodash/padStart/index.d.ts @@ -1,2 +1,2 @@ import { padStart } from "../index"; -export = padStart; \ No newline at end of file +export = padStart; diff --git a/types/lodash/parseInt/index.d.ts b/types/lodash/parseInt/index.d.ts index 47ec8282b4..8efd3cb6fc 100644 --- a/types/lodash/parseInt/index.d.ts +++ b/types/lodash/parseInt/index.d.ts @@ -1,2 +1,2 @@ import { parseInt } from "../index"; -export = parseInt; \ No newline at end of file +export = parseInt; diff --git a/types/lodash/partial/index.d.ts b/types/lodash/partial/index.d.ts index 3b32f1d962..8c7ee10740 100644 --- a/types/lodash/partial/index.d.ts +++ b/types/lodash/partial/index.d.ts @@ -1,2 +1,2 @@ import { partial } from "../index"; -export = partial; \ No newline at end of file +export = partial; diff --git a/types/lodash/partialRight/index.d.ts b/types/lodash/partialRight/index.d.ts index d13a6c73d3..c6f1c8acde 100644 --- a/types/lodash/partialRight/index.d.ts +++ b/types/lodash/partialRight/index.d.ts @@ -1,2 +1,2 @@ import { partialRight } from "../index"; -export = partialRight; \ No newline at end of file +export = partialRight; diff --git a/types/lodash/partition/index.d.ts b/types/lodash/partition/index.d.ts index 3bd1cd7715..1cd0cc12b3 100644 --- a/types/lodash/partition/index.d.ts +++ b/types/lodash/partition/index.d.ts @@ -1,2 +1,2 @@ import { partition } from "../index"; -export = partition; \ No newline at end of file +export = partition; diff --git a/types/lodash/pick/index.d.ts b/types/lodash/pick/index.d.ts index 287e6bfd66..33d5b2fbe0 100644 --- a/types/lodash/pick/index.d.ts +++ b/types/lodash/pick/index.d.ts @@ -1,2 +1,2 @@ import { pick } from "../index"; -export = pick; \ No newline at end of file +export = pick; diff --git a/types/lodash/pickBy/index.d.ts b/types/lodash/pickBy/index.d.ts index 92da32054a..7b4da3a299 100644 --- a/types/lodash/pickBy/index.d.ts +++ b/types/lodash/pickBy/index.d.ts @@ -1,2 +1,2 @@ import { pickBy } from "../index"; -export = pickBy; \ No newline at end of file +export = pickBy; diff --git a/types/lodash/property/index.d.ts b/types/lodash/property/index.d.ts index d57f4d0775..99d8057c4f 100644 --- a/types/lodash/property/index.d.ts +++ b/types/lodash/property/index.d.ts @@ -1,2 +1,2 @@ import { property } from "../index"; -export = property; \ No newline at end of file +export = property; diff --git a/types/lodash/propertyOf/index.d.ts b/types/lodash/propertyOf/index.d.ts index b10c8ebd0c..68e4a6ae85 100644 --- a/types/lodash/propertyOf/index.d.ts +++ b/types/lodash/propertyOf/index.d.ts @@ -1,2 +1,2 @@ import { propertyOf } from "../index"; -export = propertyOf; \ No newline at end of file +export = propertyOf; diff --git a/types/lodash/pull/index.d.ts b/types/lodash/pull/index.d.ts index 7716f98234..69696c43e1 100644 --- a/types/lodash/pull/index.d.ts +++ b/types/lodash/pull/index.d.ts @@ -1,2 +1,2 @@ import { pull } from "../index"; -export = pull; \ No newline at end of file +export = pull; diff --git a/types/lodash/pullAll/index.d.ts b/types/lodash/pullAll/index.d.ts index f39bbd2db7..32aa606b03 100644 --- a/types/lodash/pullAll/index.d.ts +++ b/types/lodash/pullAll/index.d.ts @@ -1,2 +1,2 @@ import { pullAll } from "../index"; -export = pullAll; \ No newline at end of file +export = pullAll; diff --git a/types/lodash/pullAllBy/index.d.ts b/types/lodash/pullAllBy/index.d.ts index acd205768b..4b8ff6da5b 100644 --- a/types/lodash/pullAllBy/index.d.ts +++ b/types/lodash/pullAllBy/index.d.ts @@ -1,2 +1,2 @@ import { pullAllBy } from "../index"; -export = pullAllBy; \ No newline at end of file +export = pullAllBy; diff --git a/types/lodash/pullAt/index.d.ts b/types/lodash/pullAt/index.d.ts index a036de7324..3019515a8e 100644 --- a/types/lodash/pullAt/index.d.ts +++ b/types/lodash/pullAt/index.d.ts @@ -1,2 +1,2 @@ import { pullAt } from "../index"; -export = pullAt; \ No newline at end of file +export = pullAt; diff --git a/types/lodash/random/index.d.ts b/types/lodash/random/index.d.ts index 5d9cfe9102..7116b7df74 100644 --- a/types/lodash/random/index.d.ts +++ b/types/lodash/random/index.d.ts @@ -1,2 +1,2 @@ import { random } from "../index"; -export = random; \ No newline at end of file +export = random; diff --git a/types/lodash/range/index.d.ts b/types/lodash/range/index.d.ts index 3cbc7f9937..ba9ec7c4e2 100644 --- a/types/lodash/range/index.d.ts +++ b/types/lodash/range/index.d.ts @@ -1,2 +1,2 @@ import { range } from "../index"; -export = range; \ No newline at end of file +export = range; diff --git a/types/lodash/rangeRight/index.d.ts b/types/lodash/rangeRight/index.d.ts index 19d62a7b10..7cead2895f 100644 --- a/types/lodash/rangeRight/index.d.ts +++ b/types/lodash/rangeRight/index.d.ts @@ -1,2 +1,2 @@ import { rangeRight } from "../index"; -export = rangeRight; \ No newline at end of file +export = rangeRight; diff --git a/types/lodash/rearg/index.d.ts b/types/lodash/rearg/index.d.ts index 2553b2243a..9fd61a68e0 100644 --- a/types/lodash/rearg/index.d.ts +++ b/types/lodash/rearg/index.d.ts @@ -1,2 +1,2 @@ import { rearg } from "../index"; -export = rearg; \ No newline at end of file +export = rearg; diff --git a/types/lodash/reduce/index.d.ts b/types/lodash/reduce/index.d.ts index 3e4af8bdc1..0137ae329d 100644 --- a/types/lodash/reduce/index.d.ts +++ b/types/lodash/reduce/index.d.ts @@ -1,2 +1,2 @@ import { reduce } from "../index"; -export = reduce; \ No newline at end of file +export = reduce; diff --git a/types/lodash/reduceRight/index.d.ts b/types/lodash/reduceRight/index.d.ts index f0dbae92a0..4853cbd33f 100644 --- a/types/lodash/reduceRight/index.d.ts +++ b/types/lodash/reduceRight/index.d.ts @@ -1,2 +1,2 @@ import { reduceRight } from "../index"; -export = reduceRight; \ No newline at end of file +export = reduceRight; diff --git a/types/lodash/reject/index.d.ts b/types/lodash/reject/index.d.ts index 6088450a69..a3829a3781 100644 --- a/types/lodash/reject/index.d.ts +++ b/types/lodash/reject/index.d.ts @@ -1,2 +1,2 @@ import { reject } from "../index"; -export = reject; \ No newline at end of file +export = reject; diff --git a/types/lodash/remove/index.d.ts b/types/lodash/remove/index.d.ts index 7b5726e971..75f0141175 100644 --- a/types/lodash/remove/index.d.ts +++ b/types/lodash/remove/index.d.ts @@ -1,2 +1,2 @@ import { remove } from "../index"; -export = remove; \ No newline at end of file +export = remove; diff --git a/types/lodash/repeat/index.d.ts b/types/lodash/repeat/index.d.ts index 9cd920ba5d..9c8b314c7d 100644 --- a/types/lodash/repeat/index.d.ts +++ b/types/lodash/repeat/index.d.ts @@ -1,2 +1,2 @@ import { repeat } from "../index"; -export = repeat; \ No newline at end of file +export = repeat; diff --git a/types/lodash/replace/index.d.ts b/types/lodash/replace/index.d.ts index ba0c9e6a96..7ca7a89276 100644 --- a/types/lodash/replace/index.d.ts +++ b/types/lodash/replace/index.d.ts @@ -1,2 +1,2 @@ import { replace } from "../index"; -export = replace; \ No newline at end of file +export = replace; diff --git a/types/lodash/rest/index.d.ts b/types/lodash/rest/index.d.ts index f8a93de5d8..482d23ae13 100644 --- a/types/lodash/rest/index.d.ts +++ b/types/lodash/rest/index.d.ts @@ -1,2 +1,2 @@ import { rest } from "../index"; -export = rest; \ No newline at end of file +export = rest; diff --git a/types/lodash/result/index.d.ts b/types/lodash/result/index.d.ts index a2d1f8b511..86677691e2 100644 --- a/types/lodash/result/index.d.ts +++ b/types/lodash/result/index.d.ts @@ -1,2 +1,2 @@ import { result } from "../index"; -export = result; \ No newline at end of file +export = result; diff --git a/types/lodash/reverse/index.d.ts b/types/lodash/reverse/index.d.ts index e689c4b0eb..47783137c1 100644 --- a/types/lodash/reverse/index.d.ts +++ b/types/lodash/reverse/index.d.ts @@ -1,2 +1,2 @@ import { reverse } from "../index"; -export = reverse; \ No newline at end of file +export = reverse; diff --git a/types/lodash/round/index.d.ts b/types/lodash/round/index.d.ts index e369276c67..84d6bb4646 100644 --- a/types/lodash/round/index.d.ts +++ b/types/lodash/round/index.d.ts @@ -1,2 +1,2 @@ import { round } from "../index"; -export = round; \ No newline at end of file +export = round; diff --git a/types/lodash/runInContext/index.d.ts b/types/lodash/runInContext/index.d.ts index b6b9ca8883..4d14f9de1f 100644 --- a/types/lodash/runInContext/index.d.ts +++ b/types/lodash/runInContext/index.d.ts @@ -1,2 +1,2 @@ import { runInContext } from "../index"; -export = runInContext; \ No newline at end of file +export = runInContext; diff --git a/types/lodash/sample/index.d.ts b/types/lodash/sample/index.d.ts index c3097d2b67..9c73951cb9 100644 --- a/types/lodash/sample/index.d.ts +++ b/types/lodash/sample/index.d.ts @@ -1,2 +1,2 @@ import { sample } from "../index"; -export = sample; \ No newline at end of file +export = sample; diff --git a/types/lodash/sampleSize/index.d.ts b/types/lodash/sampleSize/index.d.ts index 77208b933c..0f4b02cd60 100644 --- a/types/lodash/sampleSize/index.d.ts +++ b/types/lodash/sampleSize/index.d.ts @@ -1,2 +1,2 @@ import { sampleSize } from "../index"; -export = sampleSize; \ No newline at end of file +export = sampleSize; diff --git a/types/lodash/scripts/generate-modules.ts b/types/lodash/scripts/generate-modules.ts index 3bc3190f85..69b8e178b0 100644 --- a/types/lodash/scripts/generate-modules.ts +++ b/types/lodash/scripts/generate-modules.ts @@ -23,7 +23,7 @@ async function main() { // Generate local module const localDir = path.join("..", module); ensureDir(localDir); - fs.writeFileSync(path.join(localDir, "index.d.ts"), `import { ${module} } from "../index";\nexport = ${module};`); + fs.writeFileSync(path.join(localDir, "index.d.ts"), `import { ${module} } from "../index";\nexport = ${module};\n`); // Generate non-local module if (!notOnNpm.has(module)) { diff --git a/types/lodash/set/index.d.ts b/types/lodash/set/index.d.ts index d5b68f01d8..8a61f06eaa 100644 --- a/types/lodash/set/index.d.ts +++ b/types/lodash/set/index.d.ts @@ -1,2 +1,2 @@ import { set } from "../index"; -export = set; \ No newline at end of file +export = set; diff --git a/types/lodash/setWith/index.d.ts b/types/lodash/setWith/index.d.ts index 8c4353054c..358eab644e 100644 --- a/types/lodash/setWith/index.d.ts +++ b/types/lodash/setWith/index.d.ts @@ -1,2 +1,2 @@ import { setWith } from "../index"; -export = setWith; \ No newline at end of file +export = setWith; diff --git a/types/lodash/shuffle/index.d.ts b/types/lodash/shuffle/index.d.ts index 50f7fafddd..161b303cc6 100644 --- a/types/lodash/shuffle/index.d.ts +++ b/types/lodash/shuffle/index.d.ts @@ -1,2 +1,2 @@ import { shuffle } from "../index"; -export = shuffle; \ No newline at end of file +export = shuffle; diff --git a/types/lodash/size/index.d.ts b/types/lodash/size/index.d.ts index cec775d6b4..8880bf0192 100644 --- a/types/lodash/size/index.d.ts +++ b/types/lodash/size/index.d.ts @@ -1,2 +1,2 @@ import { size } from "../index"; -export = size; \ No newline at end of file +export = size; diff --git a/types/lodash/slice/index.d.ts b/types/lodash/slice/index.d.ts index 326dbd4235..0a01a3b37b 100644 --- a/types/lodash/slice/index.d.ts +++ b/types/lodash/slice/index.d.ts @@ -1,2 +1,2 @@ import { slice } from "../index"; -export = slice; \ No newline at end of file +export = slice; diff --git a/types/lodash/snakeCase/index.d.ts b/types/lodash/snakeCase/index.d.ts index 9248ebcb68..83a69eed7d 100644 --- a/types/lodash/snakeCase/index.d.ts +++ b/types/lodash/snakeCase/index.d.ts @@ -1,2 +1,2 @@ import { snakeCase } from "../index"; -export = snakeCase; \ No newline at end of file +export = snakeCase; diff --git a/types/lodash/some/index.d.ts b/types/lodash/some/index.d.ts index 5f687f85a5..737e5026a0 100644 --- a/types/lodash/some/index.d.ts +++ b/types/lodash/some/index.d.ts @@ -1,2 +1,2 @@ import { some } from "../index"; -export = some; \ No newline at end of file +export = some; diff --git a/types/lodash/sortBy/index.d.ts b/types/lodash/sortBy/index.d.ts index ccfb52f54d..f25a80ef63 100644 --- a/types/lodash/sortBy/index.d.ts +++ b/types/lodash/sortBy/index.d.ts @@ -1,2 +1,2 @@ import { sortBy } from "../index"; -export = sortBy; \ No newline at end of file +export = sortBy; diff --git a/types/lodash/sortedIndex/index.d.ts b/types/lodash/sortedIndex/index.d.ts index 82619b92b3..752e42308c 100644 --- a/types/lodash/sortedIndex/index.d.ts +++ b/types/lodash/sortedIndex/index.d.ts @@ -1,2 +1,2 @@ import { sortedIndex } from "../index"; -export = sortedIndex; \ No newline at end of file +export = sortedIndex; diff --git a/types/lodash/sortedIndexBy/index.d.ts b/types/lodash/sortedIndexBy/index.d.ts index 201307f855..de6c51ad0f 100644 --- a/types/lodash/sortedIndexBy/index.d.ts +++ b/types/lodash/sortedIndexBy/index.d.ts @@ -1,2 +1,2 @@ import { sortedIndexBy } from "../index"; -export = sortedIndexBy; \ No newline at end of file +export = sortedIndexBy; diff --git a/types/lodash/sortedIndexOf/index.d.ts b/types/lodash/sortedIndexOf/index.d.ts index fd3d7e7bcd..4ee1da9b33 100644 --- a/types/lodash/sortedIndexOf/index.d.ts +++ b/types/lodash/sortedIndexOf/index.d.ts @@ -1,2 +1,2 @@ import { sortedIndexOf } from "../index"; -export = sortedIndexOf; \ No newline at end of file +export = sortedIndexOf; diff --git a/types/lodash/sortedLastIndex/index.d.ts b/types/lodash/sortedLastIndex/index.d.ts index 8ec4d0e9e9..5a2d225624 100644 --- a/types/lodash/sortedLastIndex/index.d.ts +++ b/types/lodash/sortedLastIndex/index.d.ts @@ -1,2 +1,2 @@ import { sortedLastIndex } from "../index"; -export = sortedLastIndex; \ No newline at end of file +export = sortedLastIndex; diff --git a/types/lodash/sortedLastIndexBy/index.d.ts b/types/lodash/sortedLastIndexBy/index.d.ts index d0846cb4e4..18b961a312 100644 --- a/types/lodash/sortedLastIndexBy/index.d.ts +++ b/types/lodash/sortedLastIndexBy/index.d.ts @@ -1,2 +1,2 @@ import { sortedLastIndexBy } from "../index"; -export = sortedLastIndexBy; \ No newline at end of file +export = sortedLastIndexBy; diff --git a/types/lodash/sortedLastIndexOf/index.d.ts b/types/lodash/sortedLastIndexOf/index.d.ts index e65393da6c..84970275ed 100644 --- a/types/lodash/sortedLastIndexOf/index.d.ts +++ b/types/lodash/sortedLastIndexOf/index.d.ts @@ -1,2 +1,2 @@ import { sortedLastIndexOf } from "../index"; -export = sortedLastIndexOf; \ No newline at end of file +export = sortedLastIndexOf; diff --git a/types/lodash/sortedUniq/index.d.ts b/types/lodash/sortedUniq/index.d.ts index af5960f98d..d4a19d27cb 100644 --- a/types/lodash/sortedUniq/index.d.ts +++ b/types/lodash/sortedUniq/index.d.ts @@ -1,2 +1,2 @@ import { sortedUniq } from "../index"; -export = sortedUniq; \ No newline at end of file +export = sortedUniq; diff --git a/types/lodash/sortedUniqBy/index.d.ts b/types/lodash/sortedUniqBy/index.d.ts index 5ce03e8e78..a8e310ad3f 100644 --- a/types/lodash/sortedUniqBy/index.d.ts +++ b/types/lodash/sortedUniqBy/index.d.ts @@ -1,2 +1,2 @@ import { sortedUniqBy } from "../index"; -export = sortedUniqBy; \ No newline at end of file +export = sortedUniqBy; diff --git a/types/lodash/split/index.d.ts b/types/lodash/split/index.d.ts index cdf59fb9a7..15e23e48d9 100644 --- a/types/lodash/split/index.d.ts +++ b/types/lodash/split/index.d.ts @@ -1,2 +1,2 @@ import { split } from "../index"; -export = split; \ No newline at end of file +export = split; diff --git a/types/lodash/spread/index.d.ts b/types/lodash/spread/index.d.ts index 49214fa68d..eb27ed2f74 100644 --- a/types/lodash/spread/index.d.ts +++ b/types/lodash/spread/index.d.ts @@ -1,2 +1,2 @@ import { spread } from "../index"; -export = spread; \ No newline at end of file +export = spread; diff --git a/types/lodash/startCase/index.d.ts b/types/lodash/startCase/index.d.ts index f46a84c55a..8a6b629293 100644 --- a/types/lodash/startCase/index.d.ts +++ b/types/lodash/startCase/index.d.ts @@ -1,2 +1,2 @@ import { startCase } from "../index"; -export = startCase; \ No newline at end of file +export = startCase; diff --git a/types/lodash/startsWith/index.d.ts b/types/lodash/startsWith/index.d.ts index d0bc2d6110..96410734dd 100644 --- a/types/lodash/startsWith/index.d.ts +++ b/types/lodash/startsWith/index.d.ts @@ -1,2 +1,2 @@ import { startsWith } from "../index"; -export = startsWith; \ No newline at end of file +export = startsWith; diff --git a/types/lodash/subtract/index.d.ts b/types/lodash/subtract/index.d.ts index d802dccc59..30e5c0f374 100644 --- a/types/lodash/subtract/index.d.ts +++ b/types/lodash/subtract/index.d.ts @@ -1,2 +1,2 @@ import { subtract } from "../index"; -export = subtract; \ No newline at end of file +export = subtract; diff --git a/types/lodash/sum/index.d.ts b/types/lodash/sum/index.d.ts index 011a16d554..d861fe54b4 100644 --- a/types/lodash/sum/index.d.ts +++ b/types/lodash/sum/index.d.ts @@ -1,2 +1,2 @@ import { sum } from "../index"; -export = sum; \ No newline at end of file +export = sum; diff --git a/types/lodash/sumBy/index.d.ts b/types/lodash/sumBy/index.d.ts index 642b734092..edfadab963 100644 --- a/types/lodash/sumBy/index.d.ts +++ b/types/lodash/sumBy/index.d.ts @@ -1,2 +1,2 @@ import { sumBy } from "../index"; -export = sumBy; \ No newline at end of file +export = sumBy; diff --git a/types/lodash/tail/index.d.ts b/types/lodash/tail/index.d.ts index ab8b30bba0..7c16421431 100644 --- a/types/lodash/tail/index.d.ts +++ b/types/lodash/tail/index.d.ts @@ -1,2 +1,2 @@ import { tail } from "../index"; -export = tail; \ No newline at end of file +export = tail; diff --git a/types/lodash/take/index.d.ts b/types/lodash/take/index.d.ts index b9de51879b..09acc7cc67 100644 --- a/types/lodash/take/index.d.ts +++ b/types/lodash/take/index.d.ts @@ -1,2 +1,2 @@ import { take } from "../index"; -export = take; \ No newline at end of file +export = take; diff --git a/types/lodash/takeRight/index.d.ts b/types/lodash/takeRight/index.d.ts index ddc1dab3f2..f5f0829506 100644 --- a/types/lodash/takeRight/index.d.ts +++ b/types/lodash/takeRight/index.d.ts @@ -1,2 +1,2 @@ import { takeRight } from "../index"; -export = takeRight; \ No newline at end of file +export = takeRight; diff --git a/types/lodash/takeRightWhile/index.d.ts b/types/lodash/takeRightWhile/index.d.ts index ff42088754..3b3a4c5264 100644 --- a/types/lodash/takeRightWhile/index.d.ts +++ b/types/lodash/takeRightWhile/index.d.ts @@ -1,2 +1,2 @@ import { takeRightWhile } from "../index"; -export = takeRightWhile; \ No newline at end of file +export = takeRightWhile; diff --git a/types/lodash/takeWhile/index.d.ts b/types/lodash/takeWhile/index.d.ts index 4b6548a649..2cd57257e2 100644 --- a/types/lodash/takeWhile/index.d.ts +++ b/types/lodash/takeWhile/index.d.ts @@ -1,2 +1,2 @@ import { takeWhile } from "../index"; -export = takeWhile; \ No newline at end of file +export = takeWhile; diff --git a/types/lodash/tap/index.d.ts b/types/lodash/tap/index.d.ts index 1af8eccefd..26c6c1dfd8 100644 --- a/types/lodash/tap/index.d.ts +++ b/types/lodash/tap/index.d.ts @@ -1,2 +1,2 @@ import { tap } from "../index"; -export = tap; \ No newline at end of file +export = tap; diff --git a/types/lodash/template/index.d.ts b/types/lodash/template/index.d.ts index 465b01d7f8..898eb4b44e 100644 --- a/types/lodash/template/index.d.ts +++ b/types/lodash/template/index.d.ts @@ -1,2 +1,2 @@ import { template } from "../index"; -export = template; \ No newline at end of file +export = template; diff --git a/types/lodash/throttle/index.d.ts b/types/lodash/throttle/index.d.ts index dee71aae98..ba7f353aeb 100644 --- a/types/lodash/throttle/index.d.ts +++ b/types/lodash/throttle/index.d.ts @@ -1,2 +1,2 @@ import { throttle } from "../index"; -export = throttle; \ No newline at end of file +export = throttle; diff --git a/types/lodash/thru/index.d.ts b/types/lodash/thru/index.d.ts index 70245825d9..c23ea4f7f8 100644 --- a/types/lodash/thru/index.d.ts +++ b/types/lodash/thru/index.d.ts @@ -1,2 +1,2 @@ import { thru } from "../index"; -export = thru; \ No newline at end of file +export = thru; diff --git a/types/lodash/times/index.d.ts b/types/lodash/times/index.d.ts index 7da9c6763f..53ce4b64da 100644 --- a/types/lodash/times/index.d.ts +++ b/types/lodash/times/index.d.ts @@ -1,2 +1,2 @@ import { times } from "../index"; -export = times; \ No newline at end of file +export = times; diff --git a/types/lodash/toArray/index.d.ts b/types/lodash/toArray/index.d.ts index 5f1b4b5e89..a78ca2b2cd 100644 --- a/types/lodash/toArray/index.d.ts +++ b/types/lodash/toArray/index.d.ts @@ -1,2 +1,2 @@ import { toArray } from "../index"; -export = toArray; \ No newline at end of file +export = toArray; diff --git a/types/lodash/toInteger/index.d.ts b/types/lodash/toInteger/index.d.ts index cb600f94f2..90415a1155 100644 --- a/types/lodash/toInteger/index.d.ts +++ b/types/lodash/toInteger/index.d.ts @@ -1,2 +1,2 @@ import { toInteger } from "../index"; -export = toInteger; \ No newline at end of file +export = toInteger; diff --git a/types/lodash/toLength/index.d.ts b/types/lodash/toLength/index.d.ts index 04080ab623..1efae9b628 100644 --- a/types/lodash/toLength/index.d.ts +++ b/types/lodash/toLength/index.d.ts @@ -1,2 +1,2 @@ import { toLength } from "../index"; -export = toLength; \ No newline at end of file +export = toLength; diff --git a/types/lodash/toLower/index.d.ts b/types/lodash/toLower/index.d.ts index d264d11bb2..9a8690312f 100644 --- a/types/lodash/toLower/index.d.ts +++ b/types/lodash/toLower/index.d.ts @@ -1,2 +1,2 @@ import { toLower } from "../index"; -export = toLower; \ No newline at end of file +export = toLower; diff --git a/types/lodash/toNumber/index.d.ts b/types/lodash/toNumber/index.d.ts index 0f706b4373..59c0521e63 100644 --- a/types/lodash/toNumber/index.d.ts +++ b/types/lodash/toNumber/index.d.ts @@ -1,2 +1,2 @@ import { toNumber } from "../index"; -export = toNumber; \ No newline at end of file +export = toNumber; diff --git a/types/lodash/toPairs/index.d.ts b/types/lodash/toPairs/index.d.ts index a0b3265c0c..500242710c 100644 --- a/types/lodash/toPairs/index.d.ts +++ b/types/lodash/toPairs/index.d.ts @@ -1,2 +1,2 @@ import { toPairs } from "../index"; -export = toPairs; \ No newline at end of file +export = toPairs; diff --git a/types/lodash/toPairsIn/index.d.ts b/types/lodash/toPairsIn/index.d.ts index d0193b6847..4d7f61b9dd 100644 --- a/types/lodash/toPairsIn/index.d.ts +++ b/types/lodash/toPairsIn/index.d.ts @@ -1,2 +1,2 @@ import { toPairsIn } from "../index"; -export = toPairsIn; \ No newline at end of file +export = toPairsIn; diff --git a/types/lodash/toPath/index.d.ts b/types/lodash/toPath/index.d.ts index 0c0f16d60c..23912d9437 100644 --- a/types/lodash/toPath/index.d.ts +++ b/types/lodash/toPath/index.d.ts @@ -1,2 +1,2 @@ import { toPath } from "../index"; -export = toPath; \ No newline at end of file +export = toPath; diff --git a/types/lodash/toPlainObject/index.d.ts b/types/lodash/toPlainObject/index.d.ts index 0bf86dae50..3a9298e1e3 100644 --- a/types/lodash/toPlainObject/index.d.ts +++ b/types/lodash/toPlainObject/index.d.ts @@ -1,2 +1,2 @@ import { toPlainObject } from "../index"; -export = toPlainObject; \ No newline at end of file +export = toPlainObject; diff --git a/types/lodash/toSafeInteger/index.d.ts b/types/lodash/toSafeInteger/index.d.ts index e7237d1ff9..4838cd8eba 100644 --- a/types/lodash/toSafeInteger/index.d.ts +++ b/types/lodash/toSafeInteger/index.d.ts @@ -1,2 +1,2 @@ import { toSafeInteger } from "../index"; -export = toSafeInteger; \ No newline at end of file +export = toSafeInteger; diff --git a/types/lodash/toString/index.d.ts b/types/lodash/toString/index.d.ts index f2cea86234..bfc2d699df 100644 --- a/types/lodash/toString/index.d.ts +++ b/types/lodash/toString/index.d.ts @@ -1,2 +1,2 @@ import { toString } from "../index"; -export = toString; \ No newline at end of file +export = toString; diff --git a/types/lodash/toUpper/index.d.ts b/types/lodash/toUpper/index.d.ts index c5b1ec212d..d191b6cb23 100644 --- a/types/lodash/toUpper/index.d.ts +++ b/types/lodash/toUpper/index.d.ts @@ -1,2 +1,2 @@ import { toUpper } from "../index"; -export = toUpper; \ No newline at end of file +export = toUpper; diff --git a/types/lodash/transform/index.d.ts b/types/lodash/transform/index.d.ts index ffa0169325..266d50f504 100644 --- a/types/lodash/transform/index.d.ts +++ b/types/lodash/transform/index.d.ts @@ -1,2 +1,2 @@ import { transform } from "../index"; -export = transform; \ No newline at end of file +export = transform; diff --git a/types/lodash/trim/index.d.ts b/types/lodash/trim/index.d.ts index 86117b38d2..0a6e07d1c3 100644 --- a/types/lodash/trim/index.d.ts +++ b/types/lodash/trim/index.d.ts @@ -1,2 +1,2 @@ import { trim } from "../index"; -export = trim; \ No newline at end of file +export = trim; diff --git a/types/lodash/trimEnd/index.d.ts b/types/lodash/trimEnd/index.d.ts index 83f6445934..c01d487ffa 100644 --- a/types/lodash/trimEnd/index.d.ts +++ b/types/lodash/trimEnd/index.d.ts @@ -1,2 +1,2 @@ import { trimEnd } from "../index"; -export = trimEnd; \ No newline at end of file +export = trimEnd; diff --git a/types/lodash/trimStart/index.d.ts b/types/lodash/trimStart/index.d.ts index ed7e9afb33..478d4f8fb5 100644 --- a/types/lodash/trimStart/index.d.ts +++ b/types/lodash/trimStart/index.d.ts @@ -1,2 +1,2 @@ import { trimStart } from "../index"; -export = trimStart; \ No newline at end of file +export = trimStart; diff --git a/types/lodash/truncate/index.d.ts b/types/lodash/truncate/index.d.ts index e152c53d3b..0d8b7d96a2 100644 --- a/types/lodash/truncate/index.d.ts +++ b/types/lodash/truncate/index.d.ts @@ -1,2 +1,2 @@ import { truncate } from "../index"; -export = truncate; \ No newline at end of file +export = truncate; diff --git a/types/lodash/tslint.json b/types/lodash/tslint.json index 62d13dc883..7805e0387d 100644 --- a/types/lodash/tslint.json +++ b/types/lodash/tslint.json @@ -4,7 +4,7 @@ "array-type": false, "callable-types": false, "comment-format": false, - "forbidden-types": false, + "ban-types": false, "interface-name": false, "interface-over-type-literal": false, "max-line-length": false, diff --git a/types/lodash/unary/index.d.ts b/types/lodash/unary/index.d.ts index d7c0bd0558..2ffc81ae86 100644 --- a/types/lodash/unary/index.d.ts +++ b/types/lodash/unary/index.d.ts @@ -1,2 +1,2 @@ import { unary } from "../index"; -export = unary; \ No newline at end of file +export = unary; diff --git a/types/lodash/unescape/index.d.ts b/types/lodash/unescape/index.d.ts index 1af1f917b7..a830cd17b6 100644 --- a/types/lodash/unescape/index.d.ts +++ b/types/lodash/unescape/index.d.ts @@ -1,2 +1,2 @@ import { unescape } from "../index"; -export = unescape; \ No newline at end of file +export = unescape; diff --git a/types/lodash/union/index.d.ts b/types/lodash/union/index.d.ts index 03bb0d6a9c..4372f5b359 100644 --- a/types/lodash/union/index.d.ts +++ b/types/lodash/union/index.d.ts @@ -1,2 +1,2 @@ import { union } from "../index"; -export = union; \ No newline at end of file +export = union; diff --git a/types/lodash/unionBy/index.d.ts b/types/lodash/unionBy/index.d.ts index 6ec5957241..92e877b02a 100644 --- a/types/lodash/unionBy/index.d.ts +++ b/types/lodash/unionBy/index.d.ts @@ -1,2 +1,2 @@ import { unionBy } from "../index"; -export = unionBy; \ No newline at end of file +export = unionBy; diff --git a/types/lodash/unionWith/index.d.ts b/types/lodash/unionWith/index.d.ts index 16f5cfe660..cc13611e47 100644 --- a/types/lodash/unionWith/index.d.ts +++ b/types/lodash/unionWith/index.d.ts @@ -1,2 +1,2 @@ import { unionWith } from "../index"; -export = unionWith; \ No newline at end of file +export = unionWith; diff --git a/types/lodash/uniq/index.d.ts b/types/lodash/uniq/index.d.ts index 4d10a58c54..2a900a0547 100644 --- a/types/lodash/uniq/index.d.ts +++ b/types/lodash/uniq/index.d.ts @@ -1,2 +1,2 @@ import { uniq } from "../index"; -export = uniq; \ No newline at end of file +export = uniq; diff --git a/types/lodash/uniqBy/index.d.ts b/types/lodash/uniqBy/index.d.ts index afca1fccb8..849bf7c291 100644 --- a/types/lodash/uniqBy/index.d.ts +++ b/types/lodash/uniqBy/index.d.ts @@ -1,2 +1,2 @@ import { uniqBy } from "../index"; -export = uniqBy; \ No newline at end of file +export = uniqBy; diff --git a/types/lodash/uniqWith/index.d.ts b/types/lodash/uniqWith/index.d.ts index 4df7c0934d..a889f887e9 100644 --- a/types/lodash/uniqWith/index.d.ts +++ b/types/lodash/uniqWith/index.d.ts @@ -1,2 +1,2 @@ import { uniqWith } from "../index"; -export = uniqWith; \ No newline at end of file +export = uniqWith; diff --git a/types/lodash/uniqueId/index.d.ts b/types/lodash/uniqueId/index.d.ts index 0aae44d724..6ce0280474 100644 --- a/types/lodash/uniqueId/index.d.ts +++ b/types/lodash/uniqueId/index.d.ts @@ -1,2 +1,2 @@ import { uniqueId } from "../index"; -export = uniqueId; \ No newline at end of file +export = uniqueId; diff --git a/types/lodash/unset/index.d.ts b/types/lodash/unset/index.d.ts index 8e526713d7..b06997a103 100644 --- a/types/lodash/unset/index.d.ts +++ b/types/lodash/unset/index.d.ts @@ -1,2 +1,2 @@ import { unset } from "../index"; -export = unset; \ No newline at end of file +export = unset; diff --git a/types/lodash/unzip/index.d.ts b/types/lodash/unzip/index.d.ts index 57a50c8aa6..4900372c9e 100644 --- a/types/lodash/unzip/index.d.ts +++ b/types/lodash/unzip/index.d.ts @@ -1,2 +1,2 @@ import { unzip } from "../index"; -export = unzip; \ No newline at end of file +export = unzip; diff --git a/types/lodash/unzipWith/index.d.ts b/types/lodash/unzipWith/index.d.ts index 64c2b43089..28aad1a417 100644 --- a/types/lodash/unzipWith/index.d.ts +++ b/types/lodash/unzipWith/index.d.ts @@ -1,2 +1,2 @@ import { unzipWith } from "../index"; -export = unzipWith; \ No newline at end of file +export = unzipWith; diff --git a/types/lodash/update/index.d.ts b/types/lodash/update/index.d.ts index 141993229f..cba70b1b80 100644 --- a/types/lodash/update/index.d.ts +++ b/types/lodash/update/index.d.ts @@ -1,2 +1,2 @@ import { update } from "../index"; -export = update; \ No newline at end of file +export = update; diff --git a/types/lodash/upperCase/index.d.ts b/types/lodash/upperCase/index.d.ts index 25eb774983..6ff442cc20 100644 --- a/types/lodash/upperCase/index.d.ts +++ b/types/lodash/upperCase/index.d.ts @@ -1,2 +1,2 @@ import { upperCase } from "../index"; -export = upperCase; \ No newline at end of file +export = upperCase; diff --git a/types/lodash/upperFirst/index.d.ts b/types/lodash/upperFirst/index.d.ts index 05acb0f6d8..b8d53837aa 100644 --- a/types/lodash/upperFirst/index.d.ts +++ b/types/lodash/upperFirst/index.d.ts @@ -1,2 +1,2 @@ import { upperFirst } from "../index"; -export = upperFirst; \ No newline at end of file +export = upperFirst; diff --git a/types/lodash/values/index.d.ts b/types/lodash/values/index.d.ts index e4cee9048b..fb10161bb7 100644 --- a/types/lodash/values/index.d.ts +++ b/types/lodash/values/index.d.ts @@ -1,2 +1,2 @@ import { values } from "../index"; -export = values; \ No newline at end of file +export = values; diff --git a/types/lodash/valuesIn/index.d.ts b/types/lodash/valuesIn/index.d.ts index c2ae64e353..11fcc6500d 100644 --- a/types/lodash/valuesIn/index.d.ts +++ b/types/lodash/valuesIn/index.d.ts @@ -1,2 +1,2 @@ import { valuesIn } from "../index"; -export = valuesIn; \ No newline at end of file +export = valuesIn; diff --git a/types/lodash/without/index.d.ts b/types/lodash/without/index.d.ts index f6c3026a03..0fa415a090 100644 --- a/types/lodash/without/index.d.ts +++ b/types/lodash/without/index.d.ts @@ -1,2 +1,2 @@ import { without } from "../index"; -export = without; \ No newline at end of file +export = without; diff --git a/types/lodash/words/index.d.ts b/types/lodash/words/index.d.ts index e69803e9cb..6a76947ca1 100644 --- a/types/lodash/words/index.d.ts +++ b/types/lodash/words/index.d.ts @@ -1,2 +1,2 @@ import { words } from "../index"; -export = words; \ No newline at end of file +export = words; diff --git a/types/lodash/wrap/index.d.ts b/types/lodash/wrap/index.d.ts index 07c7914c4e..63f068b94d 100644 --- a/types/lodash/wrap/index.d.ts +++ b/types/lodash/wrap/index.d.ts @@ -1,2 +1,2 @@ import { wrap } from "../index"; -export = wrap; \ No newline at end of file +export = wrap; diff --git a/types/lodash/xor/index.d.ts b/types/lodash/xor/index.d.ts index 4804fb322f..9c2e0ea17b 100644 --- a/types/lodash/xor/index.d.ts +++ b/types/lodash/xor/index.d.ts @@ -1,2 +1,2 @@ import { xor } from "../index"; -export = xor; \ No newline at end of file +export = xor; diff --git a/types/lodash/xorBy/index.d.ts b/types/lodash/xorBy/index.d.ts index d468896792..4a2621d592 100644 --- a/types/lodash/xorBy/index.d.ts +++ b/types/lodash/xorBy/index.d.ts @@ -1,2 +1,2 @@ import { xorBy } from "../index"; -export = xorBy; \ No newline at end of file +export = xorBy; diff --git a/types/lodash/xorWith/index.d.ts b/types/lodash/xorWith/index.d.ts index 48337ca060..33e897a1f2 100644 --- a/types/lodash/xorWith/index.d.ts +++ b/types/lodash/xorWith/index.d.ts @@ -1,2 +1,2 @@ import { xorWith } from "../index"; -export = xorWith; \ No newline at end of file +export = xorWith; diff --git a/types/lodash/zip/index.d.ts b/types/lodash/zip/index.d.ts index a39e3d3099..ea074ac268 100644 --- a/types/lodash/zip/index.d.ts +++ b/types/lodash/zip/index.d.ts @@ -1,2 +1,2 @@ import { zip } from "../index"; -export = zip; \ No newline at end of file +export = zip; diff --git a/types/lodash/zipObject/index.d.ts b/types/lodash/zipObject/index.d.ts index 5ea9f4323f..b1577579b1 100644 --- a/types/lodash/zipObject/index.d.ts +++ b/types/lodash/zipObject/index.d.ts @@ -1,2 +1,2 @@ import { zipObject } from "../index"; -export = zipObject; \ No newline at end of file +export = zipObject; diff --git a/types/lodash/zipWith/index.d.ts b/types/lodash/zipWith/index.d.ts index c3b006c65e..bf808f690b 100644 --- a/types/lodash/zipWith/index.d.ts +++ b/types/lodash/zipWith/index.d.ts @@ -1,2 +1,2 @@ import { zipWith } from "../index"; -export = zipWith; \ No newline at end of file +export = zipWith; diff --git a/types/mapbox/index.d.ts b/types/mapbox/index.d.ts index 594f00523f..87a34e4823 100644 --- a/types/mapbox/index.d.ts +++ b/types/mapbox/index.d.ts @@ -3,397 +3,375 @@ // Definitions by: Maxime Fabre // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -/// +import * as Leaflet from "leaflet"; -////////////////////////////////////////////////////////////////////// -///////////////////////////// MAP OBJECT ///////////////////////////// -////////////////////////////////////////////////////////////////////// +declare global { + namespace L.mapbox { + ////////////////////////////////////////////////////////////////////// + ///////////////////////////// MAP OBJECT ///////////////////////////// + ////////////////////////////////////////////////////////////////////// -// Map -////////////////////////////////////////////////////////////////////// + // Map + ////////////////////////////////////////////////////////////////////// -declare namespace L.mapbox { - const accessToken: string; + const accessToken: string; - /** - * Create and automatically configure a map with layers, markers, and interactivity. - */ - function map(element: string|Element, idOrTileJson: any, options?: MapOptions): L.mapbox.Map; + /** + * Create and automatically configure a map with layers, markers, and interactivity. + */ + function map(element: string|Element, idOrTileJson: any, options?: MapOptions): L.mapbox.Map; - interface MapOptions extends L.Map.MapOptions { - featureLayer?: FeatureLayerOptions; - gridLayer?: any; - tileLayer?: TileLayerOptions; - infoControl?: ControlOptions; - legendControl?: ControlOptions; - shareControl?: ShareControlOptions; - } + interface MapOptions extends Leaflet.Map.MapOptions { + featureLayer?: FeatureLayerOptions; + gridLayer?: any; + tileLayer?: TileLayerOptions; + infoControl?: ControlOptions; + legendControl?: ControlOptions; + shareControl?: ShareControlOptions; + } - type FilterFunction = (feature: any) => boolean; + type FilterFunction = (feature: any) => boolean; - interface Map extends L.Map { - tileLayer: L.mapbox.TileLayer; - gridLayer: L.mapbox.GridLayer; - featureLayer: L.mapbox.FeatureLayer; + interface Map extends Leaflet.Map { + tileLayer: L.mapbox.TileLayer; + gridLayer: L.mapbox.GridLayer; + featureLayer: L.mapbox.FeatureLayer; - gridControl: L.mapbox.GridControl; - infoControl: L.mapbox.InfoControl; - legendControl: L.mapbox.LegendControl; - shareControl: L.mapbox.ShareControl; + gridControl: L.mapbox.GridControl; + infoControl: L.mapbox.InfoControl; + legendControl: L.mapbox.LegendControl; + shareControl: L.mapbox.ShareControl; - getTileJSON(): any; - } -} + getTileJSON(): any; + } -////////////////////////////////////////////////////////////////////// -/////////////////////////////// LAYERS /////////////////////////////// -////////////////////////////////////////////////////////////////////// + ////////////////////////////////////////////////////////////////////// + /////////////////////////////// LAYERS /////////////////////////////// + ////////////////////////////////////////////////////////////////////// -// TileLayer -////////////////////////////////////////////////////////////////////// + // TileLayer + ////////////////////////////////////////////////////////////////////// -declare namespace L.mapbox { - /** - * You can add a tiled layer to your map with L.mapbox.tileLayer(), a simple interface to layers from Mapbox and elsewhere. - */ - function tileLayer(idOrTileJson: string, options?: TileLayerOptions): L.mapbox.TileLayer; - - interface TileLayerOptions extends L.TileLayerOptions { - retinaVersion?: string; - } - - interface TileLayer extends L.TileLayer { /** - * Returns this layer's TileJSON object which determines its tile source, zoom bounds and other metadata. + * You can add a tiled layer to your map with L.mapbox.tileLayer(), a simple interface to layers from Mapbox and elsewhere. */ - getTileJSON(): any; + function tileLayer(idOrTileJson: string, options?: TileLayerOptions): L.mapbox.TileLayer; - /** - * Set the image format of tiles in this layer. You can use lower-quality tiles in order to load maps faster - */ - setFormat(format: string): TileLayer; - } -} + interface TileLayerOptions extends Leaflet.TileLayerOptions { + retinaVersion?: string; + } -// GridLayer -////////////////////////////////////////////////////////////////////// + interface TileLayer extends Leaflet.TileLayer { + /** + * Returns this layer's TileJSON object which determines its tile source, zoom bounds and other metadata. + */ + getTileJSON(): any; -declare namespace L.mapbox { - /** - * An L.mapbox.gridLayer loads UTFGrid tiles of interactivity into your map, which you can easily access with L.mapbox.gridControl. - */ - function gridLayer(idOrTileJson: any): L.mapbox.GridLayer; + /** + * Set the image format of tiles in this layer. You can use lower-quality tiles in order to load maps faster + */ + setFormat(format: string): TileLayer; + } - interface GridLayer { - active(): boolean; - addTo(map: L.mapbox.Map): any; - onAdd(map: L.mapbox.Map): any; - onRemove(): any; + // GridLayer + ////////////////////////////////////////////////////////////////////// /** - * Bind an event handler to a given event on this L.mapbox.gridLayer instance. GridLayers expose a number of useful events that give you access to UTFGrid data as the user interacts with the map. + * An L.mapbox.gridLayer loads UTFGrid tiles of interactivity into your map, which you can easily access with L.mapbox.gridControl. */ - on(event: string, handler: Function, context?: any): any; + function gridLayer(idOrTileJson: any): L.mapbox.GridLayer; - /** - * Returns this layer's TileJSON object which determines its tile source, zoom bounds and other metadata. - */ - getTileJSON(): any; + interface GridLayer { + active(): boolean; + addTo(map: L.mapbox.Map): any; + onAdd(map: L.mapbox.Map): any; + onRemove(): any; - /** - * Load data for a given latitude, longitude point on the map, and call the callback function with that data, if any. - */ - getData(latlng: L.LatLng, callback: Function): any; - } -} + /** + * Bind an event handler to a given event on this L.mapbox.gridLayer instance. GridLayers expose a number of useful events that give you access to UTFGrid data as the user interacts with the map. + */ + on(event: string, handler: Function, context?: any): any; -// FeatureLayer -////////////////////////////////////////////////////////////////////// + /** + * Returns this layer's TileJSON object which determines its tile source, zoom bounds and other metadata. + */ + getTileJSON(): any; -declare namespace L.mapbox { - /** - * L.mapbox.featureLayer provides an easy way to integrate GeoJSON from Mapbox and elsewhere into your map. - */ - function featureLayer(idOrGeoJson?: any, options?: FeatureLayerOptions): L.mapbox.FeatureLayer; + /** + * Load data for a given latitude, longitude point on the map, and call the callback function with that data, if any. + */ + getData(latlng: Leaflet.LatLng, callback: Function): any; + } - interface FeatureLayerOptions { - filter?: FilterFunction; - sanitizer?: (template: string) => string; - } + // FeatureLayer + ////////////////////////////////////////////////////////////////////// - interface FeatureLayer extends L.FeatureGroup { /** - * Load GeoJSON data for this layer from the URL given by url. + * L.mapbox.featureLayer provides an easy way to integrate GeoJSON from Mapbox and elsewhere into your map. */ - loadURL(url: string): any; + function featureLayer(idOrGeoJson?: any, options?: FeatureLayerOptions): L.mapbox.FeatureLayer; + + interface FeatureLayerOptions { + filter?: FilterFunction; + sanitizer?(template: string): string; + } + + interface FeatureLayer extends Leaflet.FeatureGroup { + /** + * Load GeoJSON data for this layer from the URL given by url. + */ + loadURL(url: string): any; + + /** + * Load marker GeoJSON data from a map with the given id on Mapbox. + */ + loadID(id: string): any; + + /** + * Sets the filter function for this data layer. + */ + setFilter(filter: FilterFunction): any; + + /** + * Gets the filter function for this data layer. + */ + getFilter(): FilterFunction; + + /** + * Set the contents of a markers layer: run the provided features through + * the filter function and then through the factory function to create + * elements for the map. If the layer already has features, they are + * replaced with the new features. An empty array will clear the + * layer of all features. + */ + setGeoJSON(geojson: any): L.mapbox.FeatureLayer; + + /** + * Get the contents of this layer as GeoJSON data. + */ + getGeoJSON(): any; + } + + ////////////////////////////////////////////////////////////////////// + ////////////////////////////// GEOCODING ///////////////////////////// + ////////////////////////////////////////////////////////////////////// + + // Geocoder + ////////////////////////////////////////////////////////////////////// /** - * Load marker GeoJSON data from a map with the given id on Mapbox. + * A low-level interface to geocoding, useful for more complex uses and reverse-geocoding. */ - loadID(id: string): any; + function geocoder(id: string): L.mapbox.Geocoder; - /** - * Sets the filter function for this data layer. - */ - setFilter(filter: FilterFunction): any; + interface Geocoder { + getURL(): string; + setURL(url: string): any; + setID(id: string): any; + setTileJSON(tilejson: any): any; + queryURL(url: string): string; - /** - * Gets the filter function for this data layer. - */ - getFilter(): FilterFunction; + /** + * Queries the geocoder with a query string, and returns its result, if any. + */ + query(queryString: string, callback: Function): any; - /** - * Set the contents of a markers layer: run the provided features through - * the filter function and then through the factory function to create - * elements for the map. If the layer already has features, they are - * replaced with the new features. An empty array will clear the - * layer of all features. - */ - setGeoJSON(geojson: any): L.mapbox.FeatureLayer; + /** + * Queries the geocoder with a location, and returns its result, if any. + */ + reverseQuery(location: any, callback: Function): any; + } - /** - * Get the contents of this layer as GeoJSON data. - */ - getGeoJSON(): any; - } -} - -////////////////////////////////////////////////////////////////////// -////////////////////////////// GEOCODING ///////////////////////////// -////////////////////////////////////////////////////////////////////// - -// Geocoder -////////////////////////////////////////////////////////////////////// - -declare namespace L.mapbox { - /** - * A low-level interface to geocoding, useful for more complex uses and reverse-geocoding. - */ - function geocoder(id: string): L.mapbox.Geocoder; - - interface Geocoder { - getURL(): string; - setURL(url: string): any; - setID(id: string): any; - setTileJSON(tilejson: any): any; - queryURL(url: string): string; + ////////////////////////////////////////////////////////////////////// + //////////////////////////////// CONTROLS //////////////////////////// + ////////////////////////////////////////////////////////////////////// - /** - * Queries the geocoder with a query string, and returns its result, if any. - */ - query(queryString: string, callback: Function): any; + interface ControlOptions extends Leaflet.ControlOptions { + sanitizer?(template: string): string; + } + + // InfoControl + ////////////////////////////////////////////////////////////////////// /** - * Queries the geocoder with a location, and returns its result, if any. + * A map control that shows a toggleable info container. If set, attribution is auto-detected from active layers and added to the info container. */ - reverseQuery(location: any, callback: Function): any; - } -} - -////////////////////////////////////////////////////////////////////// -//////////////////////////////// CONTROLS //////////////////////////// -////////////////////////////////////////////////////////////////////// + function infoControl(options?: ControlOptions): InfoControl; -declare namespace L.mapbox { - interface ControlOptions extends L.ControlOptions { - sanitizer?: (template: string) => string; - } -} + interface InfoControl extends Leaflet.Control { + onAdd(map: L.mapbox.Map): any; + onRemove(map: L.mapbox.Map): any; -// InfoControl -////////////////////////////////////////////////////////////////////// + /** + * Adds an info string to infoControl. + */ + addInfo(info: string): any; -declare namespace L.mapbox { - /** - * A map control that shows a toggleable info container. If set, attribution is auto-detected from active layers and added to the info container. - */ - function infoControl(options?: ControlOptions): InfoControl; + /** + * Removes an info string from infoControl + */ + removeInfo(info: string): any; + } - interface InfoControl extends L.Control { - onAdd(map: L.mapbox.Map): any; - onRemove(map: L.mapbox.Map): any; + // LegendControl + ////////////////////////////////////////////////////////////////////// /** - * Adds an info string to infoControl. + * A map control that shows legends added to maps in Mapbox. + * Legends are auto-detected from active layers. */ - addInfo(info: string): any; + function legendControl(options?: ControlOptions): LegendControl; - /** - * Removes an info string from infoControl - */ - removeInfo(info: string): any; - } -} + interface LegendControl extends Leaflet.Control { + onAdd(map: L.mapbox.Map): any; -// LegendControl -////////////////////////////////////////////////////////////////////// + /** + * Adds a legend to the legendControl. + */ + addLegend(legend: string): any; -declare namespace L.mapbox { - /** - * A map control that shows legends added to maps in Mapbox. - * Legends are auto-detected from active layers. - */ - function legendControl(options?: ControlOptions): LegendControl; + /** + * Removes a legend from the legendControl. + */ + removeLegend(legend: string): any; + } - interface LegendControl extends L.Control { - onAdd(map: L.mapbox.Map): any; + // GridControl + ////////////////////////////////////////////////////////////////////// /** - * Adds a legend to the legendControl. + * Interaction is what we call interactive parts of maps that are created with + * the powerful tooltips & regions system in TileMill. Under the hood, it's powered by the open UTFGrid specification. */ - addLegend(legend: string): any; + function gridControl(layer: string, options?: GridControlOptions): GridControl; + + interface GridControlOptions extends ControlOptions { + template?: string; + follow?: boolean; + pinnable?: boolean; + touchTeaser?: boolean; + location?: boolean; + } + + interface GridControl extends Leaflet.Control { + onAdd(map: L.mapbox.Map): any; + onRemove(map: L.mapbox.Map): any; + + /** + * If a tooltip is currently shown by the gridControl, hide and close it. + */ + hide(): any; + + /** + * Change the Mustache template used to transform the UTFGrid data in the map's interactivity into HTML for display. + */ + setTemplate(template: string): any; + } + + // GeocoderControl + ////////////////////////////////////////////////////////////////////// /** - * Removes a legend from the legendControl. + * Adds geocoder functionality as well as a UI element to a map. This uses the Mapbox Geocoding API. */ - removeLegend(legend: string): any; - } -} - -// GridControl -////////////////////////////////////////////////////////////////////// - -declare namespace L.mapbox { - /** - * Interaction is what we call interactive parts of maps that are created with - * the powerful tooltips & regions system in TileMill. Under the hood, it's powered by the open UTFGrid specification. - */ - function gridControl(layer: string, options?: GridControlOptions): GridControl; - - interface GridControlOptions extends ControlOptions { - template?: string; - follow?: boolean; - pinnable?: boolean; - touchTeaser?: boolean; - location?: boolean; - } - - interface GridControl extends L.Control { - onAdd(map: L.mapbox.Map): any; - onRemove(map: L.mapbox.Map): any; + function geocoderControl(id: string, options?: GeocoderControlOptions): GeocoderControl; - /** - * If a tooltip is currently shown by the gridControl, hide and close it. - */ - hide(): any; + interface GeocoderControlOptions extends Leaflet.ControlOptions { + keepOpen?: boolean; + } - /** - * Change the Mustache template used to transform the UTFGrid data in the map's interactivity into HTML for display. - */ - setTemplate(template: string): any; - } -} + interface GeocoderControl { + getURL(): string; + onAdd(map: L.mapbox.Map): any; -// GeocoderControl -////////////////////////////////////////////////////////////////////// + /** + * Set the url used for geocoding. + */ + setURL(url: string): any; -declare namespace L.mapbox { - /** - * Adds geocoder functionality as well as a UI element to a map. This uses the Mapbox Geocoding API. - */ - function geocoderControl(id: string, options?: GeocoderControlOptions): GeocoderControl; + /** + * Set the map id used for geocoding. + */ + setID(id: string): any; - interface GeocoderControlOptions extends L.ControlOptions { - keepOpen?: boolean; - } + /** + * Set the TileJSON used for geocoding. + */ + setTileJSON(tilejson: any): any; - interface GeocoderControl { - getURL(): string; - onAdd(map: L.mapbox.Map): any; + /** + * Bind a listener to an event emitted by the geocoder control. Supported additional events are + */ + on(event: string, callback: Function): any; + } - /** - * Set the url used for geocoding. - */ - setURL(url: string): any; + // ShareControl + ////////////////////////////////////////////////////////////////////// /** - * Set the map id used for geocoding. + * Adds a "Share" button to the map, which can be used to share the map to Twitter or Facebook, or generate HTML for a map embed. */ - setID(id: string): any; + function shareControl(id: string, options?: ShareControlOptions): ShareControl; + + interface ShareControlOptions extends Leaflet.ControlOptions { + url?: string; + } + + interface ShareControl extends Leaflet.Control { + onAdd(map: L.mapbox.Map): any; + } + + ////////////////////////////////////////////////////////////////////// + ////////////////////////////// MARKERS /////////////////////////////// + ////////////////////////////////////////////////////////////////////// + + namespace marker { + /** + * A core icon generator used in L.mapbox.marker.style + */ + function icon(feature: any): Leaflet.Icon; + + /** + * An icon generator for use in conjunction with pointToLayer to generate markers from the Mapbox Markers API and support the simplestyle-spec for features. + */ + function style(feature: any, latlng: any): Leaflet.Marker; + } + + ////////////////////////////////////////////////////////////////////// + ////////////////////////////// SIMPLESTYLE /////////////////////////// + ////////////////////////////////////////////////////////////////////// + + namespace simplestyle { + /** + * Given a GeoJSON Feature with optional simplestyle-spec properties, return an options object formatted to be used as Leaflet Path options. + */ + function style(feature: any): Leaflet.PathOptions; + } + + ////////////////////////////////////////////////////////////////////// + /////////////////////////////// UTILITY ////////////////////////////// + ////////////////////////////////////////////////////////////////////// /** - * Set the TileJSON used for geocoding. + * A HTML sanitization function, with the same effect as the default value of the sanitizer option of L.mapbox.featureLayer, L.mapbox.gridControl, and L.mapbox.legendControl. */ - setTileJSON(tilejson: any): any; + function sanitize(text: string): string; /** - * Bind a listener to an event emitted by the geocoder control. Supported additional events are + * A mustache template rendering function, as used by the templating feature provided by L.mapbox.gridControl. */ - on(event: string, callback: Function): any; - } -} - -// ShareControl -////////////////////////////////////////////////////////////////////// - -declare namespace L.mapbox { - /** - * Adds a "Share" button to the map, which can be used to share the map to Twitter or Facebook, or generate HTML for a map embed. - */ - function shareControl(id: string, options?: ShareControlOptions): ShareControl; - - interface ShareControlOptions extends L.ControlOptions { - url?: string; - } - - interface ShareControl extends L.Control { - onAdd(map: L.mapbox.Map): any; - } -} - -////////////////////////////////////////////////////////////////////// -////////////////////////////// MARKERS /////////////////////////////// -////////////////////////////////////////////////////////////////////// - -declare namespace L.mapbox.marker { - /** - * A core icon generator used in L.mapbox.marker.style - */ - function icon(feature: any): L.Icon; - - /** - * An icon generator for use in conjunction with pointToLayer to generate markers from the Mapbox Markers API and support the simplestyle-spec for features. - */ - function style(feature: any, latlng: any): L.Marker; -} - -////////////////////////////////////////////////////////////////////// -////////////////////////////// SIMPLESTYLE /////////////////////////// -////////////////////////////////////////////////////////////////////// - -declare namespace L.mapbox.simplestyle { - /** - * Given a GeoJSON Feature with optional simplestyle-spec properties, return an options object formatted to be used as Leaflet Path options. - */ - function style(feature: any): L.PathOptions; -} - -////////////////////////////////////////////////////////////////////// -/////////////////////////////// UTILITY ////////////////////////////// -////////////////////////////////////////////////////////////////////// - -declare namespace L.mapbox { - /** - * A HTML sanitization function, with the same effect as the default value of the sanitizer option of L.mapbox.featureLayer, L.mapbox.gridControl, and L.mapbox.legendControl. - */ - function sanitize(text: string): string; - - /** - * A mustache template rendering function, as used by the templating feature provided by L.mapbox.gridControl. - */ - function template(template: string, data?: any): string; -} - -////////////////////////////////////////////////////////////////////// -///////////////////////////// CONFIGURATION ////////////////////////// -////////////////////////////////////////////////////////////////////// - -declare namespace L.mapbox { - class config { - static FORCE_HTTPS: boolean; - - static HTTP_URLS: string[]; - - static HTTPS_URLS: string[]; + function template(template: string, data?: any): string; + + ////////////////////////////////////////////////////////////////////// + ///////////////////////////// CONFIGURATION ////////////////////////// + ////////////////////////////////////////////////////////////////////// + + class config { + static FORCE_HTTPS: boolean; + + static HTTP_URLS: string[]; + + static HTTPS_URLS: string[]; + } } } diff --git a/types/mapbox/package.json b/types/mapbox/package.json deleted file mode 100644 index 711ba15e43..0000000000 --- a/types/mapbox/package.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "dependencies": { - "@types/leaflet": "^0.7" - } -} \ No newline at end of file diff --git a/types/mapbox/tsconfig.json b/types/mapbox/tsconfig.json index 0fdf82e942..a469b979bf 100644 --- a/types/mapbox/tsconfig.json +++ b/types/mapbox/tsconfig.json @@ -9,7 +9,15 @@ "noImplicitThis": true, "strictNullChecks": false, "baseUrl": "../", + "typeRoots": [ + "../" + ], "types": [], + "paths": { + "leaflet": [ + "leaflet/v0" + ] + }, "noEmit": true, "forceConsistentCasingInFileNames": true }, diff --git a/types/mapbox/tslint.json b/types/mapbox/tslint.json index f05741c59b..b0e7084e94 100644 --- a/types/mapbox/tslint.json +++ b/types/mapbox/tslint.json @@ -1,6 +1,6 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false + "ban-types": false } } diff --git a/types/merge-descriptors/tslint.json b/types/merge-descriptors/tslint.json index f05741c59b..b0e7084e94 100644 --- a/types/merge-descriptors/tslint.json +++ b/types/merge-descriptors/tslint.json @@ -1,6 +1,6 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false + "ban-types": false } } diff --git a/types/multimatch/index.d.ts b/types/multimatch/index.d.ts new file mode 100644 index 0000000000..7130cafbd0 --- /dev/null +++ b/types/multimatch/index.d.ts @@ -0,0 +1,73 @@ +// Type definitions for multimatch 2.1 +// Project: https://github.com/sindresorhus/multimatch +// Definitions by: Stephen Lautier +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +/** + * Match utility function which supports multiple pattern globbing. + * + * @param {string[]} paths list to match against. + * @param {string[]} patterns globbing patterns to use. e.g. `[*, "!cake"]`. + * @param {multimatch.MultimatchOptions} [options] + * @returns {string[]} + */ +declare function multimatch(paths: string[], patterns: string | string[], options?: multimatch.MultimatchOptions): string[]; + +declare namespace multimatch { + + /** + * Options based on [minimatch](https://github.com/isaacs/minimatch#minimatchmatchlist-pattern-options) + */ + interface MultimatchOptions { + /** Dump a ton of stuff to stderr. */ + debug?: boolean; + + /** Do not expand `{a,b}` and `{1..3}` brace sets. */ + nobrace?: boolean; + + /** Disable `**` matching against multiple folder names. */ + noglobstar?: boolean; + + /** + * Allow patterns to match filenames starting with a period, even if + * the pattern does not explicitly have a period in that spot. + * + * Note that by default, `a/** /b` will **not** match `a/.d/b`, unless `dot` is set. + */ + dot?: boolean; + + /** Disable "extglob" style patterns like `+(a|b)`. */ + noext?: boolean; + + /** Perform a case-insensitive match. */ + nocase?: boolean; + + /** + * When a match is not found by `minimatch.match`, return a list containing + * the pattern itself if this option is set. When not set, an empty list + * is returned if there are no matches. + */ + nonull?: boolean; + + /** + * If set, then patterns without slashes will be matched + * against the basename of the path if it contains slashes. For example, + * `a?b` would match the path `/xyz/123/acb`, but not `/xyz/acb/123`. + */ + matchBase?: boolean; + + /** Suppress the behavior of treating `#` at the start of a pattern as a comment. */ + nocomment?: boolean; + + /** Suppress the behavior of treating a leading `!` character as negation. */ + nonegate?: boolean; + + /** Returns from negate expressions the same as if they were not negated. + * (Ie, true on a hit, false on a miss.) + */ + flipNegate?: boolean; + } + +} + +export = multimatch; diff --git a/types/multimatch/multimatch-tests.ts b/types/multimatch/multimatch-tests.ts new file mode 100644 index 0000000000..b8c9cac658 --- /dev/null +++ b/types/multimatch/multimatch-tests.ts @@ -0,0 +1,9 @@ +import * as multimatch from "multimatch"; + +const options: multimatch.MultimatchOptions = { + debug: true +}; + +multimatch(["unicorn", "cake", "rainbows"], "!cake"); +multimatch(["unicorn", "cake", "rainbows"], ["*", "!cake"]); +multimatch(["unicorn", "cake", "rainbows"], ["*", "!cake"], options); diff --git a/types/multimatch/tsconfig.json b/types/multimatch/tsconfig.json new file mode 100644 index 0000000000..3f5a4db2ac --- /dev/null +++ b/types/multimatch/tsconfig.json @@ -0,0 +1,22 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "multimatch-tests.ts" + ] +} diff --git a/types/multimatch/tslint.json b/types/multimatch/tslint.json new file mode 100644 index 0000000000..377cc837d4 --- /dev/null +++ b/types/multimatch/tslint.json @@ -0,0 +1 @@ +{ "extends": "../tslint.json" } diff --git a/types/ng-stomp/tslint.json b/types/ng-stomp/tslint.json index 2ab0c36fa8..867dfe94d3 100644 --- a/types/ng-stomp/tslint.json +++ b/types/ng-stomp/tslint.json @@ -1,6 +1,6 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false + "ban-types": false } } \ No newline at end of file diff --git a/types/pixi.js/tslint.json b/types/pixi.js/tslint.json index 6fa0ddab84..bb288627d0 100644 --- a/types/pixi.js/tslint.json +++ b/types/pixi.js/tslint.json @@ -1,8 +1,9 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false, + "ban-types": false, "interface-name": false, + "no-empty-interface": false, "no-single-declare-module": false, "unified-signatures": false, diff --git a/types/promised-temp/package.json b/types/promised-temp/package.json deleted file mode 100644 index 55849714d6..0000000000 --- a/types/promised-temp/package.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "dependencies": { - "@types/temp": "latest", - "@types/node": "latest" - } -} diff --git a/types/protractor-browser-logs/index.d.ts b/types/protractor-browser-logs/index.d.ts index 7f3a4ffa55..b2a4a91fac 100644 --- a/types/protractor-browser-logs/index.d.ts +++ b/types/protractor-browser-logs/index.d.ts @@ -2,6 +2,7 @@ // Project: https://www.npmjs.com/package/protractor-browser-logs, https://github.com/wix/protractor-browser-logs // Definitions by: Saqib Rokadia // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.2 import * as webdriver from 'selenium-webdriver'; import Entry = webdriver.logging.Entry; diff --git a/types/protractor-browser-logs/package.json b/types/protractor-browser-logs/package.json index 1f7874a30c..ce9b337b30 100644 --- a/types/protractor-browser-logs/package.json +++ b/types/protractor-browser-logs/package.json @@ -1,6 +1,5 @@ { "dependencies": { - "protractor": "latest", - "@types/selenium-webdriver": "latest" + "protractor": "latest" } } diff --git a/types/protractor-helpers/index.d.ts b/types/protractor-helpers/index.d.ts index d4b9c7f159..9bd62cb167 100644 --- a/types/protractor-helpers/index.d.ts +++ b/types/protractor-helpers/index.d.ts @@ -4,107 +4,101 @@ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.1 -/// /// +import * as webdriver from "selenium-webdriver"; -// ElementArrayFinder +declare global { + // ElementArrayFinder -declare namespace protractor { - interface ElementArrayFinder { - getByText(text: string) : protractor.ElementFinder; - $$data(hook: string) : protractor.ElementArrayFinder; + namespace protractor { + interface ElementArrayFinder { + getByText(text: string) : protractor.ElementFinder; + $$data(hook: string) : protractor.ElementArrayFinder; + } + + interface ElementFinder { + $data(hook: string) : protractor.ElementFinder; + } } - interface ElementFinder { - $data(hook: string) : protractor.ElementFinder; + // Globals + + function $data(hook: string) : protractor.ElementFinder; + function $$data(hook: string) : protractor.ElementArrayFinder; + + + // Locators + + // TODO - find out about result of querySelector and querySelector all. + // Are they Locator s? + namespace protractor { + interface IProtractorLocatorStrategy { + dataHook(hook: string, optParentElement?: protractor.ElementFinder, optRootSelector?: string) : webdriver.Locator; + dataHookAll(hook: string, optParentElement?: protractor.ElementFinder, optRootSelector?: string) : webdriver.Locator; + } + } + + // Matchers + // TODO - Use `T` to improve types + + namespace jasmine { + interface Matchers { + toBePresent() : boolean; + toBeDisplayed() : boolean; + toHaveCountOf(expectedCount : number) : boolean; + toHaveText(expectedText : string) : boolean; + toMatchRegex(regex : RegExp) : boolean; + toMatchMoney(expectedValue : number, currencySymbol? : string) : boolean; + toMatchMoneyWithFraction(expectedValue : number, currencySymbol?: string) : boolean; + toHaveValue(actual: string | number) : boolean; + toHaveClass(className : string) : boolean; + toHaveUrl(url : string) : boolean; + toBeDisabled() : boolean; + toBeChecked() : boolean; + toBeValid() : boolean; + toBeInvalid() : boolean; + toBeInvalidRequired() : boolean; + // Copied definitions from angular-translate. + toMatchTranslated(translationId : string, interpolateParams? : any) : boolean; + toMatchTranslated(translationId : string[], interpolateParams? : any) : boolean; + } } } -// Globals +export function not(arg: webdriver.promise.IThenable) : webdriver.promise.IThenable; -declare function $data(hook: string) : protractor.ElementFinder; -declare function $$data(hook: string) : protractor.ElementArrayFinder; +// Copied definitions from angular-translate. +export function translate(translationId: string, interpolateParams?: any): webdriver.promise.IThenable; +export function translate(translationId: string[], interpolateParams?: any): webdriver.promise.IThenable<{ [key: string]: string }>; +export function safeGet(url: string) : void; -// Locators +export function maximizeWindow(width?: number, height?: number) : void; // TODO +export function resetPosition() : void; +export function moveToElement(hook: string) : void; +export function displayHover(element: protractor.ElementFinder) : void; -// TODO - find out about result of querySelector and querySelector all. -// Are they Locator s? -declare namespace protractor { - interface IProtractorLocatorStrategy { - dataHook(hook: string, optParentElement?: protractor.ElementFinder, optRootSelector?: string) : webdriver.Locator; - dataHookAll(hook: string, optParentElement?: protractor.ElementFinder, optRootSelector?: string) : webdriver.Locator; - } -} +export function waitForElement(element: protractor.ElementFinder, timeout?: number) : void; +export function waitForElementToDisappear(element: protractor.ElementFinder, timeout?: number) : void; -// Matchers -// TODO - Typescript doesn't really help much here -// we don't know what type is being tested. -// Fixing this would require modifying the -// jasmine d.ts. +export function selectOptionByText(select: protractor.ElementFinder, text: string) : void; +export function selectOptionByIndex(select: protractor.ElementFinder, index: number) : void; -declare namespace jasmine { - interface Matchers { - toBePresent() : boolean; - toBeDisplayed() : boolean; - toHaveCountOf(expectedCount : number) : boolean; - toHaveText(expectedText : string) : boolean; - toMatchRegex(regex : RegExp) : boolean; - toMatchMoney(expectedValue : number, currencySymbol? : string) : boolean; - toMatchMoneyWithFraction(expectedValue : number, currencySymbol?: string) : boolean; - toHaveValue(actual: string | number) : boolean; - toHaveClass(className : string) : boolean; - toHaveUrl(url : string) : boolean; - toBeDisabled() : boolean; - toBeChecked() : boolean; - toBeValid() : boolean; - toBeInvalid() : boolean; - toBeInvalidRequired() : boolean; - // Copied definitions from angular-translate. - toMatchTranslated(translationId : string, interpolateParams? : any) : boolean; - toMatchTranslated(translationId : string[], interpolateParams? : any) : boolean; - } -} +export function selectOption(option: protractor.ElementFinder) : void +export function isFirefox() : boolean; +export function isIE() : boolean; -declare module "protractor-helpers" { +export function createMessage(actual : string, message : string, isNot : any) : string; // isNot : boolean too inflexible +export function createMessage(actual : protractor.ElementFinder, message : string, isNot : any) : string; // isNot : boolean too inflexible +export function createMessage(actual : protractor.ElementArrayFinder, message : string, isNot : any) : string; // isNot : boolean too inflexible - function not(arg: webdriver.promise.IThenable) : webdriver.promise.IThenable; +export function clearAndSetValue(input : protractor.ElementFinder, value : string) : void; // TODO - sendKeys(value) - // Copied definitions from angular-translate. - function translate(translationId: string, interpolateParams?: any): webdriver.promise.IThenable; - function translate(translationId: string[], interpolateParams?: any): webdriver.promise.IThenable<{ [key: string]: string }>; - - function safeGet(url: string) : void; - - function maximizeWindow(width?: number, height?: number) : void; // TODO - function resetPosition() : void; - function moveToElement(hook: string) : void; - function displayHover(element: protractor.ElementFinder) : void; - - function waitForElement(element: protractor.ElementFinder, timeout?: number) : void; - function waitForElementToDisappear(element: protractor.ElementFinder, timeout?: number) : void; - - function selectOptionByText(select: protractor.ElementFinder, text: string) : void; - function selectOptionByIndex(select: protractor.ElementFinder, index: number) : void; - - function selectOption(option: protractor.ElementFinder) : void - - function isFirefox() : boolean; - function isIE() : boolean; - - function createMessage(actual : string, message : string, isNot : any) : string; // isNot : boolean too inflexible - function createMessage(actual : protractor.ElementFinder, message : string, isNot : any) : string; // isNot : boolean too inflexible - function createMessage(actual : protractor.ElementArrayFinder, message : string, isNot : any) : string; // isNot : boolean too inflexible - - function clearAndSetValue(input : protractor.ElementFinder, value : string) : void; // TODO - sendKeys(value) - - function hasClass(element: protractor.ElementFinder, className: string) : webdriver.promise.IThenable; - function hasValue(element: protractor.ElementFinder, expectedValue: string) : webdriver.promise.IThenable; - function hasValue(element: protractor.ElementFinder, expectedValue: number) : webdriver.promise.IThenable; - function hasLink(element: protractor.ElementFinder, url: string) : webdriver.promise.IThenable; - function isDisabled(element: protractor.ElementFinder) : webdriver.promise.IThenable; - function isChecked(element: protractor.ElementFinder) : webdriver.promise.IThenable; - function getFilteredConsoleErrors() : webdriver.promise.IThenable; // TODO - discuss handling in IE - -} +export function hasClass(element: protractor.ElementFinder, className: string) : webdriver.promise.IThenable; +export function hasValue(element: protractor.ElementFinder, expectedValue: string) : webdriver.promise.IThenable; +export function hasValue(element: protractor.ElementFinder, expectedValue: number) : webdriver.promise.IThenable; +export function hasLink(element: protractor.ElementFinder, url: string) : webdriver.promise.IThenable; +export function isDisabled(element: protractor.ElementFinder) : webdriver.promise.IThenable; +export function isChecked(element: protractor.ElementFinder) : webdriver.promise.IThenable; +export function getFilteredConsoleErrors() : webdriver.promise.IThenable; // TODO - discuss handling in IE diff --git a/types/protractor-helpers/package.json b/types/protractor-helpers/package.json deleted file mode 100644 index 2939ff6d12..0000000000 --- a/types/protractor-helpers/package.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "dependencies": { - "@types/jasmine": "^2.2.34", - "@types/selenium-webdriver": "2.44.28" - } -} diff --git a/types/protractor-helpers/protractor-helpers-tests.ts b/types/protractor-helpers/protractor-helpers-tests.ts index 543991392b..39ac5f079e 100644 --- a/types/protractor-helpers/protractor-helpers-tests.ts +++ b/types/protractor-helpers/protractor-helpers-tests.ts @@ -1,4 +1,5 @@ import helpers = require('protractor-helpers'); +import * as webdriver from "selenium-webdriver"; declare var $$: any, $: any, by: any, element: any; // ?? diff --git a/types/protractor-helpers/tsconfig.json b/types/protractor-helpers/tsconfig.json index c3fc74ec13..635aeabf5f 100644 --- a/types/protractor-helpers/tsconfig.json +++ b/types/protractor-helpers/tsconfig.json @@ -8,6 +8,9 @@ "noImplicitThis": true, "strictNullChecks": false, "baseUrl": "../", + "typeRoots": [ + "../" + ], "types": [], "noEmit": true, "forceConsistentCasingInFileNames": true diff --git a/types/protractor-http-mock/package.json b/types/protractor-http-mock/package.json deleted file mode 100644 index 55eddeb1c7..0000000000 --- a/types/protractor-http-mock/package.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "dependencies": { - "@types/selenium-webdriver": "~2.44.28" - } -} diff --git a/types/qlik-visualizationextensions/index.d.ts b/types/qlik-visualizationextensions/index.d.ts index 97ffca8733..4a4a635e4f 100644 --- a/types/qlik-visualizationextensions/index.d.ts +++ b/types/qlik-visualizationextensions/index.d.ts @@ -2265,7 +2265,7 @@ declare namespace ExtensionAPI { interface IExtension { definition?: IDefinition; - paint?: ($element: HTMLElement, layout?: any) => void; + paint?($element: HTMLElement, layout?: any): void; initialProperties?: IInitialProperties; template?: string; controller?: any; diff --git a/types/qlik-visualizationextensions/tslint.json b/types/qlik-visualizationextensions/tslint.json index cae1bdf2ad..97addf8511 100644 --- a/types/qlik-visualizationextensions/tslint.json +++ b/types/qlik-visualizationextensions/tslint.json @@ -1,7 +1,7 @@ -{ +{ "extends": "../tslint.json", "rules": { - "forbidden-types": false, + "ban-types": false, "no-empty-interface": false, "interface-name": false } diff --git a/types/react-native-fs/react-native-fs-tests.ts b/types/react-native-fs/react-native-fs-tests.ts index a006086a9a..85a623b82e 100644 --- a/types/react-native-fs/react-native-fs-tests.ts +++ b/types/react-native-fs/react-native-fs-tests.ts @@ -1,6 +1,5 @@ import * as RNFS from 'react-native-fs'; - // get a list of files and directories in the main bundle RNFS.readDir(RNFS.MainBundlePath) // On Android, use "RNFS.DocumentDirectoryPath" (MainBundlePath is not defined) .then((result) => { @@ -26,7 +25,7 @@ RNFS.readDir(RNFS.MainBundlePath) // On Android, use "RNFS.DocumentDirectoryPath }); // create a path you want to write to -var path = RNFS.DocumentDirectoryPath + '/test.txt'; +const path = RNFS.DocumentDirectoryPath + '/test.txt'; // write the file RNFS.writeFile(path, 'Lorem ipsum dolor sit amet', 'utf8') @@ -46,9 +45,9 @@ RNFS.unlink('path') console.log(err.message); }); -var uploadUrl = 'http://requestb.in/XXXXXXX'; // For testing purposes, go to http://requestb.in/ and create your own link +const uploadUrl = 'http://requestb.in/XXXXXXX'; // For testing purposes, go to http://requestb.in/ and create your own link // create an array of objects of the files you want to upload -var files = [ +const files = [ { name: 'test1', filename: 'test1.w4a', @@ -62,13 +61,13 @@ var files = [ } ]; -var uploadBegin: RNFS.UploadCallbackBegin = (response) => { - var jobId = response.jobId; +const uploadBegin: RNFS.UploadCallbackBegin = (response) => { + const jobId = response.jobId; console.log('UPLOAD HAS BEGUN! JobId: ' + jobId); }; -var uploadProgress: RNFS.UploadCallbackProgress = (response) => { - var percentage = Math.floor((response.totalBytesSent / response.totalBytesExpectedToSend) * 100); +const uploadProgress: RNFS.UploadCallbackProgress = (response) => { + const percentage = Math.floor((response.totalBytesSent / response.totalBytesExpectedToSend) * 100); console.log('UPLOAD IS ' + percentage + '% DONE!'); }; @@ -99,13 +98,13 @@ RNFS.uploadFiles({ console.log(err); }); -var downloadProgress: RNFS.DownloadCallbackProgress = (result) => { +const downloadProgress: RNFS.DownloadCallbackProgress = (result) => { result.bytesWritten === 0; result.contentLength > 10; result.jobId; }; -var downloadBegin: RNFS.DownloadCallbackBegin = (result) => { +const downloadBegin: RNFS.DownloadCallbackBegin = (result) => { result.headers === {}; }; diff --git a/types/react-native-scrollable-tab-view/index.d.ts b/types/react-native-scrollable-tab-view/index.d.ts index 873d69855b..9ef7e5a247 100644 --- a/types/react-native-scrollable-tab-view/index.d.ts +++ b/types/react-native-scrollable-tab-view/index.d.ts @@ -23,8 +23,7 @@ export interface onChangeTabProperties { } export interface renderTabBarProperties { - - goToPage: (pageNumber: number) => void; + goToPage(pageNumber: number): void; tabs: JSX.Element; @@ -36,7 +35,6 @@ export interface renderTabBarProperties { } interface ScrollableTabViewProperties extends React.Props { - /** * tabBarPosition (String) Defaults to "top". * "bottom" to position the tab bar below content. @@ -61,13 +59,13 @@ interface ScrollableTabViewProperties extends React.Props { * an Object containing two keys: i: the index of the tab that is selected, ref: the ref of the * tab that is selected */ - onChangeTab?: (value: onChangeTabProperties) => void; + onChangeTab?(value: onChangeTabProperties): void; /** * onScroll (Function) - function to call when the pages are sliding, * should accept 1 argument which is an Float number representing the page position in the slide frame. */ - onScroll?: (value: number) => void; + onScroll?(value: number): void; /** * renderTabBar (Function:ReactComponent) - accept 1 argument props and should return a component @@ -75,7 +73,7 @@ interface ScrollableTabViewProperties extends React.Props { * and should implement setAnimationValue to be able to animate itself along with the tab content. * You can manually pass the props to the TabBar component. */ - renderTabBar?: (value: JSX.Element) => JSX.Element; + renderTabBar?(value: JSX.Element): JSX.Element; /** * style (View.propTypes.style) diff --git a/types/react-native-scrollable-tab-view/react-native-scrollable-tab-view-tests.tsx b/types/react-native-scrollable-tab-view/react-native-scrollable-tab-view-tests.tsx index 2d79537221..0fb10a4ffb 100644 --- a/types/react-native-scrollable-tab-view/react-native-scrollable-tab-view-tests.tsx +++ b/types/react-native-scrollable-tab-view/react-native-scrollable-tab-view-tests.tsx @@ -22,7 +22,6 @@ class MyText extends React.Component { } class ScrollableTabViewDemo extends React.Component<{}, {}> { - constructor(props: ScrollableTabViewDemo) { super(props); } @@ -42,4 +41,4 @@ class ScrollableTabViewDemo extends React.Component<{}, {}> { protected componentWillUnmount?(): void { } -} \ No newline at end of file +} diff --git a/types/react-native-swiper/index.d.ts b/types/react-native-swiper/index.d.ts index f41a771caf..81888289b8 100644 --- a/types/react-native-swiper/index.d.ts +++ b/types/react-native-swiper/index.d.ts @@ -10,7 +10,6 @@ import { } from 'react-native'; interface SwiperProperties extends React.Props { - horizontal?: boolean; style?: ViewStyle; @@ -49,7 +48,7 @@ interface SwiperProperties extends React.Props { index?: number; - renderPagination?: (index: number, total: number, thisObject: Swiper) => JSX.Element; + renderPagination?(index: number, total: number, thisObject: Swiper): JSX.Element; dotStyle?: ViewStyle; @@ -62,4 +61,3 @@ interface SwiperProperties extends React.Props { export default class Swiper extends React.Component { } - diff --git a/types/react-native-swiper/react-native-swiper-tests.tsx b/types/react-native-swiper/react-native-swiper-tests.tsx index fa214e18f0..7463ac0b70 100644 --- a/types/react-native-swiper/react-native-swiper-tests.tsx +++ b/types/react-native-swiper/react-native-swiper-tests.tsx @@ -7,7 +7,6 @@ import { } from 'react-native'; import Swiper from 'react-native-swiper'; - class SwiperTest extends React.Component<{}, {}> { constructor(props: {}) { super(props); @@ -60,4 +59,4 @@ const styles = StyleSheet.create({ fontSize: 30, fontWeight: 'bold' } as ViewStyle -}); \ No newline at end of file +}); diff --git a/types/react-native/index.d.ts b/types/react-native/index.d.ts index 6a833a4467..3742bf5003 100644 --- a/types/react-native/index.d.ts +++ b/types/react-native/index.d.ts @@ -337,7 +337,8 @@ export interface NativeMethodsMixinStatic { } // see react-jsx.d.ts -export function createElement

(type: React.ReactType, +export function createElement

( + type: React.ReactType, props?: P, ...children: React.ReactNode[]): React.ReactElement

; @@ -1230,7 +1231,7 @@ interface TextInputState { * Unfocuses the specified text field * noop if it wasn't focused */ - blurTextInput(textFieldID?: number) : void + blurTextInput(textFieldID?: number): void } /** @@ -4165,7 +4166,7 @@ export interface LeftToRightGesture { direction: string; } -export interface JumpGesture extends LeftToRightGesture{ +export interface JumpGesture extends LeftToRightGesture { overswipe: { frictionConstant: number frictionByDistance: number @@ -5774,7 +5775,7 @@ export interface SnapshotViewIOSProperties extends ViewProperties, React.Props } @@ -7288,7 +7289,7 @@ export interface EasingStatic { inOut(easing: EasingFunction): EasingFunction; } -export module Animated { +export namespace Animated { // Most (all?) functions where AnimatedValue is used any subclass of Animated can be used as well. type AnimatedValue = Animated; type AnimatedValueXY = ValueXY; @@ -7549,7 +7550,7 @@ export module Animated { * Spring animation based on Rebound and Origami. Tracks velocity state to * create fluid motions as the `toValue` updates, and can be chained together. */ - export function spring ( + export function spring( value: AnimatedValue | AnimatedValueXY, config: SpringAnimationConfig ): CompositeAnimation; @@ -7563,7 +7564,7 @@ export module Animated { * of the animations is stopped, they will all be stopped. You can override * this with the `stopTogether` flag. */ - export function parallel ( + export function parallel( animations: Array, config?: ParallelConfig ): CompositeAnimation; @@ -7589,7 +7590,7 @@ export module Animated { * ]), *``` */ - export function event ( + export function event( argMapping: Mapping[], config?: EventConfig ): (...args: any[]) => void; @@ -7597,7 +7598,7 @@ export module Animated { /** * Make any React component Animatable. Used to create `Animated.View`, etc. */ - export function createAnimatedComponent (component: any) : any; + export function createAnimatedComponent(component: any): any; /** * Animated variants of the basic native views. Accepts Animated.Value for diff --git a/types/react-native/test/animated.tsx b/types/react-native/test/animated.tsx index 3b3457384c..8efd5fd171 100644 --- a/types/react-native/test/animated.tsx +++ b/types/react-native/test/animated.tsx @@ -90,4 +90,4 @@ function TestAnimatedAPI() { ); -} \ No newline at end of file +} diff --git a/types/react-native/test/index.tsx b/types/react-native/test/index.tsx index f7a4abae57..575693211e 100644 --- a/types/react-native/test/index.tsx +++ b/types/react-native/test/index.tsx @@ -28,19 +28,12 @@ import { } from 'react-native'; function testDimensions() { - var { + const { width, height, scale, fontScale, - } = Dimensions.get("window"); - - var { - width, - height, - scale, - fontScale, - } = Dimensions.get("screen"); + } = Dimensions.get(1 === 1 ? "window" : "screen"); } BackAndroid.addEventListener("hardwareBackPress", () => { @@ -52,7 +45,7 @@ interface LocalStyles { instructions: TextStyle; } -var styles = StyleSheet.create( +const styles = StyleSheet.create( { container: { flex: 1, @@ -97,7 +90,6 @@ const stylesAlt = StyleSheet.create( class Welcome extends React.Component { - refs: { [key: string]: any rootView: View @@ -113,7 +105,6 @@ class Welcome extends React.Component { } render() { - return ( @@ -135,7 +126,7 @@ export default Welcome; // App State -function appStateListener(state : string) { +function appStateListener(state: string) { console.log('New state: ' + state); } diff --git a/types/react-native/tslint.json b/types/react-native/tslint.json index dd4e4a1cba..b58d132131 100644 --- a/types/react-native/tslint.json +++ b/types/react-native/tslint.json @@ -2,6 +2,19 @@ "extends": "../tslint.json", "rules": { // Lowercase `object` is available in TypeScript 2.2 only. - "forbidden-types": false + "ban-types": false, + // Below are all TODO + "array-type": false, + "comment-format": false, + "interface-over-type-literal": false, + "no-misused-new": false, + "no-consecutive-blank-lines": false, + "no-empty-interface": false, + "no-padding": false, + "no-redundant-modifiers": false, + "no-var": false, + "prefer-declare-function": false, + "prefer-method-signature": false, + "semicolon": false } } diff --git a/types/react-router-redux/v3/tslint.json b/types/react-router-redux/v3/tslint.json index d032145676..7a5f77c1dc 100644 --- a/types/react-router-redux/v3/tslint.json +++ b/types/react-router-redux/v3/tslint.json @@ -1,7 +1,7 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false, + "ban-types": false, "no-empty-interface": false } } diff --git a/types/react-router/v2/tslint.json b/types/react-router/v2/tslint.json index d032145676..7a5f77c1dc 100644 --- a/types/react-router/v2/tslint.json +++ b/types/react-router/v2/tslint.json @@ -1,7 +1,7 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false, + "ban-types": false, "no-empty-interface": false } } diff --git a/types/redux-localstorage/tslint.json b/types/redux-localstorage/tslint.json index d032145676..7a5f77c1dc 100644 --- a/types/redux-localstorage/tslint.json +++ b/types/redux-localstorage/tslint.json @@ -1,7 +1,7 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false, + "ban-types": false, "no-empty-interface": false } } diff --git a/types/reflux/tslint.json b/types/reflux/tslint.json index f05741c59b..b0e7084e94 100644 --- a/types/reflux/tslint.json +++ b/types/reflux/tslint.json @@ -1,6 +1,6 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false + "ban-types": false } } diff --git a/types/rx-dom/tslint.json b/types/rx-dom/tslint.json index 8dd3240216..ee6fc74495 100644 --- a/types/rx-dom/tslint.json +++ b/types/rx-dom/tslint.json @@ -2,7 +2,7 @@ "extends": "../tslint.json", "rules": { // this package augments Rx with namespace level functions - // it would be particualrly strange to type these functions differently - "forbidden-types": false + // it would be particualrly strange to type these functions differently + "ban-types": false } } diff --git a/types/rx-lite-async/rx-lite-async-tests.ts b/types/rx-lite-async/rx-lite-async-tests.ts index 8c88cc135c..43c5155e2f 100644 --- a/types/rx-lite-async/rx-lite-async-tests.ts +++ b/types/rx-lite-async/rx-lite-async-tests.ts @@ -1,27 +1,24 @@ // Tests for RxJS-Async TypeScript definitions // Tests by Igor Oleinikov -namespace Rx.Tests.Async { +let obsNum: Rx.Observable; +let obsStr: Rx.Observable; +let sch: Rx.IScheduler; - var obsNum: Rx.Observable; - var obsStr: Rx.Observable; - var sch: Rx.IScheduler; +function start() { + obsNum = Rx.Observable.start(() => 10, obsStr, sch); + obsNum = Rx.Observable.start(() => 10, obsStr); + obsNum = Rx.Observable.start(() => 10); +} - function start() { - obsNum = Rx.Observable.start(() => 10, obsStr, sch); - obsNum = Rx.Observable.start(() => 10, obsStr); - obsNum = Rx.Observable.start(() => 10); - } +function toAsync() { + obsNum = Rx.Observable.toAsync(() => 1, sch)(); + obsNum = Rx.Observable.toAsync((a1: number) => a1)(1); + obsStr = Rx.Observable.toAsync((a1: string, a2: number) => a1 + a2.toFixed(0))("", 1); + obsStr = Rx.Observable.toAsync((a1: string, a2: number, a3: Date) => a1 + a2.toFixed(0) + a3.toDateString())("", 1, new Date()); + obsStr = Rx.Observable.toAsync((a1: string, a2: number, a3: Date, a4: boolean) => a1 + a2.toFixed(0) + a3.toDateString() + (a4 ? 1 : 0))("", 1, new Date(), false); +} - function toAsync() { - obsNum = Rx.Observable.toAsync(() => 1, sch)(); - obsNum = Rx.Observable.toAsync((a1: number) => a1)(1); - obsStr = Rx.Observable.toAsync((a1: string, a2: number) => a1 + a2.toFixed(0))("", 1); - obsStr = Rx.Observable.toAsync((a1: string, a2: number, a3: Date) => a1 + a2.toFixed(0) + a3.toDateString())("", 1, new Date()); - obsStr = Rx.Observable.toAsync((a1: string, a2: number, a3: Date, a4: boolean) => a1 + a2.toFixed(0) + a3.toDateString() + (a4 ? 1 : 0))("", 1, new Date(), false); - } - - function startAsync() { - var o: Rx.Observable = Rx.Observable.startAsync(() => > {}); - } +function startAsync() { + const o: Rx.Observable = Rx.Observable.startAsync(() => > {}); } diff --git a/types/rx-lite-coincidence/index.d.ts b/types/rx-lite-coincidence/index.d.ts index 0361d025c2..3dc9f4c1be 100644 --- a/types/rx-lite-coincidence/index.d.ts +++ b/types/rx-lite-coincidence/index.d.ts @@ -6,7 +6,6 @@ /// declare namespace Rx { - interface Observable { join( right: Observable, diff --git a/types/rx-lite-experimental/index.d.ts b/types/rx-lite-experimental/index.d.ts index 9659d9fec6..d9c5ad3ac0 100644 --- a/types/rx-lite-experimental/index.d.ts +++ b/types/rx-lite-experimental/index.d.ts @@ -6,7 +6,6 @@ /// declare namespace Rx { - interface Observable { /** * Returns an observable sequence that is the result of invoking the selector on the source sequence, without sharing subscriptions. diff --git a/types/rx-lite-joinpatterns/index.d.ts b/types/rx-lite-joinpatterns/index.d.ts index 658c93d1a4..5e9b9d24b4 100644 --- a/types/rx-lite-joinpatterns/index.d.ts +++ b/types/rx-lite-joinpatterns/index.d.ts @@ -6,7 +6,6 @@ /// declare namespace Rx { - interface Pattern1 { and(other: Observable): Pattern2; thenDo(selector: (item1: T1) => TR): Plan; diff --git a/types/rx-lite/tslint.json b/types/rx-lite/tslint.json index 1bec85bd5c..69a2063c99 100644 --- a/types/rx-lite/tslint.json +++ b/types/rx-lite/tslint.json @@ -3,7 +3,7 @@ "rules": { "unified-signatures": false, "no-empty-interface": false, - "forbidden-types": false, + "ban-types": false, "interface-name": false, "array-type": false, "max-line-length": false, diff --git a/types/selenium-webdriver/chrome.d.ts b/types/selenium-webdriver/chrome.d.ts index 2604b99e89..6bd2fe22a8 100644 --- a/types/selenium-webdriver/chrome.d.ts +++ b/types/selenium-webdriver/chrome.d.ts @@ -59,7 +59,6 @@ export class Options { */ static fromCapabilities(capabilities: webdriver.Capabilities): Options; - /** * Add additional command line arguments to use when launching the Chrome * browser. Each argument may be specified with or without the '--' prefix @@ -70,7 +69,6 @@ export class Options { */ addArguments(...var_args: string[]): Options; - /** * List of Chrome command line switches to exclude that ChromeDriver by default * passes when starting Chrome. Do not prefix switches with '--'. @@ -80,7 +78,6 @@ export class Options { */ excludeSwitches(...var_args: string[]): Options; - /** * Add additional extensions to install when launching Chrome. Each extension * should be specified as the path to the packed CRX file, or a Buffer for an @@ -91,7 +88,6 @@ export class Options { */ addExtensions(...var_args: any[]): Options; - /** * Sets the path to the Chrome binary to use. On Mac OS X, this path should * reference the actual Chrome executable, not just the application binary @@ -105,7 +101,6 @@ export class Options { */ setChromeBinaryPath(path: string): Options; - /** * Sets whether to leave the started Chrome browser running if the controlling * ChromeDriver service is killed before {@link webdriver.WebDriver#quit()} is @@ -116,7 +111,6 @@ export class Options { */ detachDriver(detach: boolean): Options; - /** * Sets the user preferences for Chrome's user profile. See the 'Preferences' * file in Chrome's user data directory for examples. @@ -125,7 +119,6 @@ export class Options { */ setUserPreferences(prefs: any): Options; - /** * Sets the logging preferences for the new session. * @param {!webdriver.logging.Preferences} prefs The logging preferences. @@ -159,7 +152,6 @@ export class Options { */ setPerfLoggingPrefs(prefs: IPerfLoggingPrefs): Options; - /** * Sets preferences for the 'Local State' file in Chrome's user data * directory. @@ -168,7 +160,6 @@ export class Options { */ setLocalState(state: any): Options; - /** * Sets the name of the activity hosting a Chrome-based Android WebView. This * option must be set to connect to an [Android WebView]( @@ -179,7 +170,6 @@ export class Options { */ androidActivity(name: string): Options; - /** * Sets the device serial number to connect to via ADB. If not specified, the * ChromeDriver will select an unused device at random. An error will be @@ -190,7 +180,6 @@ export class Options { */ androidDeviceSerial(serial: string): Options; - /** * Configures the ChromeDriver to launch Chrome on Android via adb. This * function is shorthand for @@ -199,7 +188,6 @@ export class Options { */ androidChrome(): Options; - /** * Sets the package name of the Chrome or WebView app. * @@ -209,7 +197,6 @@ export class Options { */ androidPackage(pkg: string): Options; - /** * Sets the process name of the Activity hosting the WebView (as given by `ps`). * If not specified, the process name is assumed to be the same as @@ -220,7 +207,6 @@ export class Options { */ androidProcess(processName: string): Options; - /** * Sets whether to connect to an already-running instead of the specified * {@linkplain #androidProcess app} instead of launching the app with a clean @@ -231,7 +217,6 @@ export class Options { */ androidUseRunningApp(useRunning: boolean): Options; - /** * Sets the path to Chrome's log file. This path should exist on the machine * that will launch Chrome. @@ -240,7 +225,6 @@ export class Options { */ setChromeLogFile(path: string): Options; - /** * Sets the directory to store Chrome minidumps in. This option is only * supported when ChromeDriver is running on Linux. @@ -249,7 +233,6 @@ export class Options { */ setChromeMinidumpPath(path: string): Options; - /** * Configures Chrome to emulate a mobile device. For more information, refer * to the ChromeDriver project page on [mobile emulation][em]. Configuration @@ -295,7 +278,6 @@ export class Options { */ setProxy(proxy: webdriver.ProxyConfig): Options; - /** * Converts this options instance to a {@link webdriver.Capabilities} object. * @param {webdriver.Capabilities=} opt_capabilities The capabilities to merge @@ -330,7 +312,6 @@ export class ServiceBuilder extends remote.DriverService.Builder { */ setAdbPort(port: number): this; - /** * Sets the path of the log file the driver should log to. If a log file is * not specified, the driver will log to stderr. @@ -339,14 +320,12 @@ export class ServiceBuilder extends remote.DriverService.Builder { */ loggingTo(path: string): this; - /** * Enables verbose logging. * @return {!ServiceBuilder} A self reference. */ enableVerboseLogging(): this; - /** * Sets the number of threads the driver should use to manage HTTP requests. * By default, the driver will use 4 threads. diff --git a/types/selenium-webdriver/edge.d.ts b/types/selenium-webdriver/edge.d.ts index 3fb3408b1f..90b45fc92d 100644 --- a/types/selenium-webdriver/edge.d.ts +++ b/types/selenium-webdriver/edge.d.ts @@ -27,7 +27,6 @@ export class Driver extends webdriver.WebDriver { * Class for managing MicrosoftEdgeDriver specific options. */ export class Options { - /** * Extracts the MicrosoftEdgeDriver specific options from the given * capabilities object. diff --git a/types/selenium-webdriver/firefox.d.ts b/types/selenium-webdriver/firefox.d.ts index 6746c3c683..0c2ecdbe92 100644 --- a/types/selenium-webdriver/firefox.d.ts +++ b/types/selenium-webdriver/firefox.d.ts @@ -20,7 +20,6 @@ export class Binary { */ addArguments(...var_args: string[]): void; - /** * Launches Firefox and eturns a promise that will be fulfilled when the process * terminates. @@ -30,7 +29,6 @@ export class Binary { */ launch(profile: string): webdriver.promise.Promise; - /** * Kills the managed Firefox process. * @return {!promise.Promise} A promise for when the process has terminated. @@ -59,7 +57,6 @@ export class Profile { */ addExtension(extension: string): void; - /** * Sets a desired preference for this profile. * @param {string} key The preference key. @@ -70,7 +67,6 @@ export class Profile { setPreference(key: string, value: number): void; setPreference(key: string, value: boolean): void; - /** * Returns the currently configured value of a profile preference. This does * not include any defaults defined in the profile's template directory user.js @@ -81,7 +77,6 @@ export class Profile { */ getPreference(key: string): any; - /** * @return {number} The port this profile is currently configured to use, or * 0 if the port will be selected at random when the profile is written @@ -89,21 +84,18 @@ export class Profile { */ getPort(): number; - /** * Sets the port to use for the WebDriver extension loaded by this profile. * @param {number} port The desired port, or 0 to use any free port. */ setPort(port: number): void; - /** * @return {boolean} Whether the FirefoxDriver is configured to automatically * accept untrusted SSL certificates. */ acceptUntrustedCerts(): boolean; - /** * Sets whether the FirefoxDriver should automatically accept untrusted SSL * certificates. @@ -111,35 +103,30 @@ export class Profile { */ setAcceptUntrustedCerts(value: boolean): void; - /** * Sets whether to assume untrusted certificates come from untrusted issuers. * @param {boolean} value . */ setAssumeUntrustedCertIssuer(value: boolean): void; - /** * @return {boolean} Whether to assume untrusted certs come from untrusted * issuers. */ assumeUntrustedCertIssuer(): boolean; - /** * Sets whether to use native events with this profile. * @param {boolean} enabled . */ setNativeEventsEnabled(enabled: boolean): void; - /** * Returns whether native events are enabled in this profile. * @return {boolean} . */ nativeEventsEnabled(): boolean; - /** * Writes this profile to disk. * @param {boolean=} opt_excludeWebDriverExt Whether to exclude the WebDriver @@ -151,7 +138,6 @@ export class Profile { */ writeToDisk(opt_excludeWebDriverExt?: boolean): webdriver.promise.Promise; - /** * Encodes this profile as a zipped, base64 encoded directory. * @return {!promise.Promise.} A promise for the encoded profile. @@ -264,7 +250,6 @@ export class Driver extends webdriver.WebDriver { */ static createSession(opt_config?: Options | webdriver.Capabilities, opt_executor?: http.Executor | remote.DriverService, opt_flow?: webdriver.promise.ControlFlow): Driver; - /** * This function is a no-op as file detectors are not supported by this * implementation. @@ -305,4 +290,3 @@ export class ServiceBuilder extends remote.DriverService.Builder { */ setFirefoxBinary(binary: string | Binary): this; } - diff --git a/types/selenium-webdriver/http.d.ts b/types/selenium-webdriver/http.d.ts index 4fc12afb19..72fa1b2c5f 100644 --- a/types/selenium-webdriver/http.d.ts +++ b/types/selenium-webdriver/http.d.ts @@ -42,7 +42,6 @@ export class Response { toString(): string; } - export function post(path: string): any; export function del(path: string): any; export function get(path: string): any; diff --git a/types/selenium-webdriver/index.d.ts b/types/selenium-webdriver/index.d.ts index bfd583302e..08b77d0ce1 100644 --- a/types/selenium-webdriver/index.d.ts +++ b/types/selenium-webdriver/index.d.ts @@ -241,7 +241,6 @@ export namespace error { } export namespace logging { - /** * A hash describing log preferences. * @typedef {Object.} @@ -268,7 +267,7 @@ export namespace logging { * Common log types. * @enum {string} */ - var Type: IType; + const Type: IType; /** * Defines a message level that may be used to control logging output. @@ -984,28 +983,22 @@ export namespace promise { */ constructor(resolver: (resolve: IFulfilledCallback, reject: IRejectedCallback) => void, opt_flow?: ControlFlow); - //region Static Methods + /** + * Creates a promise that is immediately resolved with the given value. + * + * @param {T=} opt_value The value to resolve. + * @return {!ManagedPromise} A promise resolved with the given value. + * @template T + */ + static resolve(opt_value?: T): Promise; - /** - * Creates a promise that is immediately resolved with the given value. - * - * @param {T=} opt_value The value to resolve. - * @return {!ManagedPromise} A promise resolved with the given value. - * @template T - */ - static resolve(opt_value?: T): Promise; - - /** - * Creates a promise that is immediately rejected with the given reason. - * - * @param {*=} opt_reason The rejection reason. - * @return {!ManagedPromise} A new rejected promise. - */ - static reject(opt_reason?: any): Promise; - - //endregion - - // region Methods + /** + * Creates a promise that is immediately rejected with the given reason. + * + * @param {*=} opt_reason The rejection reason. + * @return {!ManagedPromise} A new rejected promise. + */ + static reject(opt_reason?: any): Promise; /** * Registers listeners for when this instance is resolved. @@ -1046,9 +1039,6 @@ export namespace promise { * @template R */ catch(errback: (err: any) => R | IThenable): Promise; - - - // endregion } /** @@ -1124,10 +1114,10 @@ export namespace promise { } interface IControlFlowTimer { - clearInterval: (ms: number) => void; - clearTimeout: (ms: number) => void; - setInterval: (fn: Function, ms: number) => number; - setTimeout: (fn: Function, ms: number) => number; + clearInterval(ms: number): void; + clearTimeout(ms: number): void; + setInterval(fn: Function, ms: number): number; + setTimeout(fn: Function, ms: number): number; } interface IEventType { @@ -1314,7 +1304,6 @@ export class WebElementCondition extends Condition { } export namespace until { - /** * Creates a condition that will wait until the input driver is able to switch * to the designated frame. The target frame may be specified as @@ -1545,7 +1534,7 @@ interface IButton { * * @enum {string} */ -export var Button: IButton; +export const Button: IButton; interface IKey { NULL: string; @@ -1624,7 +1613,7 @@ interface IKey { * @param {...string} var_args The key sequence to concatenate. * @return {string} The null-terminated key sequence. */ - chord: (...var_args: Array) => string; + chord(...var_args: Array): string; } /** @@ -1634,7 +1623,7 @@ interface IKey { * * @enum {string} */ -export var Key: IKey; +export const Key: IKey; /** * Class for defining sequences of complex user interactions. Each sequence @@ -1652,7 +1641,6 @@ export var Key: IKey; * */ export class ActionSequence { - // region Constructors /** @@ -1827,7 +1815,6 @@ export class ActionSequence { // endregion } - /** * Class for defining sequences of user touch interactions. Each sequence * will not be executed until {@link #perform} is called. @@ -1847,7 +1834,6 @@ export class TouchSequence { */ constructor(driver: WebDriver); - /** * Executes this action sequence. * @return {!promise.Promise} A promise that will be resolved once @@ -1855,7 +1841,6 @@ export class TouchSequence { */ perform(): promise.Promise; - /** * Taps an element. * @@ -1864,7 +1849,6 @@ export class TouchSequence { */ tap(elem: WebElement): TouchSequence; - /** * Double taps an element. * @@ -1873,7 +1857,6 @@ export class TouchSequence { */ doubleTap(elem: WebElement): TouchSequence; - /** * Long press on an element. * @@ -1882,7 +1865,6 @@ export class TouchSequence { */ longPress(elem: WebElement): TouchSequence; - /** * Touch down at the given location. * @@ -1891,7 +1873,6 @@ export class TouchSequence { */ tapAndHold(location: ILocation): TouchSequence; - /** * Move a held {@linkplain #tapAndHold touch} to the specified location. * @@ -1900,7 +1881,6 @@ export class TouchSequence { */ move(location: ILocation): TouchSequence; - /** * Release a held {@linkplain #tapAndHold touch} at the specified location. * @@ -1909,7 +1889,6 @@ export class TouchSequence { */ release(location: ILocation): TouchSequence; - /** * Scrolls the touch screen by the given offset. * @@ -2019,7 +1998,6 @@ export class Alert { sendKeys(text: string): promise.Promise; // endregion - } /** @@ -2107,7 +2085,7 @@ interface IBrowser { HTMLUNIT: string; } -export var Browser: IBrowser; +export const Browser: IBrowser; interface ProxyConfig { proxyType: string; @@ -2116,9 +2094,9 @@ interface ProxyConfig { httpProxy?: string; sslProxy?: string; noProxy?: string; - socksProxy?: string, - socksUsername?: string, - socksPassword?: string + socksProxy?: string; + socksUsername?: string; + socksPassword?: string; } /** @@ -2161,7 +2139,6 @@ interface ProxyConfig { * node mytest.js */ export class Builder { - // region Constructors /** @@ -2399,7 +2376,6 @@ export class Builder { * @final */ export class By { - /** * @param {string} using the name of the location strategy to use. * @param {string} value the value to search for. @@ -2539,7 +2515,6 @@ type ByHash = { className: string } | * @enum {string} */ interface ICapability { - /** * Indicates whether a driver should accept all SSL certs by default. This * capability only applies when requesting a new session. To query whether @@ -2548,7 +2523,6 @@ interface ICapability { */ ACCEPT_SSL_CERTS: string; - /** * The browser name. Common browser names are defined in the * {@link Browser} enum. @@ -2628,7 +2602,7 @@ interface ICapability { VERSION: string; } -export var Capability: ICapability; +export const Capability: ICapability; export class Capabilities { // region Constructors @@ -2681,7 +2655,6 @@ export class Capabilities { */ setProxy(proxy: ProxyConfig): Capabilities; - /** * Sets whether native events should be used. * @param {boolean} enabled Whether to enable native events. @@ -2689,7 +2662,6 @@ export class Capabilities { */ setEnableNativeEvents(enabled: boolean): Capabilities; - /** * Sets how elements should be scrolled into view for interaction. * @param {number} behavior The desired scroll behavior: either 0 to align with @@ -2916,7 +2888,7 @@ interface ICommandName { UPLOAD_FILE: string; } -export var CommandName: ICommandName; +export const CommandName: ICommandName; /** * Describes a command to be executed by the WebDriverJS framework. @@ -3046,7 +3018,6 @@ export class EventEmitter { */ addListener(type: string, fn: Function, opt_scope?: any, opt_oneshot?: boolean): EventEmitter; - /** * Registers a one-time listener which will be called only the first time an * event is emitted, after which it will be removed. @@ -3085,7 +3056,6 @@ export class EventEmitter { // endregion } - /** * Interface for navigating back and forth in the browser history. */ @@ -3141,7 +3111,6 @@ export class Navigation { } interface IWebDriverOptionsCookie { - /** * The name of the cookie. */ @@ -3199,7 +3168,7 @@ interface IWebDriverOptionsCookie { * * @type {(!number|undefined)} */ - expiry?: number + expiry?: number; } /** @@ -3354,7 +3323,6 @@ export class Timeouts { * An interface for managing the current window. */ export class Window { - // region Constructors /** @@ -3417,7 +3385,6 @@ export class Window { * Interface for managing WebDriver log records. */ export class Logs { - // region Constructors /** @@ -3460,7 +3427,6 @@ export class Logs { * An interface for changing the focus of the driver to another frame or window. */ export class TargetLocator { - // region Constructors /** @@ -3576,7 +3542,7 @@ export class FileDetector { type CreateSessionCapabilities = Capabilities | { desired?: Capabilities, required?: Capabilities - } + }; /** * Creates a new WebDriver client, which provides control over a browser. @@ -3708,7 +3674,6 @@ export class WebDriver { */ schedule(command: Command, description: string): promise.Promise; - /** * Sets the {@linkplain input.FileDetector file detector} that should be * used with this instance. @@ -3716,21 +3681,18 @@ export class WebDriver { */ setFileDetector(detector: FileDetector): void; - /** * @return {!promise.Promise.} A promise for this * client's session. */ getSession(): promise.Promise; - /** * @return {!promise.Promise.} A promise * that will resolve with the this instance's capabilities. */ getCapabilities(): promise.Promise; - /** * Schedules a command to quit the current session. After calling quit, this * instance will be invalidated and may no longer be used to issue commands @@ -3755,7 +3717,6 @@ export class WebDriver { */ actions(): ActionSequence; - /** * Creates a new touch sequence using this driver. The sequence will not be * scheduled for execution until {@link actions.TouchSequence#perform} is @@ -3770,7 +3731,6 @@ export class WebDriver { */ touchActions(): TouchSequence; - /** * Schedules a command to execute JavaScript in the context of the currently * selected frame or window. The script fragment will be executed as the body @@ -4842,7 +4802,6 @@ export class WebElementPromise extends WebElement implements promise.IThenable(opt_callback?: (value: WebElement) => R, opt_errback?: (error: any) => any): promise.Promise; - /** * Registers a listener for when this promise is rejected. This is synonymous * with the {@code catch} clause in a synchronous API: @@ -4873,7 +4832,6 @@ export class WebElementPromise extends WebElement implements promise.IThenable; } -export module DriverService { - +export namespace DriverService { /** * Creates {@link DriverService} objects that manage a WebDriver server in a * child process. */ - export class Builder { + class Builder { /** * @param {string} exe Path to the executable to use. This executable must * accept the `--port` flag for defining the port to start the server on. @@ -90,7 +89,6 @@ export module DriverService { */ addArguments(...var_args: string[]): this; - /** * Sets the host name to access the server on. If specified, the * {@linkplain #setLoopback() loopback} setting will be ignored. @@ -119,7 +117,6 @@ export module DriverService { */ setPath(basePath: string | null): this; - /** * Sets the port to start the server on. * diff --git a/types/selenium-webdriver/test/chrome.ts b/types/selenium-webdriver/test/chrome.ts index b26c43c2d6..a40afe854e 100644 --- a/types/selenium-webdriver/test/chrome.ts +++ b/types/selenium-webdriver/test/chrome.ts @@ -3,17 +3,17 @@ import * as remote from 'selenium-webdriver/remote'; import * as webdriver from 'selenium-webdriver'; function TestChromeDriver() { - var driver: chrome.Driver = chrome.Driver.createSession(); + let driver: chrome.Driver = chrome.Driver.createSession(); driver = chrome.Driver.createSession(webdriver.Capabilities.chrome()); driver = chrome.Driver.createSession(webdriver.Capabilities.chrome(), new remote.DriverService('executable', new chrome.Options()), new webdriver.promise.ControlFlow()); - var baseDriver: webdriver.WebDriver = driver; + let baseDriver: webdriver.WebDriver = driver; } function TestChromeOptions() { - var options: chrome.Options = new chrome.Options(); + let options: chrome.Options = new chrome.Options(); options = chrome.Options.fromCapabilities(webdriver.Capabilities.chrome()); options = options.addArguments('a', 'b', 'c'); @@ -35,15 +35,15 @@ function TestChromeOptions() { tracingCategories: 'category', bufferUsageReportingInterval: 1000 }); options = options.setProxy({ proxyType: 'proxyType' }); options = options.setUserPreferences('preferences'); - var capabilities: webdriver.Capabilities = options.toCapabilities(); + let capabilities: webdriver.Capabilities = options.toCapabilities(); capabilities = options.toCapabilities(webdriver.Capabilities.chrome()); } function TestServiceBuilder() { - var builder: chrome.ServiceBuilder = new chrome.ServiceBuilder(); + let builder: chrome.ServiceBuilder = new chrome.ServiceBuilder(); builder = new chrome.ServiceBuilder('exe'); - var anything: any = builder.build(); + let anything: any = builder.build(); builder = builder.setPort(8080); builder = builder.setAdbPort(5037); builder = builder.loggingTo('path'); @@ -52,10 +52,10 @@ function TestServiceBuilder() { builder = builder.setPath('path'); builder = builder.setStdio('config'); builder = builder.setStdio(['A', 'B']); - builder = builder.setEnvironment({ 'A': 'a', 'B': 'b' }); + builder = builder.setEnvironment({ A: 'a', B: 'b' }); } function TestChromeModule() { - var service: any = chrome.getDefaultService(); + let service: any = chrome.getDefaultService(); chrome.setDefaultService(new remote.DriverService('executable', new chrome.Options())); } diff --git a/types/selenium-webdriver/test/firefox.ts b/types/selenium-webdriver/test/firefox.ts index 38a3c3634e..0a8cabda41 100644 --- a/types/selenium-webdriver/test/firefox.ts +++ b/types/selenium-webdriver/test/firefox.ts @@ -4,26 +4,26 @@ import * as webdriver from 'selenium-webdriver'; import * as http from 'selenium-webdriver/http'; function TestBinary() { - var binary: firefox.Binary = new firefox.Binary(); + let binary: firefox.Binary = new firefox.Binary(); binary = new firefox.Binary('exe'); binary.addArguments('A', 'B', 'C'); - var promise: webdriver.promise.Promise = binary.kill(); + let promise: webdriver.promise.Promise = binary.kill(); binary.launch('profile').then((result: any) => {}); } function TestFirefoxDriver() { - var driver: firefox.Driver = firefox.Driver.createSession(); + let driver: firefox.Driver = firefox.Driver.createSession(); driver = firefox.Driver.createSession(webdriver.Capabilities.firefox()); driver = firefox.Driver.createSession(webdriver.Capabilities.firefox(), new http.Executor(new http.HttpClient('http://someurl'))); driver = firefox.Driver.createSession(webdriver.Capabilities.firefox(), new remote.DriverService('/dev/null', {})); driver = firefox.Driver.createSession(webdriver.Capabilities.firefox(), new remote.DriverService('/dev/null', {}), new webdriver.promise.ControlFlow()); - var baseDriver: webdriver.WebDriver = driver; + let baseDriver: webdriver.WebDriver = driver; } function TestFirefoxOptions() { - var options: firefox.Options = new firefox.Options(); + let options: firefox.Options = new firefox.Options(); options = options.setBinary('binary'); options = options.setBinary(new firefox.Binary()); @@ -31,19 +31,19 @@ function TestFirefoxOptions() { options = options.setProfile('profile'); options = options.setProfile(new firefox.Profile()); options = options.setProxy({ proxyType: 'proxy' }); - var capabilities: webdriver.Capabilities = options.toCapabilities(); + let capabilities: webdriver.Capabilities = options.toCapabilities(); } function TestFirefoxProfile() { - var profile: firefox.Profile = new firefox.Profile(); + let profile: firefox.Profile = new firefox.Profile(); profile = new firefox.Profile('dir'); - var bool: boolean = profile.acceptUntrustedCerts(); + let bool: boolean = profile.acceptUntrustedCerts(); profile.addExtension('ext'); bool = profile.assumeUntrustedCertIssuer(); profile.encode().then((prof: string) => {}); - var num: number = profile.getPort(); - var anything: any = profile.getPreference('key'); + let num: number = profile.getPort(); + let anything: any = profile.getPreference('key'); bool = profile.nativeEventsEnabled(); profile.setAcceptUntrustedCerts(true); profile.setAssumeUntrustedCertIssuer(true); @@ -52,16 +52,15 @@ function TestFirefoxProfile() { profile.setPreference('key', 'value'); profile.setPreference('key', 5); profile.setPreference('key', true); - var stringPromise: webdriver.promise.Promise = profile.writeToDisk(); + let stringPromise: webdriver.promise.Promise = profile.writeToDisk(); stringPromise = profile.writeToDisk(true); } - function TestServiceBuilder() { - var builder: firefox.ServiceBuilder = new firefox.ServiceBuilder(); + let builder: firefox.ServiceBuilder = new firefox.ServiceBuilder(); builder = new firefox.ServiceBuilder('exe'); - var anything: any = builder.build(); + let anything: any = builder.build(); builder = builder.setPort(8080); builder = builder.enableVerboseLogging(); builder = builder.enableVerboseLogging(true); @@ -70,5 +69,5 @@ function TestServiceBuilder() { builder = builder.setPath('path'); builder = builder.setStdio('config'); builder = builder.setStdio(['A', 'B']); - builder = builder.setEnvironment({ 'A': 'a', 'B': 'b' }); + builder = builder.setEnvironment({ A: 'a', B: 'b' }); } diff --git a/types/selenium-webdriver/test/index.ts b/types/selenium-webdriver/test/index.ts index 2556e7e2a8..5d4f8e8b4e 100644 --- a/types/selenium-webdriver/test/index.ts +++ b/types/selenium-webdriver/test/index.ts @@ -6,15 +6,15 @@ import * as remote from 'selenium-webdriver/remote'; import * as testing from 'selenium-webdriver/testing'; function TestBuilder() { - var builder: webdriver.Builder = new webdriver.Builder(); + let builder: webdriver.Builder = new webdriver.Builder(); - var driver: webdriver.WebDriver = builder.build(); + let driver: webdriver.WebDriver = builder.build(); builder = builder.forBrowser('name'); builder = builder.forBrowser('name', 'version'); builder = builder.forBrowser('name', 'version', 'platform'); - var cap: webdriver.Capabilities = builder.getCapabilities(); - var str: string = builder.getServerUrl(); + let cap: webdriver.Capabilities = builder.getCapabilities(); + let str: string = builder.getServerUrl(); builder = builder.setAlertBehavior('behavior'); builder = builder.setChromeOptions(new chrome.Options()); @@ -31,13 +31,13 @@ function TestBuilder() { } function TestActionSequence() { - var driver: webdriver.WebDriver = new webdriver.Builder(). + let driver: webdriver.WebDriver = new webdriver.Builder(). withCapabilities(webdriver.Capabilities.chrome()). build(); - var sequence: webdriver.ActionSequence = new webdriver.ActionSequence(driver); - var element: webdriver.WebElement = new webdriver.WebElement(driver, 'elementId'); - var promise: webdriver.promise.Promise; + let sequence: webdriver.ActionSequence = new webdriver.ActionSequence(driver); + let element: webdriver.WebElement = new webdriver.WebElement(driver, 'elementId'); + let promise: webdriver.promise.Promise; element = new webdriver.WebElement(driver, promise); // Click @@ -87,12 +87,12 @@ function TestActionSequence() { } function TestTouchSequence() { - var driver: webdriver.WebDriver = new webdriver.Builder(). + let driver: webdriver.WebDriver = new webdriver.Builder(). withCapabilities(webdriver.Capabilities.chrome()). build(); - var element: webdriver.WebElement = new webdriver.WebElement(driver, 'elementId'); + let element: webdriver.WebElement = new webdriver.WebElement(driver, 'elementId'); - var sequence: webdriver.TouchSequence = new webdriver.TouchSequence(driver); + let sequence: webdriver.TouchSequence = new webdriver.TouchSequence(driver); sequence = sequence.tap(element); sequence = sequence.doubleTap(element); @@ -109,11 +109,11 @@ function TestTouchSequence() { } function TestAlert() { - var driver: webdriver.WebDriver = new webdriver.Builder(). + let driver: webdriver.WebDriver = new webdriver.Builder(). withCapabilities(webdriver.Capabilities.chrome()). build(); - var alert: webdriver.Alert = driver.switchTo().alert(); + let alert: webdriver.Alert = driver.switchTo().alert(); alert.accept().then(() => {}); alert.dismiss().then(() => {}); @@ -122,7 +122,7 @@ function TestAlert() { } function TestBrowser() { - var browser: string; + let browser: string; browser = webdriver.Browser.ANDROID; browser = webdriver.Browser.CHROME; @@ -137,7 +137,7 @@ function TestBrowser() { } function TestButton() { - var button: string; + let button: string; button = webdriver.Button.LEFT; button = webdriver.Button.MIDDLE; @@ -145,14 +145,14 @@ function TestButton() { } function TestCapabilities() { - var capabilities: webdriver.Capabilities = new webdriver.Capabilities(); + let capabilities: webdriver.Capabilities = new webdriver.Capabilities(); capabilities = new webdriver.Capabilities(webdriver.Capabilities.chrome()); - var objCapabilities: any = {}; + let objCapabilities: any = {}; objCapabilities[webdriver.Capability.BROWSER_NAME] = webdriver.Browser.PHANTOM_JS; capabilities = new webdriver.Capabilities(objCapabilities); - var anything: any = capabilities.get(webdriver.Capability.SECURE_SSL); - var check: boolean = capabilities.has(webdriver.Capability.SECURE_SSL); + let anything: any = capabilities.get(webdriver.Capability.SECURE_SSL); + let check: boolean = capabilities.has(webdriver.Capability.SECURE_SSL); capabilities = capabilities.merge(capabilities); capabilities = capabilities.merge(objCapabilities); capabilities = capabilities.set(webdriver.Capability.VERSION, { abc: 'def' }); @@ -180,7 +180,7 @@ function TestCapabilities() { } function TestCapability() { - var capability: string; + let capability: string; capability = webdriver.Capability.ACCEPT_SSL_CERTS; capability = webdriver.Capability.BROWSER_NAME; @@ -202,19 +202,19 @@ function TestCapability() { } function TestCommand() { - var command: webdriver.Command = new webdriver.Command(webdriver.CommandName.ADD_COOKIE); + let command: webdriver.Command = new webdriver.Command(webdriver.CommandName.ADD_COOKIE); - var name: string = command.getName(); - var param: any = command.getParameter('param'); + let name: string = command.getName(); + let param: any = command.getParameter('param'); - var params: any = command.getParameters(); + let params: any = command.getParameters(); command = command.setParameter('param', 123); command = command.setParameters({ param: 123 }); } function TestCommandName() { - var command: string; + let command: string; command = webdriver.CommandName.ACCEPT_ALERT; command = webdriver.CommandName.ADD_COOKIE; @@ -315,21 +315,21 @@ function TestCommandName() { } function TestEventEmitter() { - var emitter: webdriver.EventEmitter = new webdriver.EventEmitter(); + let emitter: webdriver.EventEmitter = new webdriver.EventEmitter(); - var callback = (a: number, b: number, c: number) => {}; + let callback = (a: number, b: number, c: number) => {}; emitter = emitter.addListener('ABC', callback); emitter = emitter.addListener('ABC', callback, this); emitter.emit('ABC', 1, 2, 3); - var listeners = emitter.listeners('ABC'); + let listeners = emitter.listeners('ABC'); if (listeners[0].oneshot) { listeners[0].fn.apply(listeners[0].scope); } - var length: number = listeners.length; - var listenerInfo = listeners[0]; + let length: number = listeners.length; + let listenerInfo = listeners[0]; if (listenerInfo.oneshot) { listenerInfo.fn.apply(listenerInfo.scope, [1, 2, 3]); } @@ -347,7 +347,7 @@ function TestEventEmitter() { } function TestKey() { - var key: string; + let key: string; key = webdriver.Key.ADD; key = webdriver.Key.ALT; @@ -412,13 +412,13 @@ function TestKey() { } function TestBy() { - var driver: webdriver.WebDriver = new webdriver.Builder(). + let driver: webdriver.WebDriver = new webdriver.Builder(). withCapabilities(webdriver.Capabilities.chrome()). build(); - var locator: webdriver.By = new webdriver.By('class name', 'class'); + let locator: webdriver.By = new webdriver.By('class name', 'class'); - var str: string = locator.toString(); + let str: string = locator.toString(); locator = webdriver.By.className('class'); locator = webdriver.By.css('css'); @@ -430,9 +430,9 @@ function TestBy() { locator = webdriver.By.xpath('xpath'); // Can import 'By' without import declarations - var By = webdriver.By; + let By = webdriver.By; - var locatorHash: webdriver.ByHash; + let locatorHash: webdriver.ByHash; locatorHash = { className: 'class' }; locatorHash = { css: 'css' }; locatorHash = { id: 'id' }; @@ -446,45 +446,45 @@ function TestBy() { } function TestSession() { - var session: webdriver.Session = new webdriver.Session('ABC', webdriver.Capabilities.android()); - var capabilitiesObj: any = {}; + let session: webdriver.Session = new webdriver.Session('ABC', webdriver.Capabilities.android()); + let capabilitiesObj: any = {}; capabilitiesObj[webdriver.Capability.BROWSER_NAME] = webdriver.Browser.ANDROID; capabilitiesObj[webdriver.Capability.PLATFORM] = 'ANDROID'; session = new webdriver.Session('ABC', capabilitiesObj); - var capabilities: webdriver.Capabilities = session.getCapabilities(); - var capability: any = session.getCapability(webdriver.Capability.BROWSER_NAME); - var id: string = session.getId(); - var data: string = session.toJSON(); + let capabilities: webdriver.Capabilities = session.getCapabilities(); + let capability: any = session.getCapability(webdriver.Capability.BROWSER_NAME); + let id: string = session.getId(); + let data: string = session.toJSON(); } function TestWebDriverFileDetector() { - var driver: webdriver.WebDriver = new webdriver.Builder(). + let driver: webdriver.WebDriver = new webdriver.Builder(). withCapabilities(webdriver.Capabilities.chrome()). build(); - var fileDetector: webdriver.FileDetector = new webdriver.FileDetector(); + let fileDetector: webdriver.FileDetector = new webdriver.FileDetector(); fileDetector.handleFile(driver, 'path/to/file').then((path: string) => {}); } function TestWebDriverLogs() { - var driver: webdriver.WebDriver = new webdriver.Builder(). + let driver: webdriver.WebDriver = new webdriver.Builder(). withCapabilities(webdriver.Capabilities.chrome()). build(); - var logs: webdriver.Logs = new webdriver.Logs(driver); + let logs: webdriver.Logs = new webdriver.Logs(driver); logs.get(webdriver.logging.Type.BROWSER).then((entries: webdriver.logging.Entry[]) => {}); logs.getAvailableLogTypes().then((types: string[]) => {}); } function TestWebDriverNavigation() { - var driver: webdriver.WebDriver = new webdriver.Builder(). + let driver: webdriver.WebDriver = new webdriver.Builder(). withCapabilities(webdriver.Capabilities.chrome()). build(); - var navigation: webdriver.Navigation = new webdriver.Navigation(driver); + let navigation: webdriver.Navigation = new webdriver.Navigation(driver); navigation.back().then(() => {}); navigation.forward().then(() => {}); @@ -493,19 +493,19 @@ function TestWebDriverNavigation() { } function TestWebDriverOptions() { - var driver: webdriver.WebDriver = new webdriver.Builder(). + let driver: webdriver.WebDriver = new webdriver.Builder(). withCapabilities(webdriver.Capabilities.chrome()). build(); - var options: webdriver.Options = new webdriver.Options(driver); - var promise: webdriver.promise.Promise; + let options: webdriver.Options = new webdriver.Options(driver); + let promise: webdriver.promise.Promise; - var name: string = 'name'; - var value: string = 'value'; - var path: string = 'path'; - var domain: string = 'domain'; - var secure: boolean = true; - var httpOnly: boolean = true; + let name: string = 'name'; + let value: string = 'value'; + let path: string = 'path'; + let domain: string = 'domain'; + let secure: boolean = true; + let httpOnly: boolean = true; // Add Cookie promise = options.addCookie({ name, value }); @@ -519,37 +519,37 @@ function TestWebDriverOptions() { promise = options.deleteAllCookies(); promise = options.deleteCookie('name'); options.getCookie('name').then((cookie: webdriver.IWebDriverCookie) => { - var expiry: number = cookie.expiry; + let expiry: number = cookie.expiry; }); options.getCookies().then((cookies: webdriver.IWebDriverCookie[]) => { }); - var logs: webdriver.Logs = options.logs(); - var timeouts: webdriver.Timeouts = options.timeouts(); - var window: webdriver.Window = options.window(); + let logs: webdriver.Logs = options.logs(); + let timeouts: webdriver.Timeouts = options.timeouts(); + let window: webdriver.Window = options.window(); } function TestWebDriverTargetLocator() { - var driver: webdriver.WebDriver = new webdriver.Builder(). + let driver: webdriver.WebDriver = new webdriver.Builder(). withCapabilities(webdriver.Capabilities.chrome()). build(); - var locator: webdriver.TargetLocator = new webdriver.TargetLocator(driver); - var promise: webdriver.promise.Promise; + let locator: webdriver.TargetLocator = new webdriver.TargetLocator(driver); + let promise: webdriver.promise.Promise; - var element: webdriver.WebElement = locator.activeElement(); - var alert: webdriver.Alert = locator.alert(); + let element: webdriver.WebElement = locator.activeElement(); + let alert: webdriver.Alert = locator.alert(); promise = locator.defaultContent(); promise = locator.frame(1); promise = locator.window('nameOrHandle'); } function TestWebDriverTimeouts() { - var driver: webdriver.WebDriver = new webdriver.Builder(). + let driver: webdriver.WebDriver = new webdriver.Builder(). withCapabilities(webdriver.Capabilities.chrome()). build(); - var timeouts: webdriver.Timeouts = new webdriver.Timeouts(driver); - var promise: webdriver.promise.Promise; + let timeouts: webdriver.Timeouts = new webdriver.Timeouts(driver); + let promise: webdriver.promise.Promise; promise = timeouts.implicitlyWait(123); promise = timeouts.pageLoadTimeout(123); @@ -557,14 +557,14 @@ function TestWebDriverTimeouts() { } function TestWebDriverWindow() { - var driver: webdriver.WebDriver = new webdriver.Builder(). + let driver: webdriver.WebDriver = new webdriver.Builder(). withCapabilities(webdriver.Capabilities.chrome()). build(); - var window: webdriver.Window = new webdriver.Window(driver); - var locationPromise: webdriver.promise.Promise; - var sizePromise: webdriver.promise.Promise; - var voidPromise: webdriver.promise.Promise; + let window: webdriver.Window = new webdriver.Window(driver); + let locationPromise: webdriver.promise.Promise; + let sizePromise: webdriver.promise.Promise; + let voidPromise: webdriver.promise.Promise; locationPromise = window.getPosition(); sizePromise = window.getSize(); @@ -574,28 +574,28 @@ function TestWebDriverWindow() { } function TestWebDriver() { - var session: webdriver.Session = new webdriver.Session('ABC', webdriver.Capabilities.android()); - var sessionPromise: webdriver.promise.Promise; - var httpClient: http.HttpClient = new http.HttpClient('http://someserver'); - var executor: http.Executor = new http.Executor(httpClient); - var flow: webdriver.promise.ControlFlow = new webdriver.promise.ControlFlow(); - var driver: webdriver.WebDriver = new webdriver.WebDriver(session, executor); + let session: webdriver.Session = new webdriver.Session('ABC', webdriver.Capabilities.android()); + let sessionPromise: webdriver.promise.Promise; + let httpClient: http.HttpClient = new http.HttpClient('http://someserver'); + let executor: http.Executor = new http.Executor(httpClient); + let flow: webdriver.promise.ControlFlow = new webdriver.promise.ControlFlow(); + let driver: webdriver.WebDriver = new webdriver.WebDriver(session, executor); driver = new webdriver.WebDriver(session, executor, flow); driver = new webdriver.WebDriver(sessionPromise, executor); driver = new webdriver.WebDriver(sessionPromise, executor, flow); - var voidPromise: webdriver.promise.Promise; - var stringPromise: webdriver.promise.Promise; - var booleanPromise: webdriver.promise.Promise; - var webElementPromise: webdriver.WebElementPromise; + let voidPromise: webdriver.promise.Promise; + let stringPromise: webdriver.promise.Promise; + let booleanPromise: webdriver.promise.Promise; + let webElementPromise: webdriver.WebElementPromise; - var actions: webdriver.ActionSequence = driver.actions(); - var touchActions: webdriver.TouchSequence = driver.touchActions(); + let actions: webdriver.ActionSequence = driver.actions(); + let touchActions: webdriver.TouchSequence = driver.touchActions(); // call stringPromise = driver.call(() => 'value'); stringPromise = driver.call(() => stringPromise); - stringPromise = driver.call(() => { var d: any = this; return 'value'; }, driver); + stringPromise = driver.call(() => { let d: any = this; return 'value'; }, driver); stringPromise = driver.call((a: number) => 'value', driver, 1); voidPromise = driver.close(); @@ -614,7 +614,7 @@ function TestWebDriver() { stringPromise = driver.executeScript((a: number) => {}, 1); // findElement - var element: webdriver.WebElement; + let element: webdriver.WebElement; element = driver.findElement(webdriver.By.id('ABC')); element = driver.findElement(webdriver.By.js('function(){}')); @@ -631,11 +631,11 @@ function TestWebDriver() { stringPromise = driver.getTitle(); stringPromise = driver.getWindowHandle(); - var options: webdriver.Options = driver.manage(); - var navigation: webdriver.Navigation = driver.navigate(); - var locator: webdriver.TargetLocator = driver.switchTo(); + let options: webdriver.Options = driver.manage(); + let navigation: webdriver.Navigation = driver.navigate(); + let locator: webdriver.TargetLocator = driver.switchTo(); - var fileDetector: webdriver.FileDetector = new webdriver.FileDetector(); + let fileDetector: webdriver.FileDetector = new webdriver.FileDetector(); driver.setFileDetector(fileDetector); voidPromise = driver.quit(); @@ -643,7 +643,7 @@ function TestWebDriver() { voidPromise = driver.sleep(123); stringPromise = driver.takeScreenshot(); - var booleanCondition: webdriver.Condition; + let booleanCondition: webdriver.Condition; booleanPromise = driver.wait(booleanPromise); booleanPromise = driver.wait(booleanCondition); booleanPromise = driver.wait((driver: webdriver.WebDriver) => true); @@ -660,24 +660,24 @@ function TestWebDriver() { } function TestSerializable() { - var serializable: webdriver.Serializable; - var serial: string | webdriver.promise.IThenable = serializable.serialize(); + let serializable: webdriver.Serializable; + let serial: string | webdriver.promise.IThenable = serializable.serialize(); } function TestWebElement() { - var driver: webdriver.WebDriver = new webdriver.Builder(). + let driver: webdriver.WebDriver = new webdriver.Builder(). withCapabilities(webdriver.Capabilities.chrome()). build(); - var promise: webdriver.promise.Promise; - var element: webdriver.WebElement; + let promise: webdriver.promise.Promise; + let element: webdriver.WebElement; element = new webdriver.WebElement(driver, 'elementId'); element = new webdriver.WebElement(driver, promise); - var voidPromise: webdriver.promise.Promise; - var stringPromise: webdriver.promise.Promise; - var booleanPromise: webdriver.promise.Promise; + let voidPromise: webdriver.promise.Promise; + let stringPromise: webdriver.promise.Promise; + let booleanPromise: webdriver.promise.Promise; voidPromise = element.clear(); voidPromise = element.click(); @@ -709,11 +709,11 @@ function TestWebElement() { } function TestWebElementPromise() { - var driver: webdriver.WebDriver = new webdriver.Builder(). + let driver: webdriver.WebDriver = new webdriver.Builder(). withCapabilities(webdriver.Capabilities.chrome()). build(); - var elementPromise: webdriver.WebElementPromise = driver.findElement(webdriver.By.id('id')); + let elementPromise: webdriver.WebElementPromise = driver.findElement(webdriver.By.id('id')); elementPromise.then(); elementPromise.then((element: webdriver.WebElement) => {}); @@ -722,11 +722,11 @@ function TestWebElementPromise() { } function TestLogging() { - var preferences: webdriver.logging.Preferences = new webdriver.logging.Preferences(); + let preferences: webdriver.logging.Preferences = new webdriver.logging.Preferences(); preferences.setLevel(webdriver.logging.Type.BROWSER, webdriver.logging.Level.ALL); - var prefs: any = preferences.toJSON(); + let prefs: any = preferences.toJSON(); - var level: webdriver.logging.Level = webdriver.logging.getLevel('OFF'); + let level: webdriver.logging.Level = webdriver.logging.getLevel('OFF'); level = webdriver.logging.getLevel(1); level = webdriver.logging.Level.ALL; @@ -736,10 +736,10 @@ function TestLogging() { level = webdriver.logging.Level.SEVERE; level = webdriver.logging.Level.WARNING; - var name: string = level.name; - var value: number = level.value; + let name: string = level.name; + let value: number = level.value; - var type: string; + let type: string; type = webdriver.logging.Type.BROWSER; type = webdriver.logging.Type.CLIENT; type = webdriver.logging.Type.DRIVER; @@ -748,7 +748,7 @@ function TestLogging() { } function TestLoggingEntry() { - var entry: webdriver.logging.Entry; + let entry: webdriver.logging.Entry; entry = new webdriver.logging.Entry(webdriver.logging.Level.ALL, 'ABC'); entry = new webdriver.logging.Entry('ALL', 'ABC'); @@ -757,23 +757,23 @@ function TestLoggingEntry() { entry = new webdriver.logging.Entry(webdriver.logging.Level.ALL, 'ABC', 123, webdriver.logging.Type.BROWSER); entry = new webdriver.logging.Entry('ALL', 'ABC', 123, webdriver.logging.Type.BROWSER); - var entryObj: any = entry.toJSON(); + let entryObj: any = entry.toJSON(); - var message: string = entry.message; - var timestamp: number = entry.timestamp; - var type: string = entry.type; + let message: string = entry.message; + let timestamp: number = entry.timestamp; + let type: string = entry.type; } function TestPromiseModule() { - var cancellationError: webdriver.promise.CancellationError = new webdriver.promise.CancellationError(); + let cancellationError: webdriver.promise.CancellationError = new webdriver.promise.CancellationError(); cancellationError = new webdriver.promise.CancellationError('message'); - var str: string = cancellationError.message; + let str: string = cancellationError.message; str = cancellationError.name; - var stringPromise: webdriver.promise.Promise; - var numberPromise: webdriver.promise.Promise; - var booleanPromise: webdriver.promise.Promise; - var voidPromise: webdriver.promise.Promise; + let stringPromise: webdriver.promise.Promise; + let numberPromise: webdriver.promise.Promise; + let booleanPromise: webdriver.promise.Promise; + let voidPromise: webdriver.promise.Promise; webdriver.promise.all([stringPromise]).then((values: string[]) => {}); @@ -791,7 +791,7 @@ function TestPromiseModule() { webdriver.promise.consume((a: number, b: number, c: number) => 5, this, 1, 2, 3) .then((value: number) => {}); - var numbersPromise: webdriver.promise.Promise = webdriver.promise.filter([1, 2, 3], (element: number, type: any, index: number, arr: number[]) => { + let numbersPromise: webdriver.promise.Promise = webdriver.promise.filter([1, 2, 3], (element: number, type: any, index: number, arr: number[]) => { return true; }); numbersPromise = webdriver.promise.filter([1, 2, 3], (element: number, type: any, index: number, arr: number[]) => { @@ -817,11 +817,11 @@ function TestPromiseModule() { return true; }, this); - var flow: webdriver.promise.ControlFlow = webdriver.promise.controlFlow(); + let flow: webdriver.promise.ControlFlow = webdriver.promise.controlFlow(); stringPromise = webdriver.promise.createFlow((newFlow: webdriver.promise.ControlFlow) => 'ABC'); - var deferred: webdriver.promise.Deferred; + let deferred: webdriver.promise.Deferred; deferred = webdriver.promise.defer(); deferred = webdriver.promise.defer(); @@ -837,8 +837,8 @@ function TestPromiseModule() { stringPromise = webdriver.promise.fullyResolved('abc'); - var bool: boolean = webdriver.promise.isGenerator(() => {}); - var isPromise: boolean = webdriver.promise.isPromise('ABC'); + let bool: boolean = webdriver.promise.isGenerator(() => {}); + let isPromise: boolean = webdriver.promise.isPromise('ABC'); stringPromise = webdriver.promise.rejected('{a: 123}'); @@ -848,18 +848,18 @@ function TestPromiseModule() { } function TestUntilModule() { - var driver: webdriver.WebDriver = new webdriver.Builder(). + let driver: webdriver.WebDriver = new webdriver.Builder(). withCapabilities(webdriver.Capabilities.chrome()). build(); - var conditionB: webdriver.Condition = new webdriver.Condition('message', (driver: webdriver.WebDriver) => true); - var conditionBBase: webdriver.Condition = conditionB; - var conditionWebElement: webdriver.WebElementCondition; - var conditionWebElements: webdriver.Condition; + let conditionB: webdriver.Condition = new webdriver.Condition('message', (driver: webdriver.WebDriver) => true); + let conditionBBase: webdriver.Condition = conditionB; + let conditionWebElement: webdriver.WebElementCondition; + let conditionWebElements: webdriver.Condition; conditionB = webdriver.until.ableToSwitchToFrame(5); - var conditionAlert: webdriver.Condition = webdriver.until.alertIsPresent(); - var el: webdriver.WebElement = driver.findElement(webdriver.By.id('id')); + let conditionAlert: webdriver.Condition = webdriver.until.alertIsPresent(); + let el: webdriver.WebElement = driver.findElement(webdriver.By.id('id')); conditionB = webdriver.until.stalenessOf(el); conditionB = webdriver.until.titleContains('text'); conditionB = webdriver.until.titleIs('text'); @@ -882,31 +882,31 @@ function TestUntilModule() { } function TestControlFlow() { - var flow: webdriver.promise.ControlFlow; + let flow: webdriver.promise.ControlFlow; flow = new webdriver.promise.ControlFlow(); - var emitter: webdriver.EventEmitter = flow; + let emitter: webdriver.EventEmitter = flow; - var eventType: string; + let eventType: string; eventType = webdriver.promise.ControlFlow.EventType.IDLE; eventType = webdriver.promise.ControlFlow.EventType.RESET; eventType = webdriver.promise.ControlFlow.EventType.SCHEDULE_TASK; eventType = webdriver.promise.ControlFlow.EventType.UNCAUGHT_EXCEPTION; - var stringPromise: webdriver.promise.Promise; + let stringPromise: webdriver.promise.Promise; stringPromise = flow.execute(() => 'value'); stringPromise = flow.execute(() => stringPromise); stringPromise = flow.execute(() => stringPromise, 'Description'); - var schedule: string; + let schedule: string; schedule = flow.toString(); schedule = flow.getSchedule(); schedule = flow.getSchedule(true); flow.reset(); - var voidPromise: webdriver.promise.Promise = flow.timeout(123); + let voidPromise: webdriver.promise.Promise = flow.timeout(123); voidPromise = flow.timeout(123, 'Description'); stringPromise = flow.wait(stringPromise); @@ -917,12 +917,12 @@ function TestControlFlow() { } function TestDeferred() { - var deferred: webdriver.promise.Deferred; + let deferred: webdriver.promise.Deferred; deferred = new webdriver.promise.Deferred(); deferred = new webdriver.promise.Deferred(new webdriver.promise.ControlFlow()); - var promise: webdriver.promise.Promise = deferred.promise; + let promise: webdriver.promise.Promise = deferred.promise; deferred.errback(new Error('Error')); deferred.errback('Error'); @@ -933,8 +933,8 @@ function TestDeferred() { } function TestPromiseClass() { - var controlFlow: webdriver.promise.ControlFlow; - var promise: webdriver.promise.Promise; + let controlFlow: webdriver.promise.ControlFlow; + let promise: webdriver.promise.Promise; promise = new webdriver.promise.Promise((resolve: (value: string) => void, reject: () => void) => {}); promise = new webdriver.promise.Promise((resolve: (value: webdriver.promise.Promise) => void, reject: () => void) => {}); promise = new webdriver.promise.Promise((resolve: (value: string) => void, reject: () => void) => {}, controlFlow); @@ -946,7 +946,7 @@ function TestPromiseClass() { } function TestThenableClass() { - var thenable: webdriver.promise.Promise = new webdriver.promise.Promise((resolve, reject) => { + let thenable: webdriver.promise.Promise = new webdriver.promise.Promise((resolve, reject) => { resolve('a'); }); @@ -956,8 +956,8 @@ function TestThenableClass() { } async function TestAsyncAwaitable() { - var thenable: webdriver.promise.Promise = new webdriver.promise.Promise((resolve, reject) => resolve('foo')); - var str: string = await thenable; + let thenable: webdriver.promise.Promise = new webdriver.promise.Promise((resolve, reject) => resolve('foo')); + let str: string = await thenable; } function TestTestingModule() { @@ -973,7 +973,6 @@ function TestTestingModule() { testing.iit('My exclusive test.', () => { }); - }); testing.xdescribe('My disabled suite', () => { diff --git a/types/selenium-webdriver/tslint.json b/types/selenium-webdriver/tslint.json index 93fffac84e..f38c4dfc69 100644 --- a/types/selenium-webdriver/tslint.json +++ b/types/selenium-webdriver/tslint.json @@ -1,8 +1,8 @@ { "extends": "../tslint.json", "rules": { + "ban-types": false, "callable-types": false, - "forbidden-types": false, "interface-name": [false], "no-empty-interface": false, "unified-signatures": false diff --git a/types/sharepoint/index.d.ts b/types/sharepoint/index.d.ts index 1908d46b0c..da19c221d4 100644 --- a/types/sharepoint/index.d.ts +++ b/types/sharepoint/index.d.ts @@ -14,7 +14,7 @@ declare function ExecuteOrDelayUntilEventNotified(func: (...args: any[]) => void declare var Strings: any; declare namespace SP { - export class SOD { + class SOD { static execute(fileName: string, functionName: string, ...args: any[]): void; static executeFunc(fileName: string, typeName: string, fn: () => void): void; static executeOrDelayUntilEventNotified(func: (...args: any[]) => void, eventName: string): boolean; @@ -33,7 +33,7 @@ declare namespace SP { static set_ribbonImagePrefetchEnabled(value: boolean): void; } - export enum ListLevelPermissionMask { + enum ListLevelPermissionMask { viewListItems, // : 1, insertListItems, // : 2, editListItems, // : 4, @@ -47,7 +47,7 @@ declare namespace SP { manageLists // : 2048 } - export class HtmlBuilder { + class HtmlBuilder { constructor(); addAttribute(name: string, value: string): void; addCssClass(cssClassName: string): void; @@ -59,7 +59,7 @@ declare namespace SP { toString(): string; } - export class ScriptHelpers { + class ScriptHelpers { static disableWebpartSelection(context: SPClientTemplates.RenderContext): void; static getDocumentQueryPairs(): { [index: string]: string; }; static getFieldFromSchema(schema: SPClientTemplates.ListSchema, fieldName: string): SPClientTemplates.FieldSchema; @@ -84,8 +84,7 @@ declare namespace SP { static resizeImageToSquareLength(imgElement: HTMLImageElement, squareLength: number): void; } - - export class PageContextInfo { + class PageContextInfo { static get_siteServerRelativeUrl(): string; static get_webServerRelativeUrl(): string; static get_webAbsoluteUrl(): string; @@ -107,32 +106,30 @@ declare namespace SP { get_pagePersonalizationScope(): string; } - export class ContextPermissions { + class ContextPermissions { has(perm: number): boolean; hasPermissions(high: number, low: number): boolean; fromJson(json: { High: number; Low: number; }): void; } - export namespace ListOperation { - export namespace ViewOperation { - export function getSelectedView(): string; - export function navigateUp(viewId: string): void; - export function refreshView(viewId: string): void; + namespace ListOperation { + namespace ViewOperation { + function getSelectedView(): string; + function navigateUp(viewId: string): void; + function refreshView(viewId: string): void; } - export namespace Selection { - export function selectListItem(iid: string, bSelect: boolean): void; - export function getSelectedItems(): Array<{ id: number; fsObjType: FileSystemObjectType; }>; - export function getSelectedList(): string; - export function getSelectedView(): string; - export function navigateUp(viewId: string): void; - export function deselectAllListItems(iid: string): void; + namespace Selection { + function selectListItem(iid: string, bSelect: boolean): void; + function getSelectedItems(): Array<{ id: number; fsObjType: FileSystemObjectType; }>; + function getSelectedList(): string; + function getSelectedView(): string; + function navigateUp(viewId: string): void; + function deselectAllListItems(iid: string): void; } - export namespace Overrides { - export function overrideDeleteConfirmation(listId: string, overrideText: string): void; + namespace Overrides { + function overrideDeleteConfirmation(listId: string, overrideText: string): void; } } - - } /** Register function to rerun on partial update in MDS-enabled site.*/ @@ -277,8 +274,8 @@ interface ContextInfo extends SPClientTemplates.RenderContext { SendToLocationName: string; SendToLocationUrl: string; StateInitDone: boolean; - TableCbxFocusHandler: (instance: any, eventArgs: any) => void; - TableMouseoverHandler: (instance: any, eventArgs: any) => void; + TableCbxFocusHandler(instance: any, eventArgs: any): void; + TableMouseoverHandler(instance: any, eventArgs: any): void; TotalListItems: number; WorkflowsAssociated: boolean; clvp: any; @@ -302,7 +299,7 @@ interface ContextInfo extends SPClientTemplates.RenderContext { listTemplate: string; listUrlDir: string; newFormUrl: string; - onRefreshFailed: (context: any, requrest: any, response: any) => void; + onRefreshFailed(context: any, requrest: any, response: any): void; overrideDeleteConfirmation: string; overrideFilterQstring: string; recursiveView: boolean; @@ -322,13 +319,12 @@ interface ContextInfo extends SPClientTemplates.RenderContext { noGroupCollapse: boolean; SiteTemplateId: number; ExcludeFromOfflineClient: boolean; - } declare function GetCurrentCtx(): ContextInfo; declare function SetFullScreenMode(fullscreen: boolean): void; declare namespace SP { - export enum RequestExecutorErrors { + enum RequestExecutorErrors { requestAbortedOrTimedout, unexpectedResponse, httpError, @@ -338,7 +334,7 @@ declare namespace SP { iFrameLoadError } - export class RequestExecutor { + class RequestExecutor { constructor(url: string, options?: any); get_formDigestHandlingEnabled(): boolean; set_formDigestHandlingEnabled(value: boolean): void; @@ -348,7 +344,7 @@ declare namespace SP { attemptLogin(returnUrl: string, success: (response: ResponseInfo) => void, error?: (response: ResponseInfo, error: RequestExecutorErrors, statusText: string) => void): void; } - export interface RequestInfo { + interface RequestInfo { url: string; method?: string; headers?: { [key: string]: string; }; @@ -359,12 +355,12 @@ declare namespace SP { /** Currently need fix to get ginary response. Details: http:// techmikael.blogspot.ru/2013/07/how-to-copy-files-between-sites-using.html */ binaryStringResponseBody?: boolean; timeout?: number; - success?: (response: ResponseInfo) => void; - error?: (response: ResponseInfo, error: RequestExecutorErrors, statusText: string) => void; + success?(response: ResponseInfo): void; + error?(response: ResponseInfo, error: RequestExecutorErrors, statusText: string): void; state?: any; } - export interface ResponseInfo { + interface ResponseInfo { statusCode?: number; statusText?: string; responseAvailable: boolean; @@ -376,11 +372,11 @@ declare namespace SP { state?: any; } - export class ProxyWebRequestExecutor extends Sys.Net.WebRequestExecutor { + class ProxyWebRequestExecutor extends Sys.Net.WebRequestExecutor { constructor(url: string, options?: any); } - export class ProxyWebRequestExecutorFactory implements SP.IWebRequestExecutorFactory { + class ProxyWebRequestExecutorFactory implements SP.IWebRequestExecutorFactory { constructor(url: string, options?: any); createWebRequestExecutor(): ProxyWebRequestExecutor; } @@ -591,7 +587,6 @@ declare class CalloutActionMenuEntry { wzDesc: string); } - declare class CalloutActionMenu { constructor(actionsId: any); addAction(action: CalloutAction): void; @@ -601,7 +596,6 @@ declare class CalloutActionMenu { calculateActionWidth(): void; } - declare class CalloutAction { constructor(options: CalloutActionOptions); getText(): string; @@ -710,7 +704,6 @@ declare class CalloutOptions { positionAlgorithm: (callout: Callout) => void; } - declare class CalloutManager { /** Creates a new callout */ static createNew(options: CalloutOptions): Callout; @@ -737,21 +730,19 @@ declare class CalloutManager { static isAtLeastOneCalloutOn(): boolean; } - declare namespace SPClientTemplates { - - export enum FileSystemObjectType { + enum FileSystemObjectType { Invalid, File, Folder, Web } - export enum ChoiceFormatType { + enum ChoiceFormatType { Dropdown, Radio } - export enum ClientControlMode { + enum ClientControlMode { Invalid, DisplayForm, EditForm, @@ -759,24 +750,24 @@ declare namespace SPClientTemplates { View } - export enum RichTextMode { + enum RichTextMode { Compatible, FullHtml, HtmlAsXml, ThemeHtml } - export enum UrlFormatType { + enum UrlFormatType { Hyperlink, Image } - export enum DateTimeDisplayFormat { + enum DateTimeDisplayFormat { DateOnly, DateTime, TimeOnly } - export enum DateTimeCalendarType { + enum DateTimeCalendarType { None, Gregorian, Japan, @@ -794,20 +785,20 @@ declare namespace SPClientTemplates { SakaEra, UmAlQura } - export enum UserSelectionMode { + enum UserSelectionMode { PeopleOnly, PeopleAndGroups } /** Represents schema for a Choice field in list form or in list view in grid mode */ - export interface FieldSchema_InForm_Choice extends FieldSchema_InForm { + interface FieldSchema_InForm_Choice extends FieldSchema_InForm { /** List of choices for this field. */ Choices: string[]; /** Display format for the choice field */ FormatType: ChoiceFormatType; } /** Represents schema for a Lookup field in list form or in list view in grid mode */ - export interface FieldSchema_InForm_Lookup extends FieldSchema_InForm { + interface FieldSchema_InForm_Lookup extends FieldSchema_InForm { /** Specifies if the field allows multiple values */ AllowMultipleValues: boolean; /** Returns base url for a list display form, e.g. "http:// portal/web/_layouts/15/listform.aspx?PageType=4" @@ -826,10 +817,9 @@ declare namespace SPClientTemplates { ChoiceCount: number; LookupListId: string; - } /** Represents schema for a DateTime field in list form or in list view in grid mode */ - export interface FieldSchema_InForm_DateTime extends FieldSchema_InForm { + interface FieldSchema_InForm_DateTime extends FieldSchema_InForm { /** Type of calendar to use */ CalendarType: DateTimeCalendarType; /** Display format for DateTime field. */ @@ -851,19 +841,19 @@ declare namespace SPClientTemplates { HoursOptions: string[]; } /** Represents schema for a DateTime field in list form or in list view in grid mode */ - export interface FieldSchema_InForm_Geolocation extends FieldSchema_InForm { + interface FieldSchema_InForm_Geolocation extends FieldSchema_InForm { BingMapsKey: string; IsBingMapBlockedInCurrentRegion: boolean; } /** Represents schema for a Choice field in list form or in list view in grid mode */ - export interface FieldSchema_InForm_MultiChoice extends FieldSchema_InForm { + interface FieldSchema_InForm_MultiChoice extends FieldSchema_InForm { /** List of choices for this field. */ MultiChoices: string[]; /** Indicates wherever fill-in choice is allowed */ FillInChoice: boolean; } /** Represents schema for a Choice field in list form or in list view in grid mode */ - export interface FieldSchema_InForm_MultiLineText extends FieldSchema_InForm { + interface FieldSchema_InForm_MultiLineText extends FieldSchema_InForm { /** Specifies whether rich text formatting can be used in the field */ RichText: boolean; /** Changes are appended to the existing text. */ @@ -878,19 +868,19 @@ declare namespace SPClientTemplates { ScriptEditorAdderId: string; } /** Represents schema for a Number field in list form or in list view in grid mode */ - export interface FieldSchema_InForm_Number extends FieldSchema_InForm { + interface FieldSchema_InForm_Number extends FieldSchema_InForm { ShowAsPercentage: boolean; } /** Represents schema for a Number field in list form or in list view in grid mode */ - export interface FieldSchema_InForm_Text extends FieldSchema_InForm { + interface FieldSchema_InForm_Text extends FieldSchema_InForm { MaxLength: number; } /** Represents schema for a Number field in list form or in list view in grid mode */ - export interface FieldSchema_InForm_Url extends FieldSchema_InForm { + interface FieldSchema_InForm_Url extends FieldSchema_InForm { DisplayFormat: UrlFormatType; } /** Represents schema for a Number field in list form or in list view in grid mode */ - export interface FieldSchema_InForm_User extends FieldSchema_InForm { + interface FieldSchema_InForm_User extends FieldSchema_InForm { Presence: boolean; WithPicture: boolean; DefaultRender: boolean; @@ -904,7 +894,7 @@ declare namespace SPClientTemplates { PictureSize: string; } - export interface FieldSchema { + interface FieldSchema { /** Specifies if the field can be edited while list view is in the Grid mode */ AllowGridEditing: boolean; /** String representation of the field type, e.g. "Lookup". Same as SPField.TypeAsString */ @@ -918,7 +908,7 @@ declare namespace SPClientTemplates { /** Represents field schema in Grid mode and on list forms. Consider casting objects of this type to more specific field types, e.g. FieldSchemaInForm_Lookup */ - export interface FieldSchema_InForm extends FieldSchema { + interface FieldSchema_InForm extends FieldSchema { /** Description for this field. */ Description: string; /** Direction of the reading order for the field. */ @@ -941,25 +931,24 @@ declare namespace SPClientTemplates { UseMinWidth: boolean; } - export interface ListSchema { + interface ListSchema { Field: FieldSchema[]; } - - export interface ListSchema_InForm extends ListSchema { + interface ListSchema_InForm extends ListSchema { Field: FieldSchema_InForm[]; } - export interface ListData_InForm { + interface ListData_InForm { Items: Item[]; } - export interface RenderContext_FieldInForm extends RenderContext_Form { + interface RenderContext_FieldInForm extends RenderContext_Form { CurrentGroupIdx: number; CurrentGroup: Group; CurrentItems: Item[]; CurrentFieldSchema: FieldSchema_InForm; CurrentFieldValue: any; } - export interface RenderContext_Form extends RenderContext { + interface RenderContext_Form extends RenderContext { CurrentItem: Item; FieldControlModes: { [fieldInternalName: string]: ClientControlMode; }; FormContext: ClientFormContext; @@ -969,9 +958,7 @@ declare namespace SPClientTemplates { CSRCustomLayout?: boolean; } - - - export interface FieldSchema_InView_LookupField extends FieldSchema_InView { + interface FieldSchema_InView_LookupField extends FieldSchema_InView { /** Either "TRUE" or "FALSE" */ AllowMultipleValues: string; /** Target lookup list display form URL, including PageType and List attributes. */ @@ -979,7 +966,7 @@ declare namespace SPClientTemplates { /** Either "TRUE" or "FALSE" */ HasPrefix: string; } - export interface FieldSchema_InView_UserField extends FieldSchema_InView { + interface FieldSchema_InView_UserField extends FieldSchema_InView { /** Either "TRUE" or "FALSE" */ AllowMultipleValues: string; /** Either "TRUE" or "FALSE" */ @@ -992,7 +979,7 @@ declare namespace SPClientTemplates { DefaultRender: string; } /** Represents field schema in a list view. */ - export interface FieldSchema_InView extends FieldSchema { + interface FieldSchema_InView extends FieldSchema { /** Either "TRUE" or "FALSE" */ CalloutMenu: string; ClassInfo: string; // e.g. "Menu" @@ -1021,7 +1008,7 @@ declare namespace SPClientTemplates { /** Indicates whether the field can be sorted. Either "TRUE" or "FALSE" */ Sortable: string; } - export interface ListSchema_InView extends ListSchema { + interface ListSchema_InView extends ListSchema { /** Key-value object that represents all aggregations defined for the view. Key specifies the field internal name, and value specifies the type of the aggregation. */ Aggregate: { [name: string]: string; }; @@ -1090,7 +1077,7 @@ declare namespace SPClientTemplates { /** Query string parameters that specify current root folder (RootFolder) and folder content type id (FolderCTID) */ ViewSelector_ViewParameters: string; } - export interface ListData_InView { + interface ListData_InView { FilterLink: string; FilterFields: string; FirstRow: number; @@ -1106,12 +1093,12 @@ declare namespace SPClientTemplates { LastRow: number; Row: Item[]; } - export interface RenderContext_GroupInView extends RenderContext_InView { + interface RenderContext_GroupInView extends RenderContext_InView { CurrentGroupIdx: number; CurrentGroup: Group; CurrentItems: Item[]; } - export interface RenderContext_InView extends RenderContext { + interface RenderContext_InView extends RenderContext { AllowCreateFolder: boolean; AllowGridMode: boolean; BasePermissions: { [PermissionName: string]: boolean; }; // SP.BasePermissions? @@ -1199,11 +1186,11 @@ declare namespace SPClientTemplates { wpq: string; WriteSecurity: string; } - export interface RenderContext_ItemInView extends RenderContext_InView { + interface RenderContext_ItemInView extends RenderContext_InView { CurrentItem: Item; CurrentItemIdx: number; } - export interface RenderContext_FieldInView extends RenderContext_ItemInView { + interface RenderContext_FieldInView extends RenderContext_ItemInView { /** If in grid mode (context.inGridMode == true), cast to FieldSchema_InForm, otherwise cast to FieldSchema_InView */ CurrentFieldSchema: FieldSchema_InForm | FieldSchema_InView; CurrentFieldValue: any; @@ -1212,15 +1199,15 @@ declare namespace SPClientTemplates { FormUniqueId: string; } - export interface Item { + interface Item { [fieldInternalName: string]: any; } - export interface Group { + interface Group { Items: Item[]; } type RenderCallback = (ctx: RenderContext) => void; - export interface RenderContext { + interface RenderContext { BaseViewID?: number; ControlMode?: ClientControlMode; CurrentCultureName?: string; @@ -1231,37 +1218,37 @@ declare namespace SPClientTemplates { OnPostRender?: RenderCallback | RenderCallback[]; OnPreRender?: RenderCallback | RenderCallback[]; onRefreshFailed?: any; - RenderBody?: (renderContext: RenderContext) => string; - RenderFieldByName?: (renderContext: RenderContext, fieldName: string) => string; - RenderFields?: (renderContext: RenderContext) => string; - RenderFooter?: (renderContext: RenderContext) => string; - RenderGroups?: (renderContext: RenderContext) => string; - RenderHeader?: (renderContext: RenderContext) => string; - RenderItems?: (renderContext: RenderContext) => string; - RenderView?: (renderContext: RenderContext) => string; + RenderBody?(renderContext: RenderContext): string; + RenderFieldByName?(renderContext: RenderContext, fieldName: string): string; + RenderFields?(renderContext: RenderContext): string; + RenderFooter?(renderContext: RenderContext): string; + RenderGroups?(renderContext: RenderContext): string; + RenderHeader?(renderContext: RenderContext): string; + RenderItems?(renderContext: RenderContext): string; + RenderView?(renderContext: RenderContext): string; SiteClientTag?: string; Templates?: Templates; } /** Must return null in order to fall back to a more common template or to a system default template */ - export type SingleTemplateCallback = (renderContext: RenderContext_InView) => string; + type SingleTemplateCallback = (renderContext: RenderContext_InView) => string; /** Must return null in order to fall back to a more common template or to a system default template */ - export type GroupCallback = (renderContext: RenderContext_GroupInView) => string; + type GroupCallback = (renderContext: RenderContext_GroupInView) => string; /** Must return null in order to fall back to a more common template or to a system default template */ - export type ItemCallback = (renderContext: RenderContext) => string; + type ItemCallback = (renderContext: RenderContext) => string; /** Must return null in order to fall back to a more common template or to a system default template */ - export type FieldCallback = (renderContext: RenderContext) => string; + type FieldCallback = (renderContext: RenderContext) => string; /** Must return null in order to fall back to a more common template or to a system default template */ - export type FieldInFormCallback = (renderContext: RenderContext_FieldInForm) => string; + type FieldInFormCallback = (renderContext: RenderContext_FieldInForm) => string; /** Must return null in order to fall back to a more common template or to a system default template */ - export type FieldInViewCallback = (renderContext: RenderContext_FieldInView) => string; + type FieldInViewCallback = (renderContext: RenderContext_FieldInView) => string; - export interface FieldTemplateOverrides { + interface FieldTemplateOverrides { /** Defines templates for rendering the field on a display form. */ DisplayForm?: FieldInFormCallback; /** Defines templates for rendering the field on an edit form. */ @@ -1272,11 +1259,11 @@ declare namespace SPClientTemplates { View?: FieldInViewCallback; } - export interface FieldTemplates { + interface FieldTemplates { [fieldInternalName: string]: FieldCallback; } - export interface Templates { + interface Templates { View?: RenderCallback | string; // TODO: determine appropriate context type and purpose of this template Body?: RenderCallback | string; // TODO: determine appropriate context type and purpose of this template /** Defines templates for rendering groups (aggregations). */ @@ -1293,11 +1280,11 @@ declare namespace SPClientTemplates { Fields?: FieldTemplates; } - export interface FieldTemplateMap { + interface FieldTemplateMap { [fieldInternalName: string]: FieldTemplateOverrides; } - export interface TemplateOverrides { + interface TemplateOverrides { View?: RenderCallback | string; // TODO: determine appropriate context type and purpose of this template Body?: RenderCallback | string; // TODO: determine appropriate context type and purpose of this template /** Defines templates for rendering groups (aggregations). */ @@ -1313,7 +1300,7 @@ declare namespace SPClientTemplates { /** Defines templates for fields rendering. The field is specified by it's internal name. */ Fields?: FieldTemplateMap; } - export interface TemplateOverridesOptions { + interface TemplateOverridesOptions { /** Template overrides */ Templates?: TemplateOverrides; @@ -1333,12 +1320,12 @@ declare namespace SPClientTemplates { If not defined, the templates will be applied to all views. */ BaseViewID?: number | string; } - export class TemplateManager { + class TemplateManager { static RegisterTemplateOverrides(renderCtx: TemplateOverridesOptions): void; static GetTemplates(renderCtx: RenderContext): Templates; } - export interface ClientUserValue { + interface ClientUserValue { lookupId: number; lookupValue: string; displayStr: string; @@ -1349,15 +1336,15 @@ declare namespace SPClientTemplates { department: string; jobTitle: string; } - export interface ClientLookupValue { + interface ClientLookupValue { LookupId: number; LookupValue: string; } - export interface ClientUrlValue { + interface ClientUrlValue { URL: string; Description: string; } - export class Utility { + class Utility { static ComputeRegisterTypeInfo(renderCtx: TemplateOverridesOptions): any; static ControlModeToString(mode: SPClientTemplates.ClientControlMode): string; static FileSystemObjectTypeToString(fileSystemObjectType: SPClientTemplates.FileSystemObjectType): string; @@ -1387,7 +1374,7 @@ declare namespace SPClientTemplates { static UserMultiValueDelimitString: string; } - export class ClientFormContext { + class ClientFormContext { fieldValue: any; fieldSchema: SPClientTemplates.FieldSchema_InForm; fieldName: string; @@ -1421,7 +1408,6 @@ declare namespace SPClientTemplates { registerClientValidator(fieldname: string, validator: SPClientForms.ClientValidation.ValidatorSet): void; registerHasValueChangedCallback(fieldname: string, callback: (eventArg?: any) => void): void; } - } declare function GenerateIID(renderCtx: SPClientTemplates.RenderContext_ItemInView): string; @@ -1432,38 +1418,36 @@ declare function CoreRender(template: any, context: any): string; declare namespace SPClientForms { namespace ClientValidation { - export class ValidationResult { + class ValidationResult { constructor(hasErrors: boolean, errorMsg: string); } - export class ValidatorSet { + class ValidatorSet { RegisterValidator(validator: IValidator): void; } // tslint:disable-next-line: interface-name - export interface IValidator { + interface IValidator { Validate(value: any): ValidationResult; } - export class RequiredValidator implements IValidator { + class RequiredValidator implements IValidator { Validate(value: any): ValidationResult; } - export class RequiredFileValidator implements IValidator { + class RequiredFileValidator implements IValidator { Validate(value: any): ValidationResult; } - export class RequiredRichTextValidator implements IValidator { + class RequiredRichTextValidator implements IValidator { Validate(value: any): ValidationResult; } - export class MaxLengthUrlValidator implements IValidator { + class MaxLengthUrlValidator implements IValidator { Validate(value: any): ValidationResult; } - - } - export enum FormManagerEvents { + enum FormManagerEvents { Event_OnControlValueChanged, // : 1, Event_OnControlInitializedCallback, // : 2, Event_OnControlFocusSetCallback, // : 3, @@ -1473,14 +1457,14 @@ declare namespace SPClientForms { Event_GetHasValueChangedCallback // : 7 } - export class ClientForm { + class ClientForm { constructor(qualifier: string); RenderClientForm(): void; SubmitClientForm(): boolean; NotifyControlEvent(eventName: FormManagerEvents, fldName: string, eventArg: any): void; } - export class ClientFormManager { + class ClientFormManager { static GetClientForm(qualifier: string): ClientForm; static RegisterClientForm(qualifier: string): void; static SubmitClientForm(qualifier: string): boolean; @@ -1523,7 +1507,7 @@ declare function SPFieldLookupMulti_Edit(ctx: SPClientTemplates.RenderContext_Fi declare function SPFieldAttachments_Default(ctx: SPClientTemplates.RenderContext_FieldInForm): string; declare namespace SPAnimation { - export enum Attribute { + enum Attribute { PositionX, PositionY, Height, @@ -1531,7 +1515,7 @@ declare namespace SPAnimation { Opacity } - export enum ID { + enum ID { Basic_Show, Basic_SlowShow, Basic_Fade, @@ -1556,27 +1540,26 @@ declare namespace SPAnimation { Basic_QuickSize } - export class Settings { + class Settings { static DisableAnimation(): void; static DisableSessionAnimation(): void; static IsAnimationEnabled(): boolean; } - - export class State { + class State { SetAttribute(attributeId: Attribute, value: number): void; GetAttribute(attributeId: Attribute): number; GetDataIndex(attributeId: Attribute): number } - export class Object { + class Object { constructor(animationID: ID, delay: number, element: HTMLElement | HTMLElement[], finalState: State, finishFunc?: (data: any) => void, data?: any); RunAnimation(): void; } } declare namespace SPAnimationUtility { - export class BasicAnimator { + class BasicAnimator { static FadeIn(element: HTMLElement, finishFunc?: (data: any) => void, data?: any): void; static FadeOut(element: HTMLElement, finishFunc?: (data: any) => void, data?: any): void; static Move(element: HTMLElement, posX: number, posY: number, finishFunc?: (data: any) => void, data?: any): void; @@ -1611,13 +1594,13 @@ interface IEnumerable { } declare namespace SP { - export class ScriptUtility { + class ScriptUtility { static isNullOrEmptyString(str: string): boolean; static isNullOrUndefined(obj: any): boolean; static isUndefined(obj: any): boolean; static truncateToInt(n: number): number; } - export class Guid { + class Guid { constructor(guidText: string); static get_empty(): SP.Guid; static newGuid(): SP.Guid; @@ -1627,7 +1610,7 @@ declare namespace SP { ToSerialized(): string; } /** Specifies permissions that are used to define user roles. Represents SPBasePermissions class. */ - export enum PermissionKind { + enum PermissionKind { /** Has no permissions on the Web site. Not available through the user interface. */ emptyMask, /** View items in lists, documents in document libraries, and view Web discussion comments. */ @@ -1704,18 +1687,18 @@ declare namespace SP { fullMask, } - export class BaseCollection implements IEnumerable { + class BaseCollection implements IEnumerable { getEnumerator(): IEnumerator; get_count(): number; itemAtIndex(index: number): T; constructor(); } // tslint:disable-next-line: interface-name - export interface IFromJson { + interface IFromJson { fromJson(initValue: any): void; customFromJson(initValue: any): boolean; } - export class Base64EncodedByteArray { + class Base64EncodedByteArray { constructor(base64Str?: string); get_length(): number; toBase64String(): string; @@ -1723,7 +1706,7 @@ declare namespace SP { getByteAt(index: number): any; setByteAt(index: number, b: any): void; } - export class ConditionalScopeBase { + class ConditionalScopeBase { startScope(): any; startIfTrue(): any; startIfFalse(): any; @@ -1731,59 +1714,59 @@ declare namespace SP { fromJson(initValue: any): void; customFromJson(initValue: any): boolean; } - export class ClientObjectPropertyConditionalScope extends SP.ConditionalScopeBase { + class ClientObjectPropertyConditionalScope extends SP.ConditionalScopeBase { constructor(clientObject: SP.ClientObject, propertyName: string, comparisonOperator: string, valueToCompare: any, allowAllActions?: boolean); } - // export class ClientResult { + // class ClientResult { // get_value(): any; // setValue(value: any): void; // constructor(); // } - export class ClientResult { + class ClientResult { get_value(): T; setValue(value: T): void; constructor(); } - export class BooleanResult { + class BooleanResult { get_value(): boolean; constructor(); } - export class CharResult { + class CharResult { get_value(): any; constructor(); } - export class IntResult { + class IntResult { get_value(): number; constructor(); } - export class DoubleResult { + class DoubleResult { get_value(): number; constructor(); } - export class StringResult { + class StringResult { get_value(): string; constructor(); } - export class DateTimeResult { + class DateTimeResult { get_value(): Date; constructor(); } - export class GuidResult { + class GuidResult { get_value(): SP.Guid; constructor(); } - export class JsonObjectResult { + class JsonObjectResult { get_value(): any; constructor(); } - export class ClientDictionaryResultHandler { + class ClientDictionaryResultHandler { constructor(dict: SP.ClientResult); } - export class ClientUtility { + class ClientUtility { static urlPathEncodeForXmlHttpRequest(url: string): string; static getOrCreateObjectPathForConstructor(context: SP.ClientRuntimeContext, typeId: string, args: any[]): SP.ObjectPath; } - export class XElement { + class XElement { get_name(): string; set_name(value: string): void; get_attributes(): any; @@ -1792,17 +1775,17 @@ declare namespace SP { set_children(value: any): void; constructor(); } - export class ClientXElement { + class ClientXElement { get_element(): SP.XElement; set_element(value: SP.XElement): void; constructor(); } - export class ClientXDocument { + class ClientXDocument { get_root(): SP.XElement; set_root(value: SP.XElement): void; constructor(); } - export class DataConvert { + class DataConvert { static writePropertiesToXml(writer: SP.XmlWriter, obj: any, propNames: string[], serializationContext: SP.SerializationContext): void; static populateDictionaryFromObject(dict: any, parentNode: any): void; static fixupTypes(context: SP.ClientRuntimeContext, dict: any): void; @@ -1820,18 +1803,18 @@ declare namespace SP { } // tslint:disable-next-line: interface-name - export interface IWebRequestExecutorFactory { + interface IWebRequestExecutorFactory { createWebRequestExecutor(): Sys.Net.WebRequestExecutor; } - export class PageRequestFailedEventArgs extends Sys.EventArgs { + class PageRequestFailedEventArgs extends Sys.EventArgs { get_executor(): Sys.Net.WebRequestExecutor; get_errorMessage(): string; get_isErrorPage(): boolean; } - export class PageRequestSucceededEventArgs extends Sys.EventArgs { + class PageRequestSucceededEventArgs extends Sys.EventArgs { get_executor(): Sys.Net.WebRequestExecutor; } - export class PageRequest { + class PageRequest { get_request(): Sys.Net.WebRequest; get_url(): string; set_url(value: string): void; @@ -1847,11 +1830,11 @@ declare namespace SP { remove_failed(value: (sender: any, args: SP.PageRequestFailedEventArgs) => void): void; constructor(); } - export class ResResources { + class ResResources { static getString(resourceId: string, args: any[]): string; } /** Defines a writer that provides a set of methods to append text in XML format. Use the static SP.XmlWriter.create(sb) Method to create an SP.XmlWriter object with the Sys.StringBuilder object you pass in. */ - export class XmlWriter { + class XmlWriter { /** Creates a new instance of the XmlWriter class with the specified string builder. */ static create(sb: Sys.StringBuilder): SP.XmlWriter; /** Appends a start element tag with the specified name in XML format to the object?s string builder. */ @@ -1874,7 +1857,7 @@ declare namespace SP { close(): void; } - export class ClientConstants { + class ClientConstants { AddExpandoFieldTypeSuffix: string; Actions: string; ApplicationName: string; @@ -1999,14 +1982,13 @@ declare namespace SP { fluidApplicationInitParamRequestToken: string; fluidApplicationInitParamFormDigestTimeoutSeconds: string; fluidApplicationInitParamFormDigest: string; - } - export class ClientSchemaVersions { + class ClientSchemaVersions { version14: string; version15: string; currentVersion: string; } - export class ClientErrorCodes { + class ClientErrorCodes { genericError: number; accessDenied: number; docAlreadyExists: number; @@ -2019,24 +2001,24 @@ declare namespace SP { fieldValueFailedValidation: number; itemValueFailedValidation: number; } - export class ClientAction { + class ClientAction { get_id(): number; get_path(): SP.ObjectPath; get_name(): string; } - export class ClientActionSetProperty extends SP.ClientAction { + class ClientActionSetProperty extends SP.ClientAction { constructor(obj: SP.ClientObject, propName: string, propValue: any); } - export class ClientActionSetStaticProperty extends SP.ClientAction { + class ClientActionSetStaticProperty extends SP.ClientAction { constructor(context: SP.ClientRuntimeContext, typeId: string, propName: string, propValue: any); } - export class ClientActionInvokeMethod extends SP.ClientAction { + class ClientActionInvokeMethod extends SP.ClientAction { constructor(obj: SP.ClientObject, methodName: string, parameters: any[]); } - export class ClientActionInvokeStaticMethod extends SP.ClientAction { + class ClientActionInvokeStaticMethod extends SP.ClientAction { constructor(context: SP.ClientRuntimeContext, typeId: string, methodName: string, parameters: any[]); } - export class ClientObject { + class ClientObject { constructor(context: SP.ClientRuntimeContext, objectPath: SP.ObjectPath); get_context(): SP.ClientRuntimeContext; get_path(): SP.ObjectPath; @@ -2053,14 +2035,14 @@ declare namespace SP { initPropertiesFromJson(initValue: any): void; checkUninitializedProperty(propName: string): void; } - export class ClientObjectData { + class ClientObjectData { get_properties(): any; get_clientObjectProperties(): any; get_methodReturnObjects(): any; constructor(); } /** Provides a base class for a collection of objects on a remote client. */ - export class ClientObjectCollection extends SP.ClientObject implements IEnumerable { + class ClientObjectCollection extends SP.ClientObject implements IEnumerable { get_areItemsAvailable(): boolean; /** Gets the data for all of the items in the collection. */ retrieveItems(): SP.ClientObjectPrototype; @@ -2074,30 +2056,30 @@ declare namespace SP { fromJson(obj: any): void; } - export class ClientObjectList extends SP.ClientObjectCollection { + class ClientObjectList extends SP.ClientObjectCollection { constructor(context: SP.ClientRuntimeContext, objectPath: SP.ObjectPath, childItemType: any); fromJson(initValue: any): void; customFromJson(initValue: any): boolean; } - export class ClientObjectPrototype { + class ClientObjectPrototype { retrieve(propertyNames?: string[]): void; retrieveObject(propertyName: string): SP.ClientObjectPrototype; retrieveCollectionObject(propertyName: string): SP.ClientObjectCollectionPrototype; } - export class ClientObjectCollectionPrototype extends SP.ClientObjectPrototype { + class ClientObjectCollectionPrototype extends SP.ClientObjectPrototype { retrieveItems(): SP.ClientObjectPrototype; } - export enum ClientRequestStatus { + enum ClientRequestStatus { active, inProgress, completedSuccess, completedException, } - export class WebRequestEventArgs extends Sys.EventArgs { + class WebRequestEventArgs extends Sys.EventArgs { constructor(webRequest: Sys.Net.WebRequest); get_webRequest(): Sys.Net.WebRequest; } - export class ClientRequest { + class ClientRequest { static get_nextSequenceId(): number; get_webRequest(): Sys.Net.WebRequest; add_requestSucceeded(value: (sender: any, args: SP.ClientRequestSucceededEventArgs) => void): void; @@ -2107,10 +2089,10 @@ declare namespace SP { get_navigateWhenServerRedirect(): boolean; set_navigateWhenServerRedirect(value: boolean): void; } - export class ClientRequestEventArgs extends Sys.EventArgs { + class ClientRequestEventArgs extends Sys.EventArgs { get_request(): SP.ClientRequest; } - export class ClientRequestFailedEventArgs extends SP.ClientRequestEventArgs { + class ClientRequestFailedEventArgs extends SP.ClientRequestEventArgs { constructor(request: SP.ClientRequest, message: string, stackTrace: string, errorCode: number, errorValue: string, errorTypeName: string, errorDetails: any, errorTraceCorrelationId?: string); get_message(): string; get_stackTrace(): string; @@ -2120,9 +2102,9 @@ declare namespace SP { get_errorDetails(): any; get_errorTraceCorrelationId(): string; } - export class ClientRequestSucceededEventArgs extends SP.ClientRequestEventArgs { + class ClientRequestSucceededEventArgs extends SP.ClientRequestEventArgs { } - export class ClientRuntimeContext implements Sys.IDisposable { + class ClientRuntimeContext implements Sys.IDisposable { constructor(serverRelativeUrlOrFullUrl: string); get_url(): string; get_viaUrl(): string; @@ -2161,23 +2143,23 @@ declare namespace SP { set_traceCorrelationId(value: string): void; dispose(): void; } - export class SimpleDataTable { + class SimpleDataTable { get_rows(): any[]; constructor(); } - export class ClientValueObject { + class ClientValueObject { fromJson(obj: any): void; customFromJson(obj: any): boolean; writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; customWriteToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): boolean; get_typeId(): string; } - export class ClientValueObjectCollection extends SP.ClientValueObject implements IEnumerable { + class ClientValueObjectCollection extends SP.ClientValueObject implements IEnumerable { get_count(): number; getEnumerator(): IEnumerator; writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; } - export class ExceptionHandlingScope { + class ExceptionHandlingScope { constructor(context: SP.ClientRuntimeContext); startScope(): any; startTry(): any; @@ -2192,32 +2174,32 @@ declare namespace SP { get_serverErrorTypeName(): string; get_serverErrorDetails(): any; } - export class ObjectIdentityQuery extends SP.ClientAction { + class ObjectIdentityQuery extends SP.ClientAction { constructor(objectPath: SP.ObjectPath); } - export class ObjectPath { + class ObjectPath { setPendingReplace(): void; } - export class ObjectPathProperty extends SP.ObjectPath { + class ObjectPathProperty extends SP.ObjectPath { constructor(context: SP.ClientRuntimeContext, parent: SP.ObjectPath, propertyName: string); } - export class ObjectPathStaticProperty extends SP.ObjectPath { + class ObjectPathStaticProperty extends SP.ObjectPath { constructor(context: SP.ClientRuntimeContext, typeId: string, propertyName: string); } - export class ObjectPathMethod extends SP.ObjectPath { + class ObjectPathMethod extends SP.ObjectPath { constructor(context: SP.ClientRuntimeContext, parent: SP.ObjectPath, methodName: string, parameters: any[]); } - export class ObjectPathStaticMethod extends SP.ObjectPath { + class ObjectPathStaticMethod extends SP.ObjectPath { constructor(context: SP.ClientRuntimeContext, typeId: string, methodName: string, parameters: any[]); } - export class ObjectPathConstructor extends SP.ObjectPath { + class ObjectPathConstructor extends SP.ObjectPath { constructor(context: SP.ClientRuntimeContext, typeId: string, parameters: any[]); } - export class SerializationContext { + class SerializationContext { addClientObject(obj: SP.ClientObject): void; addObjectPath(path: SP.ObjectPath): void; } - export class ResourceStrings { + class ResourceStrings { argumentExceptionMessage: string; argumentNullExceptionMessage: string; cC_AppIconAlt: string; @@ -2279,7 +2261,7 @@ declare namespace SP { unknownError: string; unknownResponseData: string; } - export class RuntimeRes { + class RuntimeRes { cC_PlaceHolderElementNotFound: string; rE_CannotAccessSiteOpenWindowFailed: string; noObjectPathAssociatedWithObject: string; @@ -2341,16 +2323,16 @@ declare namespace SP { requestHasBeenExecuted: string; objectNameMethod: string; } - export class ParseJSONUtil { + class ParseJSONUtil { static parseObjectFromJsonString(json: string): any; static validateJson(text: string): boolean; } - export enum DateTimeKind { + enum DateTimeKind { unspecified, utc, local, } - export class OfficeVersion { + class OfficeVersion { majorBuildVersion: number; previousMajorBuildVersion: number; majorVersion: string; @@ -2360,18 +2342,18 @@ declare namespace SP { assemblyVersion: string; wssMajorVersion: string; } - export class ClientContext extends SP.ClientRuntimeContext { + class ClientContext extends SP.ClientRuntimeContext { constructor(serverRelativeUrlOrFullUrl?: string); static get_current(): SP.ClientContext; get_web(): SP.Web; get_site(): SP.Site; get_serverVersion(): string; } - export enum ULSTraceLevel { + enum ULSTraceLevel { verbose, } /** Provides a Unified Logging Service (ULS) that monitors log messages. */ - export class ULS { + class ULS { /** Gets a value that indicates whether the Unified Logging Service (ULS) is enabled. */ static get_enabled(): boolean; /** Sets a value that indicates whether the Unified Logging Service (ULS) is enabled. */ @@ -2388,11 +2370,11 @@ declare namespace SP { /** Traces when the function has finished. */ static traceApiLeave(): void; } - export class AccessRequests { + class AccessRequests { static changeRequestStatus(context: SP.ClientRuntimeContext, itemId: number, newStatus: number, convStr: string, permType: string, permissionLevel: number): void; static changeRequestStatusBulk(context: SP.ClientRuntimeContext, requestIds: number[], newStatus: number): void; } - export enum AddFieldOptions { + enum AddFieldOptions { defaultValue, addToDefaultContentType, addToNoContentType, @@ -2401,27 +2383,27 @@ declare namespace SP { addFieldToDefaultView, addFieldCheckDisplayName, } - export class AlternateUrl extends SP.ClientObject { + class AlternateUrl extends SP.ClientObject { get_uri(): string; get_urlZone(): SP.UrlZone; } - export class App extends SP.ClientObject { + class App extends SP.ClientObject { get_assetId(): string; get_contentMarket(): string; get_versionString(): string; } - export class AppCatalog { + class AppCatalog { static getAppInstances(context: SP.ClientRuntimeContext, web: SP.Web): SP.ClientObjectList; static getDeveloperSiteAppInstancesByIds(context: SP.ClientRuntimeContext, site: SP.Site, appInstanceIds: SP.Guid[]): SP.ClientObjectList; static isAppSideloadingEnabled(context: SP.ClientRuntimeContext): SP.BooleanResult; } - export class AppContextSite extends SP.ClientObject { + class AppContextSite extends SP.ClientObject { constructor(context: SP.ClientRuntimeContext, siteUrl: string); get_site(): SP.Site; get_web(): SP.Web; static newObject(context: SP.ClientRuntimeContext, siteUrl: string): SP.AppContextSite; } - export class AppInstance extends SP.ClientObject { + class AppInstance extends SP.ClientObject { get_appPrincipalId(): string; get_appWebFullUrl(): string; get_id(): SP.Guid; @@ -2441,7 +2423,7 @@ declare namespace SP { getPreviousAppVersion(): SP.App; retryAllJobs(): void; } - export class AppInstanceErrorDetails extends SP.ClientObject { + class AppInstanceErrorDetails extends SP.ClientObject { get_correlationId(): SP.Guid; set_correlationId(value: SP.Guid): void; get_errorDetail(): string; @@ -2453,7 +2435,7 @@ declare namespace SP { set_source(value: SP.AppInstanceErrorSource): void; get_sourceName(): string; } - export enum AppInstanceErrorSource { + enum AppInstanceErrorSource { common, appWeb, parentWeb, @@ -2463,12 +2445,12 @@ declare namespace SP { eventCallouts, finalization, } - export enum AppInstanceErrorType { + enum AppInstanceErrorType { transient, configuration, app, } - export enum AppInstanceStatus { + enum AppInstanceStatus { invalidStatus, installing, canceling, @@ -2480,36 +2462,36 @@ declare namespace SP { disabling, disabled, } - export class AppLicense extends SP.ClientValueObject { + class AppLicense extends SP.ClientValueObject { get_rawXMLLicenseToken(): string; get_typeId(): string; writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class AppLicenseCollection extends SP.ClientValueObjectCollection { + class AppLicenseCollection extends SP.ClientValueObjectCollection { add(item: SP.AppLicense): void; get_item(index: number): SP.AppLicense; get_typeId(): string; writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export enum AppLicenseType { + enum AppLicenseType { perpetualMultiUser, perpetualAllUsers, trialMultiUser, trialAllUsers, } - export class Attachment extends SP.ClientObject { + class Attachment extends SP.ClientObject { get_fileName(): string; get_serverRelativeUrl(): string; deleteObject(): void; } - export class AttachmentCollection extends SP.ClientObjectCollection { + class AttachmentCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.Attachment; get_item(index: number): SP.Attachment; getByFileName(fileName: string): SP.Attachment; } - export class AttachmentCreationInformation extends SP.ClientValueObject { + class AttachmentCreationInformation extends SP.ClientValueObject { get_contentStream(): SP.Base64EncodedByteArray; set_contentStream(value: SP.Base64EncodedByteArray): void; get_fileName(): string; @@ -2518,7 +2500,7 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class BasePermissions extends SP.ClientValueObject { + class BasePermissions extends SP.ClientValueObject { set(perm: SP.PermissionKind): void; clear(perm: SP.PermissionKind): void; clearAll(): void; @@ -2530,7 +2512,7 @@ declare namespace SP { constructor(); } /** Specifies the base type for a list. */ - export enum BaseType { + enum BaseType { none, genericList, documentLibrary, @@ -2539,11 +2521,11 @@ declare namespace SP { survey, issue, } - export enum BrowserFileHandling { + enum BrowserFileHandling { permissive, strict, } - export enum CalendarType { + enum CalendarType { none, gregorian, japan, @@ -2562,7 +2544,7 @@ declare namespace SP { umAlQura, } /** Specifies a Collaborative Application Markup Language (CAML) query on a list. */ - export class CamlQuery extends SP.ClientValueObject { + class CamlQuery extends SP.ClientValueObject { constructor(); /** This method creates a Collaborative Application Markup Language (CAML) string that can be used to recursively get all of the items in a list, including @@ -2591,49 +2573,49 @@ declare namespace SP { get_typeId(): string; writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; } - export class Change extends SP.ClientObject { + class Change extends SP.ClientObject { get_changeToken(): SP.ChangeToken; get_changeType(): SP.ChangeType; get_siteId(): SP.Guid; get_time(): Date; } - export class ChangeAlert extends SP.Change { + class ChangeAlert extends SP.Change { get_alertId(): SP.Guid; get_webId(): SP.Guid; } - export class ChangeCollection extends SP.ClientObjectCollection { + class ChangeCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.Change; get_item(index: number): SP.Change; } - export class ChangeContentType extends SP.Change { + class ChangeContentType extends SP.Change { get_contentTypeId(): SP.ContentTypeId; get_webId(): SP.Guid; } - export class ChangeField extends SP.Change { + class ChangeField extends SP.Change { get_fieldId(): SP.Guid; get_webId(): SP.Guid; } - export class ChangeFile extends SP.Change { + class ChangeFile extends SP.Change { get_uniqueId(): SP.Guid; get_webId(): SP.Guid; } - export class ChangeFolder extends SP.Change { + class ChangeFolder extends SP.Change { get_uniqueId(): SP.Guid; get_webId(): SP.Guid; } - export class ChangeGroup extends SP.Change { + class ChangeGroup extends SP.Change { get_groupId(): number; } - export class ChangeItem extends SP.Change { + class ChangeItem extends SP.Change { get_itemId(): number; get_listId(): SP.Guid; get_webId(): SP.Guid; } - export class ChangeList extends SP.Change { + class ChangeList extends SP.Change { get_listId(): SP.Guid; get_webId(): SP.Guid; } - export class ChangeLogItemQuery extends SP.ClientValueObject { + class ChangeLogItemQuery extends SP.ClientValueObject { get_changeToken(): string; set_changeToken(value: string): void; get_contains(): string; @@ -2652,7 +2634,7 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class ChangeQuery extends SP.ClientValueObject { + class ChangeQuery extends SP.ClientValueObject { constructor(); constructor(allChangeObjectTypes: boolean, allChangeTypes: boolean); get_add(): boolean; @@ -2718,16 +2700,16 @@ declare namespace SP { get_typeId(): string; writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; } - export class ChangeSite extends SP.Change { + class ChangeSite extends SP.Change { } - export class ChangeToken extends SP.ClientValueObject { + class ChangeToken extends SP.ClientValueObject { get_stringValue(): string; set_stringValue(value: string): void; get_typeId(): string; writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export enum ChangeType { + enum ChangeType { noChange, add, update, @@ -2750,35 +2732,35 @@ declare namespace SP { listContentTypeAdd, listContentTypeDelete, } - export class ChangeUser extends SP.Change { + class ChangeUser extends SP.Change { get_activate(): boolean; get_userId(): number; } - export class ChangeView extends SP.Change { + class ChangeView extends SP.Change { get_viewId(): SP.Guid; get_listId(): SP.Guid; get_webId(): SP.Guid; } - export class ChangeWeb extends SP.Change { + class ChangeWeb extends SP.Change { get_webId(): SP.Guid; } - export enum CheckinType { + enum CheckinType { minorCheckIn, majorCheckIn, overwriteCheckIn, } - export enum CheckOutType { + enum CheckOutType { online, offline, none, } - export enum ChoiceFormatType { + enum ChoiceFormatType { dropdown, radioButtons, } - export class CompatibilityRange extends SP.ClientObject { + class CompatibilityRange extends SP.ClientObject { } - export class ContentType extends SP.ClientObject { + class ContentType extends SP.ClientObject { get_description(): string; set_description(value: string): void; get_displayFormTemplateName(): string; @@ -2821,14 +2803,14 @@ declare namespace SP { update(updateChildren: boolean): void; deleteObject(): void; } - export class ContentTypeCollection extends SP.ClientObjectCollection { + class ContentTypeCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.ContentType; get_item(index: number): SP.ContentType; getById(contentTypeId: string): SP.ContentType; addExistingContentType(contentType: SP.ContentType): SP.ContentType; add(parameters: SP.ContentTypeCreationInformation): SP.ContentType; } - export class ContentTypeCreationInformation extends SP.ClientValueObject { + class ContentTypeCreationInformation extends SP.ClientValueObject { get_description(): string; set_description(value: string): void; get_group(): string; @@ -2841,33 +2823,33 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class ContentTypeId extends SP.ClientValueObject { + class ContentTypeId extends SP.ClientValueObject { toString(): string; get_stringValue(): string; get_typeId(): string; writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export enum CustomizedPageStatus { + enum CustomizedPageStatus { none, uncustomized, customized, } - export enum DateTimeFieldFormatType { + enum DateTimeFieldFormatType { dateOnly, dateTime, } - export enum DateTimeFieldFriendlyFormatType { + enum DateTimeFieldFriendlyFormatType { unspecified, disabled, relative, } - export enum DraftVisibilityType { + enum DraftVisibilityType { reader, author, approver, } - export class EventReceiverDefinition extends SP.ClientObject { + class EventReceiverDefinition extends SP.ClientObject { get_receiverAssembly(): string; get_receiverClass(): string; get_receiverId(): SP.Guid; @@ -2879,13 +2861,13 @@ declare namespace SP { update(): void; deleteObject(): void; } - export class EventReceiverDefinitionCollection extends SP.ClientObjectCollection { + class EventReceiverDefinitionCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.EventReceiverDefinition; get_item(index: number): SP.EventReceiverDefinition; getById(eventReceiverId: SP.Guid): SP.EventReceiverDefinition; add(eventReceiverCreationInformation: SP.EventReceiverDefinitionCreationInformation): SP.EventReceiverDefinition; } - export class EventReceiverDefinitionCreationInformation extends SP.ClientValueObject { + class EventReceiverDefinitionCreationInformation extends SP.ClientValueObject { get_receiverAssembly(): string; set_receiverAssembly(value: string): void; get_receiverClass(): string; @@ -2904,12 +2886,12 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export enum EventReceiverSynchronization { + enum EventReceiverSynchronization { defaultSynchronization, synchronous, asynchronous, } - export enum EventReceiverType { + enum EventReceiverType { invalidReceiver, itemAdding, itemUpdating, @@ -2987,23 +2969,23 @@ declare namespace SP { emailReceived, contextEvent, } - export class Feature extends SP.ClientObject { + class Feature extends SP.ClientObject { get_definitionId(): SP.Guid; } - export class FeatureCollection extends SP.ClientObjectCollection { + class FeatureCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.Feature; get_item(index: number): SP.Feature; getById(featureId: SP.Guid): SP.Feature; add(featureId: SP.Guid, force: boolean, featdefScope: SP.FeatureDefinitionScope): SP.Feature; remove(featureId: SP.Guid, force: boolean): void; } - export enum FeatureDefinitionScope { + enum FeatureDefinitionScope { none, farm, site, web, } - export class Field extends SP.ClientObject { + class Field extends SP.ClientObject { get_canBeDeleted(): boolean; get_defaultValue(): string; set_defaultValue(value: string): void; @@ -3058,7 +3040,7 @@ declare namespace SP { setShowInEditForm(value: boolean): void; setShowInNewForm(value: boolean): void; } - export class FieldCalculated extends SP.Field { + class FieldCalculated extends SP.Field { get_dateFormat(): SP.DateTimeFieldFormatType; set_dateFormat(value: SP.DateTimeFieldFormatType): void; get_formula(): string; @@ -3066,24 +3048,24 @@ declare namespace SP { get_outputType(): SP.FieldType; set_outputType(value: SP.FieldType): void; } - export class FieldCalculatedErrorValue extends SP.ClientValueObject { + class FieldCalculatedErrorValue extends SP.ClientValueObject { get_errorMessage(): string; get_typeId(): string; writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class FieldMultiChoice extends SP.Field { + class FieldMultiChoice extends SP.Field { get_fillInChoice(): boolean; set_fillInChoice(value: boolean): void; get_mappings(): string; get_choices(): string[]; set_choices(value: string[]): void; } - export class FieldChoice extends SP.FieldMultiChoice { + class FieldChoice extends SP.FieldMultiChoice { get_editFormat(): SP.ChoiceFormatType; set_editFormat(value: SP.ChoiceFormatType): void; } - export class FieldCollection extends SP.ClientObjectCollection { + class FieldCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.Field; get_item(index: number): SP.Field; get_schemaXml(): string; @@ -3094,21 +3076,21 @@ declare namespace SP { addFieldAsXml(schemaXml: string, addToDefaultView: boolean, options: SP.AddFieldOptions): SP.Field; getByInternalNameOrTitle(strName: string): SP.Field; } - export class FieldComputed extends SP.Field { + class FieldComputed extends SP.Field { get_enableLookup(): boolean; set_enableLookup(value: boolean): void; } - export class FieldNumber extends SP.Field { + class FieldNumber extends SP.Field { get_maximumValue(): number; set_maximumValue(value: number): void; get_minimumValue(): number; set_minimumValue(value: number): void; } - export class FieldCurrency extends SP.FieldNumber { + class FieldCurrency extends SP.FieldNumber { get_currencyLocaleId(): number; set_currencyLocaleId(value: number): void; } - export class FieldDateTime extends SP.Field { + class FieldDateTime extends SP.Field { get_dateTimeCalendarType(): SP.CalendarType; set_dateTimeCalendarType(value: SP.CalendarType): void; get_displayFormat(): SP.DateTimeFieldFormatType; @@ -3116,9 +3098,9 @@ declare namespace SP { get_friendlyDisplayFormat(): SP.DateTimeFieldFriendlyFormatType; set_friendlyDisplayFormat(value: SP.DateTimeFieldFriendlyFormatType): void; } - export class FieldGeolocation extends SP.Field { + class FieldGeolocation extends SP.Field { } - export class FieldGeolocationValue extends SP.ClientValueObject { + class FieldGeolocationValue extends SP.ClientValueObject { get_altitude(): number; set_altitude(value: number): void; get_latitude(): number; @@ -3131,9 +3113,9 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class FieldGuid extends SP.Field { + class FieldGuid extends SP.Field { } - export class FieldLink extends SP.ClientObject { + class FieldLink extends SP.ClientObject { get_hidden(): boolean; set_hidden(value: boolean): void; get_id(): SP.Guid; @@ -3142,21 +3124,21 @@ declare namespace SP { set_required(value: boolean): void; deleteObject(): void; } - export class FieldLinkCollection extends SP.ClientObjectCollection { + class FieldLinkCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.FieldLink; get_item(index: number): SP.FieldLink; getById(id: SP.Guid): SP.FieldLink; add(parameters: SP.FieldLinkCreationInformation): SP.FieldLink; reorder(internalNames: string[]): void; } - export class FieldLinkCreationInformation extends SP.ClientValueObject { + class FieldLinkCreationInformation extends SP.ClientValueObject { get_field(): SP.Field; set_field(value: SP.Field): void; get_typeId(): string; writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class FieldLookup extends SP.Field { + class FieldLookup extends SP.Field { get_allowMultipleValues(): boolean; set_allowMultipleValues(value: boolean): void; get_isRelationship(): boolean; @@ -3172,7 +3154,7 @@ declare namespace SP { get_relationshipDeleteBehavior(): SP.RelationshipDeleteBehaviorType; set_relationshipDeleteBehavior(value: SP.RelationshipDeleteBehaviorType): void; } - export class FieldLookupValue extends SP.ClientValueObject { + class FieldLookupValue extends SP.ClientValueObject { get_lookupId(): number; set_lookupId(value: number): void; get_lookupValue(): string; @@ -3180,7 +3162,7 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class FieldMultiLineText extends SP.Field { + class FieldMultiLineText extends SP.Field { get_allowHyperlink(): boolean; set_allowHyperlink(value: boolean): void; get_appendOnly(): boolean; @@ -3193,7 +3175,7 @@ declare namespace SP { set_richText(value: boolean): void; get_wikiLinking(): boolean; } - export class FieldRatingScale extends SP.FieldMultiChoice { + class FieldRatingScale extends SP.FieldMultiChoice { get_gridEndNumber(): number; set_gridEndNumber(value: number): void; get_gridNAOptionText(): string; @@ -3208,7 +3190,7 @@ declare namespace SP { set_gridTextRangeLow(value: string): void; get_rangeCount(): number; } - export class FieldRatingScaleQuestionAnswer extends SP.ClientValueObject { + class FieldRatingScaleQuestionAnswer extends SP.ClientValueObject { get_answer(): number; set_answer(value: number): void; get_question(): string; @@ -3217,16 +3199,16 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class FieldStringValues extends SP.ClientObject { + class FieldStringValues extends SP.ClientObject { get_fieldValues(): any; get_item(fieldName: string): string; refreshLoad(): void; } - export class FieldText extends SP.Field { + class FieldText extends SP.Field { get_maxLength(): number; set_maxLength(value: number): void; } - export enum FieldType { + enum FieldType { invalid, integer, text, @@ -3262,11 +3244,11 @@ declare namespace SP { outcomeChoice, maxItems, } - export class FieldUrl extends SP.Field { + class FieldUrl extends SP.Field { get_displayFormat(): SP.UrlFieldFormatType; set_displayFormat(value: SP.UrlFieldFormatType): void; } - export class FieldUrlValue extends SP.ClientValueObject { + class FieldUrlValue extends SP.ClientValueObject { get_description(): string; set_description(value: string): void; get_url(): string; @@ -3275,7 +3257,7 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class FieldUser extends SP.FieldLookup { + class FieldUser extends SP.FieldLookup { get_allowDisplay(): boolean; set_allowDisplay(value: boolean): void; get_presence(): boolean; @@ -3285,18 +3267,18 @@ declare namespace SP { get_selectionMode(): SP.FieldUserSelectionMode; set_selectionMode(value: SP.FieldUserSelectionMode): void; } - export enum FieldUserSelectionMode { + enum FieldUserSelectionMode { peopleOnly, peopleAndGroups, } - export class FieldUserValue extends SP.FieldLookupValue { + class FieldUserValue extends SP.FieldLookupValue { static fromUser(userName: string): SP.FieldUserValue; get_typeId(): string; writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } /** Represents a file in a SharePoint Web site that can be a Web Part Page, an item in a document library, or a file in a folder. */ - export class File extends SP.ClientObject { + class File extends SP.ClientObject { get_author(): SP.User; /** Returns the user who has checked out the file. */ get_checkedOutByUser(): SP.User; @@ -3355,14 +3337,14 @@ declare namespace SP { recycle(): SP.GuidResult; checkOut(): void; } - export class FileCollection extends SP.ClientObjectCollection { + class FileCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.File; get_item(index: number): SP.File; getByUrl(url: string): SP.File; add(parameters: SP.FileCreationInformation): SP.File; addTemplateFile(urlOfFile: string, templateFileType: SP.TemplateFileType): SP.File; } - export class FileCreationInformation extends SP.ClientValueObject { + class FileCreationInformation extends SP.ClientValueObject { get_content(): SP.Base64EncodedByteArray; set_content(value: SP.Base64EncodedByteArray): void; get_overwrite(): boolean; @@ -3373,12 +3355,12 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export enum FileLevel { + enum FileLevel { published, draft, checkout, } - export class FileSaveBinaryInformation extends SP.ClientValueObject { + class FileSaveBinaryInformation extends SP.ClientValueObject { get_checkRequiredFields(): boolean; set_checkRequiredFields(value: boolean): void; get_content(): SP.Base64EncodedByteArray; @@ -3391,13 +3373,13 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export enum FileSystemObjectType { + enum FileSystemObjectType { invalid, file, folder, web, } - export class FileVersion extends SP.ClientObject { + class FileVersion extends SP.ClientObject { get_checkInComment(): string; get_created(): Date; get_createdBy(): SP.User; @@ -3408,7 +3390,7 @@ declare namespace SP { get_versionLabel(): string; deleteObject(): void; } - export class FileVersionCollection extends SP.ClientObjectCollection { + class FileVersionCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.FileVersion; get_item(index: number): SP.FileVersion; getById(versionid: number): SP.FileVersion; @@ -3417,7 +3399,7 @@ declare namespace SP { deleteAll(): void; restoreByLabel(versionlabel: string): void; } - export class Folder extends SP.ClientObject { + class Folder extends SP.ClientObject { get_contentTypeOrder(): SP.ContentTypeId[]; get_files(): SP.FileCollection; get_listItemAllFields(): SP.ListItem; @@ -3435,24 +3417,24 @@ declare namespace SP { deleteObject(): void; recycle(): SP.GuidResult; } - export class FolderCollection extends SP.ClientObjectCollection { + class FolderCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.Folder; get_item(index: number): SP.Folder; getByUrl(url: string): SP.Folder; add(url: string): SP.Folder; } - export class Form extends SP.ClientObject { + class Form extends SP.ClientObject { get_id(): SP.Guid; get_serverRelativeUrl(): string; get_formType(): SP.PageType; } - export class FormCollection extends SP.ClientObjectCollection

{ + class FormCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.Form; get_item(index: number): SP.Form; getByPageType(formType: SP.PageType): SP.Form; getById(id: SP.Guid): SP.Form; } - export class Principal extends SP.ClientObject { + class Principal extends SP.ClientObject { get_id(): number; get_isHiddenInUI(): boolean; get_loginName(): string; @@ -3460,7 +3442,7 @@ declare namespace SP { set_title(value: string): void; get_principalType(): SP.Utilities.PrincipalType; } - export class Group extends SP.Principal { + class Group extends SP.Principal { get_allowMembersEditMembership(): boolean; set_allowMembersEditMembership(value: boolean): void; get_allowRequestToJoinLeave(): boolean; @@ -3482,7 +3464,7 @@ declare namespace SP { get_users(): SP.UserCollection; update(): void; } - export class GroupCollection extends SP.ClientObjectCollection { + class GroupCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.Group; get_item(index: number): SP.Group; getByName(name: string): SP.Group; @@ -3492,7 +3474,7 @@ declare namespace SP { removeById(id: number): void; remove(group: SP.Group): void; } - export class GroupCreationInformation extends SP.ClientValueObject { + class GroupCreationInformation extends SP.ClientValueObject { get_description(): string; set_description(value: string): void; get_title(): string; @@ -3501,7 +3483,7 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class InformationRightsManagementSettings extends SP.ClientObject { + class InformationRightsManagementSettings extends SP.ClientObject { get_allowPrint(): boolean; set_allowPrint(value: boolean): void; get_allowScript(): boolean; @@ -3533,7 +3515,7 @@ declare namespace SP { reset(): void; update(): void; } - export class Language extends SP.ClientValueObject { + class Language extends SP.ClientValueObject { get_displayName(): string; get_languageTag(): string; get_lcid(): number; @@ -3541,7 +3523,7 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class SecurableObject extends SP.ClientObject { + class SecurableObject extends SP.ClientObject { get_firstUniqueAncestorSecurableObject(): SP.SecurableObject; get_hasUniqueRoleAssignments(): boolean; get_roleAssignments(): SP.RoleAssignmentCollection; @@ -3549,14 +3531,14 @@ declare namespace SP { breakRoleInheritance(copyRoleAssignments: boolean, clearSubscopes: boolean): void; } /** Represents display mode for a control or form */ - export enum ControlMode { + enum ControlMode { invalid, displayMode, editMode, newMode } /** Represents a list on a SharePoint Web site. */ - export class List extends SP.SecurableObject { + class List extends SP.SecurableObject { /** Gets item by id. */ getItemById(id: number): SP.ListItem; /** Gets a value that specifies whether the list supports content types. */ @@ -3773,7 +3755,7 @@ declare namespace SP { addItem(parameters: SP.ListItemCreationInformation): SP.ListItem; } /** Represents a collection of SP.List objects */ - export class ListCollection extends SP.ClientObjectCollection { + class ListCollection extends SP.ClientObjectCollection { /** Gets the list at the specified index in the collection. */ itemAt(index: number): SP.List; /** Gets the list at the specified index in the collection. */ @@ -3789,7 +3771,7 @@ declare namespace SP { /** Gets a list that is the default asset location for images or other files, which the users upload to their wiki pages. */ ensureSiteAssetsLibrary(): SP.List; } - export class ListCreationInformation extends SP.ClientValueObject { + class ListCreationInformation extends SP.ClientValueObject { get_customSchemaXml(): string; set_customSchemaXml(value: string): void; get_dataSourceProperties(): any; @@ -3812,20 +3794,20 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class ListDataSource extends SP.ClientValueObject { + class ListDataSource extends SP.ClientValueObject { get_properties(): any; get_typeId(): string; writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class ListDataValidationExceptionValue extends SP.ClientValueObject { + class ListDataValidationExceptionValue extends SP.ClientValueObject { get_fieldFailures(): SP.ListDataValidationFailure[]; get_itemFailure(): SP.ListDataValidationFailure; get_typeId(): string; writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class ListDataValidationFailure extends SP.ClientValueObject { + class ListDataValidationFailure extends SP.ClientValueObject { get_displayName(): string; get_message(): string; get_name(): string; @@ -3835,11 +3817,11 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export enum ListDataValidationFailureReason { + enum ListDataValidationFailureReason { dataFailure, formulaError, } - export enum ListDataValidationType { + enum ListDataValidationType { userFormulaField, userFormulaItem, requiredField, @@ -3848,7 +3830,7 @@ declare namespace SP { textField, } /** Represents an item or row in a list. */ - export class ListItem extends SP.SecurableObject { + class ListItem extends SP.SecurableObject { get_fieldValues(): any; /** Gets the specified field value for the list item. Field value is returned as string, but it can be casted to a specific field value type, e.g. SP.LookupFieldValue, etc. */ get_item(fieldInternalName: string): any; @@ -3896,13 +3878,13 @@ declare namespace SP { /** Validates form values specified for the list item. Errors are returned through hasException and errorMessage properties of the ListItemFormUpdateValue objects */ validateUpdateListItem(formValues: SP.ListItemFormUpdateValue[], bNewDocumentUpdate: boolean): SP.ListItemFormUpdateValue[]; } - export class ListItemCollection extends SP.ClientObjectCollection { + class ListItemCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.ListItem; get_item(index: number): SP.ListItem; getById(id: number | string): SP.ListItem; get_listItemCollectionPosition(): SP.ListItemCollectionPosition; } - export class ListItemCollectionPosition extends SP.ClientValueObject { + class ListItemCollectionPosition extends SP.ClientValueObject { get_pagingInfo(): string; set_pagingInfo(value: string): void; get_typeId(): string; @@ -3910,7 +3892,7 @@ declare namespace SP { constructor(); } /** Specifies the properties of the new list item. */ - export class ListItemCreationInformation extends SP.ClientValueObject { + class ListItemCreationInformation extends SP.ClientValueObject { get_folderUrl(): string; /** Sets a value that specifies the folder for the new list item. */ set_folderUrl(value: string): void; @@ -3924,11 +3906,11 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class ListItemEntityCollection extends SP.ClientObjectCollection { + class ListItemEntityCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.ListItem; get_item(index: number): SP.ListItem; } - export class ListItemFormUpdateValue extends SP.ClientValueObject { + class ListItemFormUpdateValue extends SP.ClientValueObject { get_errorMessage(): string; set_errorMessage(value: string): void; get_fieldName(): string; @@ -3941,7 +3923,7 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class ListTemplate extends SP.ClientObject { + class ListTemplate extends SP.ClientObject { get_allowsFolderCreation(): boolean; get_baseType(): SP.BaseType; get_description(): string; @@ -3955,12 +3937,12 @@ declare namespace SP { get_listTemplateTypeKind(): number; get_unique(): boolean; } - export class ListTemplateCollection extends SP.ClientObjectCollection { + class ListTemplateCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.ListTemplate; get_item(index: number): SP.ListTemplate; getByName(name: string): SP.ListTemplate; } - export enum ListTemplateType { + enum ListTemplateType { invalidType, noListTemplate, genericList, @@ -4022,20 +4004,20 @@ declare namespace SP { healthReports, developerSiteDraftApps, } - export enum MoveOperations { + enum MoveOperations { none, overwrite, allowBrokenThickets, bypassApprovePermission, } - export class Navigation extends SP.ClientObject { + class Navigation extends SP.ClientObject { get_quickLaunch(): SP.NavigationNodeCollection; get_topNavigationBar(): SP.NavigationNodeCollection; get_useShared(): boolean; set_useShared(value: boolean): void; getNodeById(id: number): SP.NavigationNode; } - export class NavigationNode extends SP.ClientObject { + class NavigationNode extends SP.ClientObject { get_children(): SP.NavigationNodeCollection; get_id(): number; get_isDocLib(): boolean; @@ -4049,12 +4031,12 @@ declare namespace SP { update(): void; deleteObject(): void; } - export class NavigationNodeCollection extends SP.ClientObjectCollection { + class NavigationNodeCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.NavigationNode; get_item(index: number): SP.NavigationNode; add(parameters: SP.NavigationNodeCreationInformation): SP.NavigationNode; } - export class NavigationNodeCreationInformation extends SP.ClientValueObject { + class NavigationNodeCreationInformation extends SP.ClientValueObject { get_asLastNode(): boolean; set_asLastNode(value: boolean): void; get_isExternal(): boolean; @@ -4069,7 +4051,7 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class ObjectSharingInformation extends SP.ClientObject { + class ObjectSharingInformation extends SP.ClientObject { get_anonymousEditLink(): string; get_anonymousViewLink(): string; get_canManagePermissions(): boolean; @@ -4085,7 +4067,7 @@ declare namespace SP { static getWebSharingInformation(context: SP.ClientRuntimeContext, excludeCurrentUser: boolean, excludeSiteAdmin: boolean, excludeSecurityGroups: boolean, retrieveAnonymousLinks: boolean, retrieveUserInfoDetails: boolean, checkForAccessRequests: boolean): SP.ObjectSharingInformation; static getObjectSharingInformation(context: SP.ClientRuntimeContext, securableObject: SP.SecurableObject, excludeCurrentUser: boolean, excludeSiteAdmin: boolean, excludeSecurityGroups: boolean, retrieveAnonymousLinks: boolean, retrieveUserInfoDetails: boolean, checkForAccessRequests: boolean, retrievePermissionLevels: boolean): SP.ObjectSharingInformation; } - export class ObjectSharingInformationUser extends SP.ClientObject { + class ObjectSharingInformationUser extends SP.ClientObject { get_customRoleNames(): string; get_department(): string; get_email(): string; @@ -4101,11 +4083,11 @@ declare namespace SP { get_sipAddress(): string; get_user(): SP.User; } - export enum OpenWebOptions { + enum OpenWebOptions { none, initNavigationCache, } - export enum PageType { + enum PageType { invalid, defaultView, normalView, @@ -4120,13 +4102,13 @@ declare namespace SP { solutionForm, pAGE_MAXITEMS, } - export class PropertyValues extends SP.ClientObject { + class PropertyValues extends SP.ClientObject { get_fieldValues(): any; get_item(fieldName: string): any; set_item(fieldName: string, value: any): void; refreshLoad(): void; } - export class PushNotificationSubscriber extends SP.ClientObject { + class PushNotificationSubscriber extends SP.ClientObject { get_customArgs(): string; set_customArgs(value: string): void; get_deviceAppInstanceId(): SP.Guid; @@ -4139,17 +4121,17 @@ declare namespace SP { get_user(): SP.User; update(): void; } - export class PushNotificationSubscriberCollection extends SP.ClientObjectCollection { + class PushNotificationSubscriberCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.PushNotificationSubscriber; get_item(index: number): SP.PushNotificationSubscriber; getByStoreId(id: string): SP.PushNotificationSubscriber; } - export enum QuickLaunchOptions { + enum QuickLaunchOptions { off, on, defaultValue, } - export class RecycleBinItem extends SP.ClientObject { + class RecycleBinItem extends SP.ClientObject { get_author(): SP.User; get_deletedBy(): SP.User; get_deletedDate(): Date; @@ -4163,19 +4145,19 @@ declare namespace SP { deleteObject(): void; restore(): void; } - export class RecycleBinItemCollection extends SP.ClientObjectCollection { + class RecycleBinItemCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.RecycleBinItem; get_item(index: number): SP.RecycleBinItem; getById(id: SP.Guid): SP.RecycleBinItem; deleteAll(): void; restoreAll(): void; } - export enum RecycleBinItemState { + enum RecycleBinItemState { none, firstStageRecycleBin, secondStageRecycleBin, } - export enum RecycleBinItemType { + enum RecycleBinItemType { none, file, fileVersion, @@ -4188,7 +4170,7 @@ declare namespace SP { cascadeParent, web, } - export class RegionalSettings extends SP.ClientObject { + class RegionalSettings extends SP.ClientObject { get_adjustHijriDays(): number; get_alternateCalendarType(): number; get_aM(): string; @@ -4221,18 +4203,18 @@ declare namespace SP { get_workDays(): number; get_workDayStartHour(): number; } - export class RelatedField extends SP.ClientObject { + class RelatedField extends SP.ClientObject { get_fieldId(): SP.Guid; get_listId(): SP.Guid; get_lookupList(): SP.List; get_relationshipDeleteBehavior(): SP.RelationshipDeleteBehaviorType; get_webId(): SP.Guid; } - export class RelatedFieldCollection extends SP.ClientObjectCollection { + class RelatedFieldCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.RelatedField; get_item(index: number): SP.RelatedField; } - export class RelatedFieldExtendedData extends SP.ClientObject { + class RelatedFieldExtendedData extends SP.ClientObject { get_fieldId(): SP.Guid; get_listId(): SP.Guid; get_listImageUrl(): string; @@ -4240,11 +4222,11 @@ declare namespace SP { get_toolTipDescription(): string; get_webId(): SP.Guid; } - export class RelatedFieldExtendedDataCollection extends SP.ClientObjectCollection { + class RelatedFieldExtendedDataCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.RelatedFieldExtendedData; get_item(index: number): SP.RelatedFieldExtendedData; } - export class RelatedItem extends SP.ClientValueObject { + class RelatedItem extends SP.ClientValueObject { get_iconUrl(): string; set_iconUrl(value: string): void; get_itemId(): number; @@ -4261,7 +4243,7 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class RelatedItemManager extends SP.ClientObject { + class RelatedItemManager extends SP.ClientObject { static getRelatedItems(context: SP.ClientRuntimeContext, SourceListName: string, SourceItemID: number): SP.RelatedItem[]; static getPageOneRelatedItems(context: SP.ClientRuntimeContext, SourceListName: string, SourceItemID: number): SP.RelatedItem[]; static addSingleLink(context: SP.ClientRuntimeContext, SourceListName: string, SourceItemID: number, SourceWebUrl: string, TargetListName: string, TargetItemID: number, TargetWebUrl: string, TryAddReverseLink: boolean): void; @@ -4269,19 +4251,19 @@ declare namespace SP { static addSingleLinkFromUrl(context: SP.ClientRuntimeContext, SourceItemUrl: string, TargetListName: string, TargetItemID: number, TryAddReverseLink: boolean): void; static deleteSingleLink(context: SP.ClientRuntimeContext, SourceListName: string, SourceItemID: number, SourceWebUrl: string, TargetListName: string, TargetItemID: number, TargetWebUrl: string, TryDeleteReverseLink: boolean): void; } - export enum RelationshipDeleteBehaviorType { + enum RelationshipDeleteBehaviorType { none, cascade, restrict, } - export class RequestVariable extends SP.ClientObject { + class RequestVariable extends SP.ClientObject { constructor(context: SP.ClientRuntimeContext); get_value(): string; static newObject(context: SP.ClientRuntimeContext): SP.RequestVariable; append(value: string): void; set(value: string): void; } - export class RoleAssignment extends SP.ClientObject { + class RoleAssignment extends SP.ClientObject { get_member(): SP.Principal; get_principalId(): number; get_roleDefinitionBindings(): SP.RoleDefinitionBindingCollection; @@ -4289,7 +4271,7 @@ declare namespace SP { update(): void; deleteObject(): void; } - export class RoleAssignmentCollection extends SP.ClientObjectCollection { + class RoleAssignmentCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.RoleAssignment; get_item(index: number): SP.RoleAssignment; get_groups(): SP.GroupCollection; @@ -4297,7 +4279,7 @@ declare namespace SP { getByPrincipalId(principalId: number): SP.RoleAssignment; add(principal: SP.Principal, roleBindings: SP.RoleDefinitionBindingCollection): SP.RoleAssignment; } - export class RoleDefinition extends SP.ClientObject { + class RoleDefinition extends SP.ClientObject { get_basePermissions(): SP.BasePermissions; set_basePermissions(value: SP.BasePermissions): void; get_description(): string; @@ -4312,7 +4294,7 @@ declare namespace SP { update(): void; deleteObject(): void; } - export class RoleDefinitionBindingCollection extends SP.ClientObjectCollection { + class RoleDefinitionBindingCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.RoleDefinition; get_item(index: number): SP.RoleDefinition; constructor(context: SP.ClientRuntimeContext); @@ -4321,7 +4303,7 @@ declare namespace SP { remove(roleDefinition: SP.RoleDefinition): void; removeAll(): void; } - export class RoleDefinitionCollection extends SP.ClientObjectCollection { + class RoleDefinitionCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.RoleDefinition; get_item(index: number): SP.RoleDefinition; getByName(name: string): SP.RoleDefinition; @@ -4329,7 +4311,7 @@ declare namespace SP { getById(id: number): SP.RoleDefinition; getByType(roleType: SP.RoleType): SP.RoleDefinition; } - export class RoleDefinitionCreationInformation extends SP.ClientValueObject { + class RoleDefinitionCreationInformation extends SP.ClientValueObject { get_basePermissions(): SP.BasePermissions; set_basePermissions(value: SP.BasePermissions): void; get_description(): string; @@ -4342,7 +4324,7 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export enum RoleType { + enum RoleType { none, guest, reader, @@ -4351,11 +4333,11 @@ declare namespace SP { administrator, editor, } - export class ServerSettings { + class ServerSettings { static getAlternateUrls(context: SP.ClientRuntimeContext): SP.ClientObjectList; static getGlobalInstalledLanguages(context: SP.ClientRuntimeContext, compatibilityLevel: number): SP.Language[]; } - export class Site extends SP.ClientObject { + class Site extends SP.ClientObject { get_allowDesigner(): boolean; set_allowDesigner(value: boolean): void; get_allowMasterPageEditing(): boolean; @@ -4405,9 +4387,9 @@ declare namespace SP { extendUpgradeReminderDate(): void; invalidate(): void; } - export class SiteUrl extends SP.ClientObject { + class SiteUrl extends SP.ClientObject { } - export class SubwebQuery extends SP.ClientValueObject { + class SubwebQuery extends SP.ClientValueObject { get_configurationFilter(): number; set_configurationFilter(value: number): void; get_webTemplateFilter(): number; @@ -4416,30 +4398,30 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export enum TemplateFileType { + enum TemplateFileType { standardPage, wikiPage, formPage, } - export class ThemeInfo extends SP.ClientObject { + class ThemeInfo extends SP.ClientObject { get_accessibleDescription(): string; get_themeBackgroundImageUri(): string; getThemeShadeByName(name: string): SP.StringResult; getThemeFontByName(name: string, lcid: number): SP.StringResult; } - export class TimeZone extends SP.ClientObject { + class TimeZone extends SP.ClientObject { get_description(): string; get_id(): number; get_information(): SP.TimeZoneInformation; localTimeToUTC(date: Date): SP.DateTimeResult; utcToLocalTime(date: Date): SP.DateTimeResult; } - export class TimeZoneCollection extends SP.ClientObjectCollection { + class TimeZoneCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.TimeZone; get_item(index: number): SP.TimeZone; getById(id: number): SP.TimeZone; } - export class TimeZoneInformation extends SP.ClientValueObject { + class TimeZoneInformation extends SP.ClientValueObject { get_bias(): number; get_daylightBias(): number; get_standardBias(): number; @@ -4447,7 +4429,7 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class UpgradeInfo extends SP.ClientValueObject { + class UpgradeInfo extends SP.ClientValueObject { get_errorFile(): string; get_errors(): number; get_lastUpdated(): Date; @@ -4462,28 +4444,28 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export enum UpgradeStatus { + enum UpgradeStatus { none, inProgress, failed, completed, } - export enum UpgradeType { + enum UpgradeType { buildUpgrade, versionUpgrade, } - export enum UrlFieldFormatType { + enum UrlFieldFormatType { hyperlink, image, } - export enum UrlZone { + enum UrlZone { defaultZone, intranet, internet, custom, extranet, } - export class UsageInfo extends SP.ClientValueObject { + class UsageInfo extends SP.ClientValueObject { get_bandwidth(): number; get_discussionStorage(): number; get_hits(): number; @@ -4494,7 +4476,7 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class User extends SP.Principal { + class User extends SP.Principal { get_email(): string; set_email(value: string): void; get_groups(): SP.GroupCollection; @@ -4503,7 +4485,7 @@ declare namespace SP { get_userId(): SP.UserIdInfo; update(): void; } - export class UserCollection extends SP.ClientObjectCollection { + class UserCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.User; get_item(index: number): SP.User; getByLoginName(loginName: string): SP.User; @@ -4515,7 +4497,7 @@ declare namespace SP { add(parameters: SP.UserCreationInformation): SP.User; addUser(user: SP.User): SP.User; } - export class UserCreationInformation extends SP.ClientValueObject { + class UserCreationInformation extends SP.ClientValueObject { get_email(): string; set_email(value: string): void; get_loginName(): string; @@ -4526,7 +4508,7 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class UserCustomAction extends SP.ClientObject { + class UserCustomAction extends SP.ClientObject { get_commandUIExtension(): string; set_commandUIExtension(value: string): void; get_description(): string; @@ -4561,34 +4543,34 @@ declare namespace SP { update(): void; deleteObject(): void; } - export class UserCustomActionCollection extends SP.ClientObjectCollection { + class UserCustomActionCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.UserCustomAction; get_item(index: number): SP.UserCustomAction; getById(id: SP.Guid): SP.UserCustomAction; clear(): void; add(): SP.UserCustomAction; } - export enum UserCustomActionRegistrationType { + enum UserCustomActionRegistrationType { none, list, contentType, progId, fileType, } - export enum UserCustomActionScope { + enum UserCustomActionScope { unknown, site, web, list, } - export class UserIdInfo extends SP.ClientValueObject { + class UserIdInfo extends SP.ClientValueObject { get_nameId(): string; get_nameIdIssuer(): string; get_typeId(): string; writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class View extends SP.ClientObject { + class View extends SP.ClientObject { get_aggregations(): string; set_aggregations(value: string): void; get_aggregationsStatus(): string; @@ -4654,14 +4636,14 @@ declare namespace SP { renderAsHtml(): SP.StringResult; update(): void; } - export class ViewCollection extends SP.ClientObjectCollection { + class ViewCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.View; get_item(index: number): SP.View; getByTitle(strTitle: string): SP.View; getById(guidId: SP.Guid): SP.View; add(parameters: SP.ViewCreationInformation): SP.View; } - export class ViewCreationInformation extends SP.ClientValueObject { + class ViewCreationInformation extends SP.ClientValueObject { get_paged(): boolean; set_paged(value: boolean): void; get_personalView(): boolean; @@ -4682,7 +4664,7 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class ViewFieldCollection extends SP.ClientObjectCollection { + class ViewFieldCollection extends SP.ClientObjectCollection { itemAt(index: number): string; get_item(index: number): string; get_schemaXml(): string; @@ -4691,13 +4673,13 @@ declare namespace SP { remove(strField: string): void; removeAll(): void; } - export enum ViewScope { + enum ViewScope { defaultValue, recursive, recursiveAll, filesOnly, } - export enum ViewType { + enum ViewType { none, html, grid, @@ -4706,7 +4688,7 @@ declare namespace SP { chart, gantt, } - export class Web extends SP.SecurableObject { + class Web extends SP.SecurableObject { get_allowDesignerForCurrentUser(): boolean; get_allowMasterPageEditingForCurrentUser(): boolean; get_allowRevertFromTemplateForCurrentUser(): boolean; @@ -4813,12 +4795,12 @@ declare namespace SP { /** Available after March 2015 CU for SharePoint 2013*/ getList(url: string): List; } - export class WebCollection extends SP.ClientObjectCollection { + class WebCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.Web; get_item(index: number): SP.Web; add(parameters: SP.WebCreationInformation): SP.Web; } - export class WebCreationInformation extends SP.ClientValueObject { + class WebCreationInformation extends SP.ClientValueObject { get_description(): string; set_description(value: string): void; get_language(): number; @@ -4835,7 +4817,7 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class WebInformation extends SP.ClientObject { + class WebInformation extends SP.ClientObject { get_configuration(): number; get_created(): Date; get_description(): string; @@ -4847,10 +4829,10 @@ declare namespace SP { get_webTemplate(): string; get_webTemplateId(): number; } - export class WebProxy { + class WebProxy { static invoke(context: SP.ClientRuntimeContext, requestInfo: SP.WebRequestInfo): SP.WebResponseInfo; } - export class WebRequestInfo extends SP.ClientValueObject { + class WebRequestInfo extends SP.ClientValueObject { get_body(): string; set_body(value: string): void; get_headers(): any; @@ -4863,7 +4845,7 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class WebResponseInfo extends SP.ClientValueObject { + class WebResponseInfo extends SP.ClientValueObject { get_body(): string; set_body(value: string): void; get_headers(): any; @@ -4874,7 +4856,7 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class WebTemplate extends SP.ClientObject { + class WebTemplate extends SP.ClientObject { get_description(): string; get_displayCategory(): string; get_id(): number; @@ -4886,34 +4868,34 @@ declare namespace SP { get_name(): string; get_title(): string; } - export class WebTemplateCollection extends SP.ClientObjectCollection { + class WebTemplateCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.WebTemplate; get_item(index: number): SP.WebTemplate; getByName(name: string): SP.WebTemplate; } - export namespace Application { - export namespace UI { - export interface DefaultFormsInformationRequestor { + namespace Application { + namespace UI { + interface DefaultFormsInformationRequestor { onDefaultFormsInformationRetrieveSuccess(defaultForms: SP.Application.UI.DefaultFormsInformation): void; onDefaultFormsInformationRetrieveFailure(): void; } - export class FormsInfo { + class FormsInfo { ContentTypeName: string; NewFormUrl: string; DisplayFormUrl: string; EditFormUrl: string; constructor(); } - export class DefaultFormsInformation { + class DefaultFormsInformation { DefaultForms: SP.Application.UI.FormsInfo; OtherForms: any; constructor(); } - export class DefaultFormsMenuBuilder { + class DefaultFormsMenuBuilder { static getDefaultFormsInformation(requestor: SP.Application.UI.DefaultFormsInformationRequestor, listId: SP.Guid): void; } - export class ViewSelectorMenuOptions { + class ViewSelectorMenuOptions { showRepairView: boolean; showMergeView: boolean; showEditView: boolean; @@ -4924,10 +4906,10 @@ declare namespace SP { viewParameters: string; constructor(); } - export interface ViewInformationRequestor { + interface ViewInformationRequestor { onViewInformationReturned(viewGroups: SP.Application.UI.ViewSelectorGroups): void; } - export class ViewSelectorGroups { + class ViewSelectorGroups { ModeratedViews: any; PublicViews: any; PersonalViews: any; @@ -4936,7 +4918,7 @@ declare namespace SP { ViewCreation: any; constructor(); } - export class ViewSelectorMenuItem { + class ViewSelectorMenuItem { Text: string; ActionScriptText: string; NavigateUrl: string; @@ -4948,33 +4930,33 @@ declare namespace SP { GroupId: number; constructor(); } - export class ViewSelectorSubMenu { + class ViewSelectorSubMenu { Text: string; ImageSourceUrl: string; SubMenuItems: any; constructor(); } - export class ViewSelectorMenuBuilder { + class ViewSelectorMenuBuilder { static get_filterMenuItemsCallback(): (menuItems: any) => any; static set_filterMenuItemsCallback(value: (menuItems: any) => any): void; static showMenu(elem: HTMLElement, options: SP.Application.UI.ViewSelectorMenuOptions): void; static getViewInformation(requestor: SP.Application.UI.ViewInformationRequestor, options: SP.Application.UI.ViewSelectorMenuOptions): void; } - export class MoreColorsPicker extends Sys.UI.Control { + class MoreColorsPicker extends Sys.UI.Control { constructor(e: HTMLElement); initialize(): void; dispose(): void; get_colorValue(): string; set_colorValue(value: string): void; } - export class MoreColorsPage extends Sys.UI.Control { + class MoreColorsPage extends Sys.UI.Control { constructor(e: HTMLElement); initialize(): void; dispose(): void; get_moreColorsPicker(): SP.Application.UI.MoreColorsPicker; set_moreColorsPicker(value: SP.Application.UI.MoreColorsPicker): void; } - export class ThemeWebPage extends Sys.UI.Control { + class ThemeWebPage extends Sys.UI.Control { add_themeDisplayUpdated(value: (sender: any, e: Sys.EventArgs) => void): void; remove_themeDisplayUpdated(value: (sender: any, e: Sys.EventArgs) => void): void; constructor(e: HTMLElement); @@ -4985,7 +4967,7 @@ declare namespace SP { get_thmxThemes(): any; set_thmxThemes(value: any): void; } - export class WikiPageNameInPlaceEditor { + class WikiPageNameInPlaceEditor { constructor(ownerDoc: any, displayElemId: string, editElemId: string, editTextBoxId: string); editingPageCallback(): void; savingPageCallback(): void; @@ -4993,15 +4975,14 @@ declare namespace SP { } } - - export namespace Analytics { - export class AnalyticsUsageEntry extends SP.ClientObject { + namespace Analytics { + class AnalyticsUsageEntry extends SP.ClientObject { static logAnalyticsEvent(context: SP.ClientRuntimeContext, eventTypeId: number, itemId: string): void; static logAnalyticsEvent2(context: SP.ClientRuntimeContext, eventTypeId: number, itemId: string, rollupScopeId: SP.Guid, siteId: SP.Guid, userId: string): void; static logAnalyticsAppEvent(context: SP.ClientRuntimeContext, appEventTypeId: SP.Guid, itemId: string): void; static logAnalyticsAppEvent2(context: SP.ClientRuntimeContext, appEventTypeId: SP.Guid, itemId: string, rollupScopeId: SP.Guid, siteId: SP.Guid, userId: string): void; } - export enum EventTypeId { + enum EventTypeId { none, first, view, @@ -5011,8 +4992,8 @@ declare namespace SP { } } - export namespace SiteHealth { - export class SiteHealthResult extends SP.ClientValueObject { + namespace SiteHealth { + class SiteHealthResult extends SP.ClientValueObject { get_messageAsText(): string; get_ruleHelpLink(): string; get_ruleId(): SP.Guid; @@ -5026,29 +5007,24 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export enum SiteHealthStatusType { + enum SiteHealthStatusType { passed, failedWarning, failedError, } - export class SiteHealthSummary extends SP.ClientObject { + class SiteHealthSummary extends SP.ClientObject { get_failedErrorCount(): number; get_failedWarningCount(): number; get_passedCount(): number; get_results(): SP.SiteHealth.SiteHealthResult[]; } } - } - - - declare namespace Microsoft.SharePoint.Client.Search { namespace Query { - /**Contains information common to all types of search queries.*/ - export class Query extends SP.ClientObject { + class Query extends SP.ClientObject { get_blockDedupeMode: () => number; set_blockDedupeMode: (value: number) => void; @@ -5155,24 +5131,19 @@ declare namespace Microsoft.SharePoint.Client.Search { get_trimDuplicates: () => boolean; set_trimDuplicates: (value: boolean) => void; - get_uiLanguage: () => number; set_uiLanguage: (value: number) => void; - - getQuerySuggestionsWithResults: (iNumberOfQuerySuggestions: number, iNumberOfResultSuggestions: number, fPreQuerySuggestions: boolean, fHitHighlighting: boolean, fCapitalizeFirstLetters: boolean, fPrefixMatchAllTerms: boolean) => QuerySuggestionResults; - - } /**Contains information about a keyword based search query.*/ - export class KeywordQuery extends Query { + class KeywordQuery extends Query { constructor(context: SP.ClientContext); get_collapseSpecification: () => string; @@ -5205,7 +5176,7 @@ declare namespace Microsoft.SharePoint.Client.Search { } /**Executes queries against a search server.*/ - export class SearchExecutor extends SP.ClientObject { + class SearchExecutor extends SP.ClientObject { constructor(context: SP.ClientContext); /**Runs a query.*/ @@ -5224,8 +5195,7 @@ declare namespace Microsoft.SharePoint.Client.Search { exportPopularQueries: (web: SP.Web, sourceId: SP.Guid) => SP.JsonObjectResult; } - - export class StringCollection extends SP.ClientObjectCollection { + class StringCollection extends SP.ClientObjectCollection { constructor(context: SP.ClientContext); itemAt: (index: number) => string; get_item: (index: number) => string; @@ -5234,11 +5204,11 @@ declare namespace Microsoft.SharePoint.Client.Search { clear: () => void; } - export class QueryPersonalizationData extends SP.ClientObject { + class QueryPersonalizationData extends SP.ClientObject { // It's really empty; } - export class QuerySuggestionResults extends SP.ClientValueObject { + class QuerySuggestionResults extends SP.ClientValueObject { get_peopleNames: () => string[]; set_peopleNames: (value: string[]) => void; @@ -5249,7 +5219,7 @@ declare namespace Microsoft.SharePoint.Client.Search { set_queries: (value: QuerySuggestionQuery[]) => void; } - export class PersonalResultSuggestion extends SP.ClientValueObject { + class PersonalResultSuggestion extends SP.ClientValueObject { get_highlightedTitle: () => string; set_highlightedTitle: (value: string) => void; @@ -5263,7 +5233,7 @@ declare namespace Microsoft.SharePoint.Client.Search { set_url: (value: string) => void; } - export class QuerySuggestionQuery extends SP.ClientValueObject { + class QuerySuggestionQuery extends SP.ClientValueObject { get_isPersonal: () => boolean; set_isPersonal: (value: boolean) => void; @@ -5271,14 +5241,14 @@ declare namespace Microsoft.SharePoint.Client.Search { set_query: (value: string) => void; } - export class KeywordQueryProperties extends SP.ClientObject { + class KeywordQueryProperties extends SP.ClientObject { get_item: (key: string) => any; set_item: (key: string, value: any) => void; setQueryPropertyValue: (name: string) => QueryPropertyValue; getQueryPropertyValue: (name: string, value: QueryPropertyValue) => void; } - export enum QueryPropertyValueType { + enum QueryPropertyValueType { none, stringType, int32TYpe, @@ -5287,7 +5257,7 @@ declare namespace Microsoft.SharePoint.Client.Search { unSupportedType } - export class QueryPropertyValue extends SP.ClientValueObject { + class QueryPropertyValue extends SP.ClientValueObject { get_boolVal: () => boolean; set_boolVal: (value: boolean) => boolean; @@ -5301,12 +5271,12 @@ declare namespace Microsoft.SharePoint.Client.Search { set_strVal: (value: string) => string; } - export class QueryUtility { + class QueryUtility { static create: (name: string, val: any) => QueryPropertyValue; static getQueryPropertyValueType: (val: QueryPropertyValue) => QueryPropertyValueType; static queryPropertyValueToObject: (val: QueryPropertyValue) => any; } - export class ReorderingRuleCollection extends SP.ClientObjectCollection { + class ReorderingRuleCollection extends SP.ClientObjectCollection { itemAt: (index: number) => ReorderingRule; get_item: (index: number) => ReorderingRule; get_childItemType: () => typeof ReorderingRule; @@ -5314,7 +5284,7 @@ declare namespace Microsoft.SharePoint.Client.Search { clear: () => void; } - export enum ReorderingRuleMatchType { + enum ReorderingRuleMatchType { resultContainsKeyword, titleContainsKeyword, titleMatchesKeyword, @@ -5326,7 +5296,7 @@ declare namespace Microsoft.SharePoint.Client.Search { manualCondition } - export class ReorderingRule extends SP.ClientValueObject { + class ReorderingRule extends SP.ClientValueObject { get_boost: () => number; set_boost: (value: number) => void; @@ -5337,7 +5307,7 @@ declare namespace Microsoft.SharePoint.Client.Search { set_matchValue: (value: string) => void; } - export class SortCollection extends SP.ClientObjectCollection { + class SortCollection extends SP.ClientObjectCollection { itemAt: (index: number) => Sort; get_item: (index: number) => Sort; get_childItemType: () => typeof Sort; @@ -5350,7 +5320,7 @@ declare namespace Microsoft.SharePoint.Client.Search { descending, fqlFormula } - export class Sort extends SP.ClientValueObject { + class Sort extends SP.ClientValueObject { get_direction: () => SortDirection; set_direction: (value: SortDirection) => void; @@ -5358,8 +5328,7 @@ declare namespace Microsoft.SharePoint.Client.Search { set_property: (value: string) => void; } - - export class ResultTableCollection extends SP.ClientValueObjectCollection { + class ResultTableCollection extends SP.ClientValueObjectCollection { get_item: (index: number) => ResultTable; get_elapsedTime: () => number; @@ -5376,10 +5345,9 @@ declare namespace Microsoft.SharePoint.Client.Search { get_triggeredRules: () => SP.Guid[]; initPropertiesFromJson: (parentNode: any) => void; - } - export class ResultTable extends SP.ClientValueObject { + class ResultTable extends SP.ClientValueObject { get_groupTemplateId: () => string; get_itemTemplateId: () => string; @@ -5407,14 +5375,14 @@ declare namespace Microsoft.SharePoint.Client.Search { initPropertiesFromJson: (parentNode: any) => void; } - export class RankingLabeling extends SP.ClientObject { + class RankingLabeling extends SP.ClientObject { constructor(context: SP.ClientContext); getJudgementsForQuery: (query: string) => SP.JsonObjectResult; addJudgment: (userQuery: string, url: string, labelId: number) => void; normalizeResultUrl: (url: string) => SP.JsonObjectResult; } - export class PopularQuery extends SP.ClientValueObject { + class PopularQuery extends SP.ClientValueObject { get_clickCount: () => number; set_clickCount: (value: number) => void; @@ -5428,7 +5396,7 @@ declare namespace Microsoft.SharePoint.Client.Search { set_queryText: (value: string) => void; } - export class QueryPropertyNames { + class QueryPropertyNames { static blockDedupeMode: string; // 'BlockDedupeMode'; static bypassResultTypes: string; // 'BypassResultTypes'; static clientType: string; // 'ClientType'; @@ -5466,12 +5434,12 @@ declare namespace Microsoft.SharePoint.Client.Search { static uiLanguage: string; // 'UILanguage'; } - export class QueryObjectPropertyNames { + class QueryObjectPropertyNames { static hitHighlightedProperties: string; // = 'HitHighlightedProperties'; static personalizationData: string; // = 'PersonalizationData'; } - export class KeywordQueryPropertyNames { + class KeywordQueryPropertyNames { static collapseSpecification: string; // 'CollapseSpecification'; static enableSorting: string; // 'EnableSorting'; static hiddenConstraints: string; // 'HiddenConstraints'; @@ -5479,7 +5447,7 @@ declare namespace Microsoft.SharePoint.Client.Search { static trimDuplicatesIncludeId: string; // 'TrimDuplicatesIncludeId'; } - export class KeywordQueryObjectPropertyNames { + class KeywordQueryObjectPropertyNames { static properties: string; // 'Properties'; static refinementFilters: string; // 'RefinementFilters'; static reorderingRules: string; // 'ReorderingRules'; @@ -5489,7 +5457,7 @@ declare namespace Microsoft.SharePoint.Client.Search { } namespace WebControls { - export class ControlMessage extends SP.ClientValueObject { + class ControlMessage extends SP.ClientValueObject { get_code: () => number; get_correlationID: () => string; @@ -5515,7 +5483,7 @@ declare namespace Microsoft.SharePoint.Client.Search { get_type: () => string; } - export enum MessageLevel { + enum MessageLevel { information, warning, error @@ -5523,7 +5491,7 @@ declare namespace Microsoft.SharePoint.Client.Search { } namespace Administration { - export class DocumentCrawlLog extends SP.ClientObject { + class DocumentCrawlLog extends SP.ClientObject { constructor(context: SP.ClientContext, site: SP.Site); getCrawledUrls: (getCountOnly: boolean, maxRows: { High: number; Low: number; }, @@ -5536,11 +5504,11 @@ declare namespace Microsoft.SharePoint.Client.Search { endDateTime: Date) => SP.JsonObjectResult; } - export class SearchObjectOwner extends SP.ClientObject { + class SearchObjectOwner extends SP.ClientObject { constructor(context: SP.ClientContext, lowestCurrentLevelToUse: SearchObjectLevel); } - export enum SearchObjectLevel { + enum SearchObjectLevel { spWeb, spSite, spSiteSubscription, @@ -5549,7 +5517,7 @@ declare namespace Microsoft.SharePoint.Client.Search { } namespace Portability { - export class SearchConfigurationPortability extends SP.ClientObject { + class SearchConfigurationPortability extends SP.ClientObject { constructor(context: SP.ClientContext); get_importWarnings: () => string; @@ -5560,14 +5528,14 @@ declare namespace Microsoft.SharePoint.Client.Search { deleteSearchConfiguration: (owningScope: Administration.SearchObjectOwner, searchConfiguration: string) => void; } - export class SearchConfigurationPortabilityPropertyNames { + class SearchConfigurationPortabilityPropertyNames { static importWarnings: string; // = 'ImportWarnings' } } /**Located in sp.search.apps.js*/ namespace Analytics { - export class AnalyticsItemData extends SP.ClientObject { + class AnalyticsItemData extends SP.ClientObject { get_lastProcessingTime: () => Date; get_totalHits: () => number; @@ -5583,7 +5551,7 @@ declare namespace Microsoft.SharePoint.Client.Search { getUniqueUsersCountForMonth: (day: Date) => number; } - export class UsageAnalytics extends SP.ClientObject { + class UsageAnalytics extends SP.ClientObject { getAnalyticsItemData: (eventType: number, listItem: SP.ListItem) => AnalyticsItemData; getAnalyticsItemDataForApplicationEventType: (appEventType: SP.Guid, listItem: SP.ListItem) => AnalyticsItemData; @@ -5592,15 +5560,12 @@ declare namespace Microsoft.SharePoint.Client.Search { deleteCustomEventUsageData: (appEventTypeId: SP.Guid) => void; } - - - } } declare namespace SP { - export namespace BusinessData { - export class AppBdcCatalog extends SP.ClientObject { + namespace BusinessData { + class AppBdcCatalog extends SP.ClientObject { getEntity(namespace: string, name: string): SP.BusinessData.Entity; getLobSystemProperty(lobSystemName: string, propertyName: string): SP.StringResult; setLobSystemProperty(lobSystemName: string, propertyName: string, propertyValue: string): void; @@ -5610,7 +5575,7 @@ declare namespace SP { setConnectionId(lobSystemName: string, lobSystemInstanceName: string, connectionId: string): void; getPermissibleConnections(): string[]; } - export class Entity extends SP.ClientObject { + class Entity extends SP.ClientObject { get_estimatedInstanceCount(): number; get_name(): string; get_namespace(): string; @@ -5635,20 +5600,20 @@ declare namespace SP { subscribe(eventType: SP.BusinessData.Runtime.EntityEventType, notificationCallback: SP.BusinessData.Runtime.NotificationCallback, onBehalfOfUser: string, subscriberName: string, lobSystemInstance: SP.BusinessData.LobSystemInstance): SP.BusinessData.Runtime.Subscription; unsubscribe(subscription: SP.BusinessData.Runtime.Subscription, onBehalfOfUser: string, unsubscriberName: string, lobSystemInstance: SP.BusinessData.LobSystemInstance): void; } - export class EntityField extends SP.ClientObject { + class EntityField extends SP.ClientObject { get_containsLocalizedDisplayName(): boolean; get_defaultDisplayName(): string; get_localizedDisplayName(): string; get_name(): string; } - export class EntityIdentifier extends SP.ClientObject { + class EntityIdentifier extends SP.ClientObject { get_identifierType(): string; get_name(): string; getDefaultDisplayName(): SP.StringResult; containsLocalizedDisplayName(): SP.BooleanResult; getLocalizedDisplayName(): SP.StringResult; } - export class EntityView extends SP.ClientObject { + class EntityView extends SP.ClientObject { get_fields(): SP.BusinessData.Collections.EntityFieldCollection; get_name(): string; get_relatedSpecificFinderName(): string; @@ -5657,7 +5622,7 @@ declare namespace SP { getTypeDescriptor(fieldDotNotation: string): SP.BusinessData.TypeDescriptor; getType(fieldDotNotation: string): SP.StringResult; } - export class Filter extends SP.ClientObject { + class Filter extends SP.ClientObject { get_defaultDisplayName(): string; get_filterField(): string; get_filterType(): string; @@ -5665,21 +5630,21 @@ declare namespace SP { get_name(): string; get_valueCount(): number; } - export class LobSystem extends SP.ClientObject { + class LobSystem extends SP.ClientObject { get_name(): string; getLobSystemInstances(): SP.BusinessData.Collections.LobSystemInstanceCollection; } - export class LobSystemInstance extends SP.ClientObject { + class LobSystemInstance extends SP.ClientObject { get_name(): string; } - export class MethodExecutionResult extends SP.ClientObject { + class MethodExecutionResult extends SP.ClientObject { get_returnParameterCollection(): SP.BusinessData.ReturnParameterCollection; } - export class ReturnParameterCollection extends SP.ClientObjectCollection { + class ReturnParameterCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.BusinessData.Runtime.EntityFieldValueDictionary; get_item(index: number): SP.BusinessData.Runtime.EntityFieldValueDictionary; } - export class TypeDescriptor extends SP.ClientObject { + class TypeDescriptor extends SP.ClientObject { get_containsReadOnly(): boolean; get_isCollection(): boolean; get_isReadOnly(): boolean; @@ -5693,50 +5658,50 @@ declare namespace SP { getChildTypeDescriptors(): SP.BusinessData.Collections.TypeDescriptorCollection; getParentTypeDescriptor(): SP.BusinessData.TypeDescriptor; } - export namespace Collections { - export class EntityFieldCollection extends SP.ClientObjectCollection { + namespace Collections { + class EntityFieldCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.BusinessData.EntityField; get_item(index: number): SP.BusinessData.EntityField; } - export class EntityIdentifierCollection extends SP.ClientObjectCollection { + class EntityIdentifierCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.BusinessData.EntityIdentifier; get_item(index: number): SP.BusinessData.EntityIdentifier; } - export class EntityInstanceCollection extends SP.ClientObjectCollection { + class EntityInstanceCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.BusinessData.Runtime.EntityInstance; get_item(index: number): SP.BusinessData.Runtime.EntityInstance; } - export class FilterCollection extends SP.ClientObjectCollection { + class FilterCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.BusinessData.Filter; get_item(index: number): SP.BusinessData.Filter; setFilterValue(inputFilterName: string, valueIndex: number, value: any): void; } - export class LobSystemInstanceCollection extends SP.ClientObjectCollection { + class LobSystemInstanceCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.BusinessData.LobSystemInstance; get_item(index: number): SP.BusinessData.LobSystemInstance; } - export class TypeDescriptorCollection extends SP.ClientObjectCollection { + class TypeDescriptorCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.BusinessData.TypeDescriptor; get_item(index: number): SP.BusinessData.TypeDescriptor; } } - export namespace Infrastructure { - export class ExternalSubscriptionStore extends SP.ClientObject { + namespace Infrastructure { + class ExternalSubscriptionStore extends SP.ClientObject { constructor(context: SP.ClientRuntimeContext, web: SP.Web); static newObject(context: SP.ClientRuntimeContext, web: SP.Web): SP.BusinessData.Infrastructure.ExternalSubscriptionStore; indexStore(): void; } } - export namespace Runtime { - export enum EntityEventType { + namespace Runtime { + enum EntityEventType { none, itemAdded, itemUpdated, itemDeleted, } - export class EntityFieldValueDictionary extends SP.ClientObject { + class EntityFieldValueDictionary extends SP.ClientObject { get_fieldValues(): any; get_item(fieldName: string): any; set_item(fieldName: string, value: any): void; @@ -5747,7 +5712,7 @@ declare namespace SP { createCollectionInstance(fieldDotNotation: string, size: number): void; getCollectionSize(fieldDotNotation: string): SP.IntResult; } - export class EntityIdentity extends SP.ClientObject { + class EntityIdentity extends SP.ClientObject { get_fieldValues(): any; get_item(fieldName: string): any; constructor(context: SP.ClientRuntimeContext, identifierValues: any[]); @@ -5755,7 +5720,7 @@ declare namespace SP { static newObject(context: SP.ClientRuntimeContext, identifierValues: any[]): SP.BusinessData.Runtime.EntityIdentity; refreshLoad(): void; } - export class EntityInstance extends SP.ClientObject { + class EntityInstance extends SP.ClientObject { get_fieldValues(): any; get_item(fieldName: string): any; set_item(fieldName: string, value: any): void; @@ -5768,7 +5733,7 @@ declare namespace SP { fromXml(xml: string): void; toXml(): SP.StringResult; } - export class NotificationCallback extends SP.ClientObject { + class NotificationCallback extends SP.ClientObject { constructor(context: SP.ClientRuntimeContext, notificationEndpoint: string); get_notificationContext(): string; set_notificationContext(value: string): void; @@ -5777,7 +5742,7 @@ declare namespace SP { set_notificationForwarderType(value: string): void; static newObject(context: SP.ClientRuntimeContext, notificationEndpoint: string): SP.BusinessData.Runtime.NotificationCallback; } - export class Subscription extends SP.ClientObject { + class Subscription extends SP.ClientObject { constructor(context: SP.ClientRuntimeContext, id: any, hash: string); get_hash(): string; get_iD(): any; @@ -5788,19 +5753,19 @@ declare namespace SP { } declare namespace SP { - export namespace Sharing { - export class DocumentSharingManager { + namespace Sharing { + class DocumentSharingManager { static getRoleDefinition(context: SP.ClientRuntimeContext, role: SP.Sharing.Role): SP.RoleDefinition; static isDocumentSharingEnabled(context: SP.ClientRuntimeContext, list: SP.List): SP.BooleanResult; static updateDocumentSharingInfo(context: SP.ClientRuntimeContext, resourceAddress: string, userRoleAssignments: SP.Sharing.UserRoleAssignment[], validateExistingPermissions: boolean, additiveMode: boolean, sendServerManagedNotification: boolean, customMessage: string, includeAnonymousLinksInNotification: boolean): SP.Sharing.UserSharingResult[]; } - export enum Role { + enum Role { none, view, edit, owner, } - export class UserRoleAssignment extends SP.ClientValueObject { + class UserRoleAssignment extends SP.ClientValueObject { get_role(): SP.Sharing.Role; set_role(value: SP.Sharing.Role): void; get_userId(): string; @@ -5809,7 +5774,7 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class UserSharingResult extends SP.ClientValueObject { + class UserSharingResult extends SP.ClientValueObject { get_allowedRoles(): SP.Sharing.Role[]; get_currentRole(): SP.Sharing.Role; get_isUserKnown(): boolean; @@ -5821,21 +5786,19 @@ declare namespace SP { constructor(); } } - } declare namespace SP { - - export namespace Social { + namespace Social { /** Identifies an actor as a user, document, site, or tag. */ - export enum SocialActorType { + enum SocialActorType { user, document, site, tag } /** Specifies one or more actor types in a query to the server. */ - export enum SocialActorTypes { + enum SocialActorTypes { none, users, documents, @@ -5846,21 +5809,21 @@ declare namespace SP { all } /** Specifies whether the action is to navigate to the attachment or to perform some action dependent on the context in which the attachment is presented to the user. */ - export enum SocialAttachmentActionKind { + enum SocialAttachmentActionKind { /** This value specifies that the action is to navigate to the attachment. */ navigate, /** This value specifies that the action is dependent on the context that the attachment is displayed to the user. */ adHocAction } - export enum SocialAttachmentKind { + enum SocialAttachmentKind { image, video, document } /** Specifies whether the item being inserted is a user, document, site, tag, or link. */ - export enum SocialDataItemType { + enum SocialDataItemType { user, document, site, @@ -5869,19 +5832,19 @@ declare namespace SP { } /** Specifies whether the overlay is a link or one or more actors. */ - export enum SocialDataOverlayType { + enum SocialDataOverlayType { link, actors } /** Specifies whether the sort order is by creation time or modification time. */ - export enum SocialFeedSortOrder { + enum SocialFeedSortOrder { byModifiedTime, byCreatedTime } /** Identifies the kind of post to be retrieved. */ - export enum SocialFeedType { + enum SocialFeedType { personal, news, timeline, @@ -5890,7 +5853,7 @@ declare namespace SP { } // For some reasons this enum doesn't exist - // export enum SocialFollowResult { + // enum SocialFollowResult { // ok = 0, // alreadyFollowing = 1, // limitReached = 2, @@ -5899,13 +5862,13 @@ declare namespace SP { /** Provides information about the feed. This type provides information about whether the feed on the server contains additional threads that were not returned. */ - export enum SocialFeedAttributes { + enum SocialFeedAttributes { none, moreThreadsAvailable } /** Specifies attributes of the post, such as whether the current user can like or delete the post. */ - export enum SocialPostAttributes { + enum SocialPostAttributes { none, canLike, canDelete, @@ -5916,7 +5879,7 @@ declare namespace SP { /** Defines the type of item being specified in the SocialPostDefinitionDataItem. This type is only available in server-to-server calls. */ - export enum SocialPostDefinitionDataItemType { + enum SocialPostDefinitionDataItemType { text, user, document, @@ -5925,13 +5888,13 @@ declare namespace SP { link } - export enum SocialPostType { + enum SocialPostType { root, reply } /** Specifies a status or error code. */ - export enum SocialStatusCode { + enum SocialStatusCode { OK, /** This value specifies that an invalid request was encountered. */ invalidRequest, @@ -5962,7 +5925,7 @@ declare namespace SP { } /** Specifies properties of the thread. */ - export enum SocialThreadAttributes { + enum SocialThreadAttributes { none, isDigest, canReply, @@ -5971,7 +5934,7 @@ declare namespace SP { replyLimitReached } - export enum SocialThreadType { + enum SocialThreadType { normal, likeReference, replyReference, @@ -5980,7 +5943,7 @@ declare namespace SP { } /** Contains information about an actor retrieved from server. An actor is a user, document, site, or tag. */ - export class SocialActor extends SP.ClientValueObject { + class SocialActor extends SP.ClientValueObject { /** The AccountName property returns the user account name. This property is only available for social actors of type "user". */ get_accountName(): string; @@ -6026,7 +5989,7 @@ declare namespace SP { } /** Identifies an actor to the server. An actor can be a user, document, site, or tag. */ - export class SocialActorInfo extends SP.ClientValueObject { + class SocialActorInfo extends SP.ClientValueObject { /** User account name. This property is only available for social actors of type "user". */ get_accountName(): string; @@ -6056,7 +6019,7 @@ declare namespace SP { } /** Represents an image, document preview, or video preview attachment. */ - export class SocialAttachment extends SP.ClientValueObject { + class SocialAttachment extends SP.ClientValueObject { /** Specifies the type of object that the attachment contains. */ get_attachmentKind(): SocialAttachmentKind; /** Specifies the type of object that the attachment contains. */ @@ -6103,7 +6066,7 @@ declare namespace SP { set_width(value: number): number; } /** Specifies the user actions that are allowed for the attachment object. */ - export class SocialAttachmentAction extends SP.ClientValueObject { + class SocialAttachmentAction extends SP.ClientValueObject { /** Specifies whether the action is to navigate to a URI or an action that is dependent on the context in which the object is presented to the user. */ get_actionKind(): SocialAttachmentActionKind; /** Specifies whether the action is to navigate to a URI or an action that is dependent on the context in which the object is presented to the user. */ @@ -6117,7 +6080,7 @@ declare namespace SP { /** Defines a user, document, site, tag, or link to be inserted in a new post. The SocialPostCreationData class defines the content text that contains substitution strings. Each substitution string is replaced by a SocialDataItem value. */ - export class SocialDataItem extends SP.ClientValueObject { + class SocialDataItem extends SP.ClientValueObject { /** Identifies the user. */ get_accountName(): string; /** Identifies the user. */ @@ -6144,7 +6107,7 @@ declare namespace SP { An overlay is a substring in a post that represents a user, document, site, tag, or link. The SocialPost class contains an array of SocialDataOverlay objects. Each of the SocialDataOverlay objects specifies a link or one or more actors. */ - export class SocialDataOverlay extends SP.ClientValueObject { + class SocialDataOverlay extends SP.ClientValueObject { /** Specifies one or more actors as an array of integers where each integer specifies an index into the SocialThreadActors array. This property is only available if the get_overlayType() has a value of SocialDataOverlayType.actors. */ get_actorIndexes(): number[]; @@ -6160,7 +6123,7 @@ declare namespace SP { } /** Specifies information about errors that the server has encountered. */ - export class SocialExceptionDetails extends SP.ClientValueObject { + class SocialExceptionDetails extends SP.ClientValueObject { get_internalErrorCode(): number; get_internalMessage(): string; get_internalStackTrace(): string; @@ -6170,7 +6133,7 @@ declare namespace SP { } /** Specifies a feed, which contains an array of SocialThreads, each of which specifies a root SocialPost object and an array of response SocialPost objects. */ - export class SocialFeed extends SP.ClientValueObject { + class SocialFeed extends SP.ClientValueObject { /** Specifies attributes of the returned feed. The attributes specify if the requested feed has additional threads that were not included in the returned thread. */ get_attributes(): SocialFeedAttributes; @@ -6190,7 +6153,7 @@ declare namespace SP { /** Provides access to social feeds. It provides methods to create posts, delete posts, read posts, and perform other operations on posts. */ - export class SocialFeedManager extends SP.ClientObject { + class SocialFeedManager extends SP.ClientObject { constructor(context: SP.ClientRuntimeContext); /** Returns the current user */ get_owner(): SocialActor; @@ -6260,7 +6223,7 @@ declare namespace SP { getPreviewImage(url: string, key: string, iv: string): any; } - export class SocialFeedOptions extends SP.ClientObject { + class SocialFeedOptions extends SP.ClientObject { get_maxThreadCount(): number; set_maxThreadCount(value: number): number; get_newerThan(): string; @@ -6273,7 +6236,7 @@ declare namespace SP { /** Provides properties and methods for managing a user's list of followed actors. Actors can be users, documents, sites, and tags. */ - export class SocialFollowingManager extends SP.ClientObject { + class SocialFollowingManager extends SP.ClientObject { constructor(context: SP.ClientRuntimeContext); /** URI to a site that lists the current user's followed documents. */ get_followedDocumentsUri(): string; @@ -6297,7 +6260,7 @@ declare namespace SP { /** Defines a link that includes a URI and text representation. This class is used to represent the location of a web site. */ - export class SocialLink extends SP.ClientValueObject { + class SocialLink extends SP.ClientValueObject { get_text(): string; set_text(value: string): string; get_uri(): string; @@ -6305,7 +6268,7 @@ declare namespace SP { } /** Specifies a post read from the server. */ - export class SocialPost extends SP.ClientValueObject { + class SocialPost extends SP.ClientValueObject { /** Specifies an image, document preview, or video preview attachment */ get_attachment(): SocialAttachment; /** Describes attributes about the post, such as whether the current user can delete or like the post. */ @@ -6333,7 +6296,7 @@ declare namespace SP { } /** Specifies a set of users, documents, sites, and tags by an index into the SocialThreadActors array */ - export class SocialPostActorInfo extends SP.ClientValueObject { + class SocialPostActorInfo extends SP.ClientValueObject { get_includesCurrentUser(): boolean; /** Specifies an array of indexes into the SocialThreadActors array. The server can choose to return a limited set of actors. For example, the server can choose to return a subset of the users that like a post. */ @@ -6343,7 +6306,7 @@ declare namespace SP { /** Specifies the content of a post in the SocialFeedManager.createPost method. The post consists of a text message, which can optionally include social tags, mentions of users, and links. */ - export class SocialPostCreationData extends SP.ClientValueObject { + class SocialPostCreationData extends SP.ClientValueObject { /** Specifies an image, document preview, or video preview to be used in the post. */ get_attachment(): SocialAttachment; /** Specifies an image, document preview, or video preview to be used in the post. */ @@ -6382,7 +6345,7 @@ declare namespace SP { /** Provides additional information about server-generated posts. This type can only be specified in a server-to-server call. */ - export class SocialPostDefinitionData extends SP.ClientValueObject { + class SocialPostDefinitionData extends SP.ClientValueObject { get_items(): SocialPostDefinitionDataItem[]; set_items(value: SocialPostDefinitionDataItem[]): SocialPostDefinitionDataItem[]; get_name(): string; @@ -6391,7 +6354,7 @@ declare namespace SP { /** Specifies an item to be inserted in a post by replacing a token in the post definition. This type can only be specified in a server-to-server call. */ - export class SocialPostDefinitionDataItem extends SP.ClientValueObject { + class SocialPostDefinitionDataItem extends SP.ClientValueObject { /** Specifies the name of the user. This property is only used if the ItemType property specifies that the item is a User. */ get_accountName(): string; @@ -6426,7 +6389,7 @@ declare namespace SP { /** Specifies a reference to a post in another thread. The referenced post can be a post with a tag, a post that is liked, a post that mentions a user, or a post that is a reply. */ - export class SocialPostReference extends SP.ClientValueObject { + class SocialPostReference extends SP.ClientValueObject { /** Provides a digest of the thread containing the referenced post */ get_digest(): SocialThread; get_post(): SocialPost; @@ -6438,7 +6401,7 @@ declare namespace SP { /** Specifies a thread that is stored on the server. The thread contains a root post and zero or more reply posts. */ - export class SocialThread extends SP.ClientValueObject { + class SocialThread extends SP.ClientValueObject { /** Specifies the users who have created a post in the returned thread and also contains any users, documents, sites, and tags that are referenced in any of the posts in the returned thread. */ get_actors(): SocialActor[]; /** Specifies attributes of the thread, such as whether the current user can reply or lock the thread and whether the thread is a digest of a thread on the server, whether the number of replies has reached the maximum, and whether the thread is locked. */ @@ -6463,18 +6426,16 @@ declare namespace SP { get_threadType(): SocialThreadType; get_totalReplyCount(): number; } - } - } declare namespace SP { namespace Taxonomy { - export enum StringMatchOption { + enum StringMatchOption { startsWith, exactMatch } - export enum ChangeItemType { + enum ChangeItemType { unknown, term, termSet, @@ -6483,7 +6444,7 @@ declare namespace SP { site } - export enum ChangeOperationType { + enum ChangeOperationType { unknown, add, edit, @@ -6496,8 +6457,7 @@ declare namespace SP { restore } - - export class TaxonomySession extends SP.ClientObject { + class TaxonomySession extends SP.ClientObject { static getTaxonomySession(context: SP.ClientContext): TaxonomySession; get_offlineTermStoreNames(): string[]; get_termStores(): TermStoreCollection; @@ -6529,14 +6489,14 @@ declare namespace SP { getDefaultSiteCollectionTermStore(): TermStore; } - export class TermStoreCollection extends SP.ClientObjectCollection { + class TermStoreCollection extends SP.ClientObjectCollection { itemAt(index: number): TermStore; get_item(index: number): TermStore; getById(id: SP.Guid): TermStore; getByName(name: string): TermStore; } - export class TermStore extends SP.ClientObject { + class TermStore extends SP.ClientObject { get_contentTypePublishingHub(): string; get_defaultLanguage(): number; set_defaultLanguage(value: number): void; @@ -6579,7 +6539,7 @@ declare namespace SP { updateUsedTermsOnSite(currentSite: SP.Site): void; } - export class TaxonomyItem extends SP.ClientObject { + class TaxonomyItem extends SP.ClientObject { static normalizeName(context: SP.ClientContext, name: string): SP.StringResult; get_createdDate(): Date; get_id(): SP.Guid; @@ -6590,14 +6550,14 @@ declare namespace SP { deleteObject(): void; } - export class TermGroupCollection extends SP.ClientObjectCollection { + class TermGroupCollection extends SP.ClientObjectCollection { itemAt(index: number): TermGroup; get_item(index: number): TermGroup; getById(id: SP.Guid): TermGroup; getByName(name: string): TermGroup; } - export class TermGroup extends TaxonomyItem { + class TermGroup extends TaxonomyItem { get_description(): string; set_description(value: string): void; get_isSiteCollectionGroup(): boolean; @@ -6609,7 +6569,7 @@ declare namespace SP { getTermSetsWithCustomProperty(customPropertyMatchInformation: CustomPropertyMatchInformation): TermSetCollection; } - export class TermSetItem extends TaxonomyItem { + class TermSetItem extends TaxonomyItem { get_customProperties(): { [key: string]: string; }; get_customSortOrder(): string; set_customSortOrder(value: string): void; @@ -6627,14 +6587,14 @@ declare namespace SP { setCustomProperty(name: string, value: string): void; } - export class TermSetCollection extends SP.ClientObjectCollection { + class TermSetCollection extends SP.ClientObjectCollection { itemAt(index: number): TermSet; get_item(index: number): TermSet; getById(id: SP.Guid): TermSet; getByName(name: string): TermSet; } - export class TermSet extends TermSetItem { + class TermSet extends TermSetItem { get_contact(): string; set_contact(value: string): void; get_description(): string; @@ -6657,14 +6617,14 @@ declare namespace SP { move(targetGroup: TermGroup): void; } - export class TermCollection extends SP.ClientObjectCollection { + class TermCollection extends SP.ClientObjectCollection { itemAt(index: number): Term; get_item(index: number): Term; getById(id: SP.Guid): Term; getByName(name: string): Term; } - export class Term extends TermSetItem { + class Term extends TermSetItem { get_description(): string; get_isDeprecated(): boolean; get_isKeyword(): boolean; @@ -6711,14 +6671,13 @@ declare namespace SP { getPath(lcid: number): SP.StringResult; } - - export class LabelCollection extends SP.ClientObjectCollection'); } - var results = list.getItems(query); + const results = list.getItems(query); ctx.load(results); - ctx.executeQueryAsync((o, e) => { - var selected = false; + let selected = false; while (_dropdownElt.options.length) { (_dropdownElt.options as any /* TODO remove `as any` */).remove(0); } if (!_schema.Required) { - var defaultOpt = new Option(Strings.STS.L_LookupFieldNoneOption, '0', selected, selected); + const defaultOpt = new Option(Strings.STS.L_LookupFieldNoneOption, '0', selected, selected); (_dropdownElt.options as any /* TODO remove `as any` */).add(defaultOpt); selected = _selectedValue === 0; } - var isEmptyList = true; + let isEmptyList = true; - var enumerator = results.getEnumerator(); + const enumerator = results.getEnumerator(); while (enumerator.moveNext()) { - var c = enumerator.get_current(); - var id: number; - var text: string; + const c = enumerator.get_current(); + let id: number; + let text: string; if (!lookupField) { id = c.get_id(); text = c.get_item('Title'); } else { - var value = c.get_item(lookupField) as SP.FieldLookupValue; + const value = c.get_item(lookupField) as SP.FieldLookupValue; id = value.get_lookupId(); text = value.get_lookupValue(); } - var isSelected = _selectedValue === id; + const isSelected = _selectedValue === id; if (isSelected) { selected = true; } - var opt = new Option(text, id.toString(), isSelected, isSelected); + const opt = new Option(text, id.toString(), isSelected, isSelected); (_dropdownElt.options as any /* TODO remove `as any` */).add(opt); isEmptyList = false; } @@ -1134,31 +1090,26 @@ namespace CSR { OnLookupValueChanged(); } } - - }, (o, args) => { console.log(args.get_message()); }); } } - } koEditField(fieldName: string, template: string, vm: KoFieldInForm, dependencyFields?: string[]): CSR { return this.fieldEdit(fieldName, koEditField_Edit) .fieldNew(fieldName, koEditField_Edit); - function koEditField_Edit(rCtx: SPClientTemplates.RenderContext_FieldInForm) { if (rCtx == null) return ''; - var _myData = SPClientTemplates.Utility.GetFormContextForCurrentField(rCtx); + const _myData = SPClientTemplates.Utility.GetFormContextForCurrentField(rCtx); if (_myData == null || _myData.fieldSchema == null) return ''; - var elementId = _myData.fieldName + '_' + _myData.fieldSchema.Id + '_$' + _myData.fieldSchema.Type; + const elementId = _myData.fieldName + '_' + _myData.fieldSchema.Id + '_$' + _myData.fieldSchema.Type; vm.renderingContext = rCtx; - if (dependencyFields) { dependencyFields.forEach(dependencyField => { if (!vm[dependencyField]) { @@ -1170,7 +1121,6 @@ namespace CSR { }); } - if (!vm.value) { vm.value = ko.observable(); } @@ -1178,7 +1128,6 @@ namespace CSR { vm.value.subscribe(v => { _myData.updateControlValue(fieldName, v); }); _myData.registerGetValueCallback(fieldName, () => vm.value()); - _myData.registerInitCallback(fieldName, () => { ko.applyBindings(vm, $get(elementId)); }); @@ -1188,18 +1137,17 @@ namespace CSR { } computedValue(targetField: string, transform: (...values: string[]) => string, ...sourceField: string[]): CSR { - var dependentValues: { [field: string]: string } = {}; + const dependentValues: { [field: string]: string } = {}; return this.onPostRenderField(targetField, (schema: SPClientTemplates.FieldSchema_InForm, ctx: SPClientTemplates.RenderContext_FieldInForm) => { if (ctx.ControlMode === SPClientTemplates.ClientControlMode.EditForm || ctx.ControlMode === SPClientTemplates.ClientControlMode.NewForm) { - var targetControl = CSR.getControl(schema as SPClientTemplates.FieldSchema_InForm); + const targetControl = CSR.getControl(schema as SPClientTemplates.FieldSchema_InForm); sourceField.forEach((field) => { CSR.addUpdatedValueCallback(ctx, field, v => { dependentValues[field] = v; targetControl.value = transform.apply(this, sourceField.map(n => dependentValues[n] || '')); - }); }); } @@ -1216,7 +1164,6 @@ namespace CSR { } } - autofill(fieldName: string, init: (ctx: AutoFillFieldContext) => () => void): CSR { return this .fieldNew(fieldName, SPFieldLookup_Autofill_Edit) @@ -1225,17 +1172,17 @@ namespace CSR { function SPFieldLookup_Autofill_Edit(rCtx: SPClientTemplates.RenderContext_FieldInForm) { if (rCtx == null) return ''; - var _myData = SPClientTemplates.Utility.GetFormContextForCurrentField(rCtx); + const _myData = SPClientTemplates.Utility.GetFormContextForCurrentField(rCtx); if (_myData == null || _myData.fieldSchema == null) return ''; - var _autoFillControl: SPClientAutoFill; - var _textInputElt: HTMLInputElement; - var _textInputId = _myData.fieldName + '_' + _myData.fieldSchema.Id + '_$' + _myData.fieldSchema.Type + 'Field'; - var _autofillContainerId = _myData.fieldName + '_' + _myData.fieldSchema.Id + '_$AutoFill'; + let _autoFillControl: SPClientAutoFill; + let _textInputElt: HTMLInputElement; + const _textInputId = _myData.fieldName + '_' + _myData.fieldSchema.Id + '_$' + _myData.fieldSchema.Type + 'Field'; + const _autofillContainerId = _myData.fieldName + '_' + _myData.fieldSchema.Id + '_$AutoFill'; - var validators = new SPClientForms.ClientValidation.ValidatorSet(); + const validators = new SPClientForms.ClientValidation.ValidatorSet(); if (_myData.fieldSchema.Required) { validators.RegisterValidator(new SPClientForms.ClientValidation.RequiredValidator()); } @@ -1259,7 +1206,7 @@ namespace CSR { SP.SOD.executeFunc("autofill.js", "SPClientAutoFill", () => { _autoFillControl = new SPClientAutoFill(_textInputId, _autofillContainerId, (_) => callback()); - var callback = init({ + const callback = init({ renderContext: rCtx, fieldContext: _myData, autofill: _autoFillControl, @@ -1270,10 +1217,8 @@ namespace CSR { // _autoFillControl.VisibleItemCount = 15; // _autoFillControl.AutoFillTimeout = 500; }); - } // function OnPopulate(targetElement: HTMLInputElement) { - // } // function OnLookupValueChanged() { @@ -1283,7 +1228,7 @@ namespace CSR { // return _valueStr; // } function buildAutoFillControl() { - var result: string[] = []; + const result: string[] = []; result.push('
'); result.push(''); @@ -1293,21 +1238,19 @@ namespace CSR { return result.join(""); } } - - } seachLookup(fieldName: string): CSR { return this.autofill(fieldName, (ctx: AutoFillFieldContext) => { - var _myData = ctx.fieldContext; - var _schema = _myData.fieldSchema as SPClientTemplates.FieldSchema_InForm_Lookup; + const _myData = ctx.fieldContext; + const _schema = _myData.fieldSchema as SPClientTemplates.FieldSchema_InForm_Lookup; if (_myData.fieldSchema.Type !== 'Lookup') { return null; } - var _valueStr = _myData.fieldValue != null ? _myData.fieldValue : ''; - var _selectedValue = SPClientTemplates.Utility.ParseLookupValue(_valueStr); - var _noValueSelected = _selectedValue.LookupId === 0; + const _valueStr = _myData.fieldValue != null ? _myData.fieldValue : ''; + const _selectedValue = SPClientTemplates.Utility.ParseLookupValue(_valueStr); + const _noValueSelected = _selectedValue.LookupId === 0; ctx.control.value = _selectedValue.LookupValue; $addHandler(ctx.control, "blur", _ => { if (ctx.control.value === '') { @@ -1319,39 +1262,39 @@ namespace CSR { if (_noValueSelected) _myData.fieldValue = ''; - var _autoFillControl = ctx.autofill; + const _autoFillControl = ctx.autofill; _autoFillControl.AutoFillMinTextLength = 2; _autoFillControl.VisibleItemCount = 15; _autoFillControl.AutoFillTimeout = 500; return () => { - var value = ctx.control.value; + const value = ctx.control.value; _autoFillControl.PopulateAutoFill([AutoFillOptionBuilder.buildLoadingItem('Please wait...')], onSelectItem); SP.SOD.executeFunc("sp.search.js", "Microsoft.SharePoint.Client.Search.Query", () => { - var Search = Microsoft.SharePoint.Client.Search.Query; - var ctx = SP.ClientContext.get_current(); - var query = new Search.KeywordQuery(ctx); + const Search = Microsoft.SharePoint.Client.Search.Query; + const ctx = SP.ClientContext.get_current(); + const query = new Search.KeywordQuery(ctx); query.set_rowLimit(_autoFillControl.VisibleItemCount); query.set_queryText('contentclass:STS_ListItem ListID:{' + _schema.LookupListId + '} ' + value); - var selectProps = query.get_selectProperties(); + const selectProps = query.get_selectProperties(); selectProps.clear(); // TODO: Handle ShowField attribute selectProps.add('Title'); selectProps.add('ListItemId'); - var executor = new Search.SearchExecutor(ctx); - var result = executor.executeQuery(query); + const executor = new Search.SearchExecutor(ctx); + const result = executor.executeQuery(query); ctx.executeQueryAsync( () => { // TODO: Discover proper way to load collection - var tableCollection = new Search.ResultTableCollection(); + const tableCollection = new Search.ResultTableCollection(); tableCollection.initPropertiesFromJson(result.get_value()); - var relevantResults = tableCollection.get_item(0); - var rows = relevantResults.get_resultRows(); + const relevantResults = tableCollection.get_item(0); + const rows = relevantResults.get_resultRows(); - var items = []; - for (var row of rows) { + const items = []; + for (const row of rows) { items.push(AutoFillOptionBuilder.buildOptionItem(parseInt(row["ListItemId"], 10), row["Title"])); } @@ -1363,7 +1306,6 @@ namespace CSR { items.push(AutoFillOptionBuilder.buildFooterItem("Showing " + rows.length + " of" + relevantResults.get_totalRows() + " items!")); _autoFillControl.PopulateAutoFill(items, onSelectItem); - }, (sender, args) => { _autoFillControl.PopulateAutoFill([AutoFillOptionBuilder.buildFooterItem("Error executing query/ See log for details.")], onSelectItem); @@ -1373,36 +1315,36 @@ namespace CSR { }; function onSelectItem(targetInputId, item: ISPClientAutoFillData) { - var targetElement = ctx.control; + const targetElement = ctx.control; targetElement.value = item[SPClientAutoFill.DisplayTextProperty]; _selectedValue.LookupId = item[SPClientAutoFill.KeyProperty]; _selectedValue.LookupValue = item[SPClientAutoFill.DisplayTextProperty]; _myData.fieldValue = item[SPClientAutoFill.KeyProperty] + ';#' + item[SPClientAutoFill.TitleTextProperty]; _myData.updateControlValue(_myData.fieldSchema.Name, _myData.fieldValue); } - }); } lookupAddNew(fieldName: string, prompt: string, showDialog?: boolean, contentTypeId?: string): CSR { return this.onPostRenderField(fieldName, (schema: SPClientTemplates.FieldSchema_InForm_Lookup, ctx: SPClientTemplates.RenderContext_FieldInForm) => { + let control: HTMLInputElement; if (ctx.ControlMode === SPClientTemplates.ClientControlMode.EditForm || ctx.ControlMode === SPClientTemplates.ClientControlMode.NewForm) - var control = CSR.getControl(schema); + control = CSR.getControl(schema); if (control) { - var weburl = _spPageContextInfo.webServerRelativeUrl; + let weburl = _spPageContextInfo.webServerRelativeUrl; if (weburl[weburl.length - 1] === '/') { weburl = weburl.substring(0, weburl.length - 1); } - var newFormUrl = weburl + '/_layouts/listform.aspx/listform.aspx?PageType=8' + let newFormUrl = weburl + '/_layouts/listform.aspx/listform.aspx?PageType=8' + "&ListId=" + encodeURIComponent('{' + schema.LookupListId + '}'); if (contentTypeId) { newFormUrl += '&ContentTypeId=' + contentTypeId; } - var link = document.createElement('a'); + const link = document.createElement('a'); link.href = "javascript:NewItem2(event, \'" + newFormUrl + "&Source=" + encodeURIComponent(document.location.href) + "')"; link.textContent = prompt; if (control.nextElementSibling) { @@ -1433,9 +1375,8 @@ namespace CSR { } export class AutoFillOptionBuilder { - static buildFooterItem(title: string): ISPClientAutoFillData { - var item = {}; + const item = {}; item[SPClientAutoFill.DisplayTextProperty] = title; item[SPClientAutoFill.MenuOptionTypeProperty] = SPClientAutoFill.MenuOptionType.Footer; @@ -1444,8 +1385,7 @@ namespace CSR { } static buildOptionItem(id: number, title: string, displayText?: string, subDisplayText?: string): ISPClientAutoFillData { - - var item = {}; + const item = {}; item[SPClientAutoFill.KeyProperty] = id; item[SPClientAutoFill.DisplayTextProperty] = displayText || title; @@ -1457,19 +1397,18 @@ namespace CSR { } static buildSeparatorItem(): ISPClientAutoFillData { - var item = {}; + const item = {}; item[SPClientAutoFill.MenuOptionTypeProperty] = SPClientAutoFill.MenuOptionType.Separator; return item; } static buildLoadingItem(title: string): ISPClientAutoFillData { - var item = {}; + const item = {}; item[SPClientAutoFill.MenuOptionTypeProperty] = SPClientAutoFill.MenuOptionType.Loading; item[SPClientAutoFill.DisplayTextProperty] = title; return item; } - } type RenderContext = (ctx: SPClientTemplates.RenderContext) => T; /** Lightweight client-side rendering template overrides.*/ @@ -1606,7 +1545,6 @@ namespace CSR { // tslint:disable-next-line: unified-signatures fieldNew(fieldName: string, template: (ctx: SPClientTemplates.RenderContext_FieldInForm) => string): CSR; - /** Set initial value for field. @param fieldName Internal name of the field. @param value Initial value for field. @@ -1618,7 +1556,6 @@ namespace CSR { */ makeHidden(fieldName: string): CSR; - /** Replace New and Edit templates for field to Display template. @param fieldName Internal name of the field. */ @@ -1656,8 +1593,6 @@ namespace CSR { lookupAddNew(fieldName: string, prompt: string, showDialog?: boolean, contentTypeId?: string): CSR; koEditField(fieldName: string, template: string, vm: KoFieldInForm, dependencyFields?: string[]): CSR; - - } export interface AutoFillFieldContext { @@ -1672,7 +1607,6 @@ namespace CSR { value?: KnockoutObservable; } - interface FormRenderContexWithHook extends SPClientTemplates.RenderContext_FieldInForm { FormContextHook: FormContextHook; } @@ -1684,16 +1618,14 @@ namespace CSR { interface FormContextHookField { fieldSchema?: SPClientTemplates.FieldSchema_InForm; lastValue?: any; - getValue?: () => any; + getValue?(): any; updatedValueCallbacks: UpdatedValueCallback[]; } - function ensureFormContextHookField(hook: FormContextHook, fieldName: string): FormContextHookField { return hook[fieldName] = hook[fieldName] || { updatedValueCallbacks: [] }; - } class BooleanValueValidator implements SPClientForms.ClientValidation.IValidator { @@ -1703,23 +1635,17 @@ namespace CSR { return new SPClientForms.ClientValidation.ValidationResult(!this.valueGetter(), this.validationMessage); } } - } if (typeof SP === 'object' && SP && typeof SP.SOD === 'object' && SP.SOD) { SP.SOD.notifyScriptLoadedAndExecuteWaitingJobs("typescripttemplates.ts"); } - // mquery.ts - - - namespace spdevlab { export namespace mQuery { export class DynamicTable { - // private fields _domContainer: HTMLElement; _tableContainer: MQueryResultSetElements; @@ -1735,7 +1661,6 @@ namespace spdevlab { // public methods init(domContainer: HTMLElement, options) { - if (m$.isDefinedAndNotNull(options)) { m$.extend(this._options, options); } @@ -1749,7 +1674,6 @@ namespace spdevlab { // private methods _initContainers(domContainer) { - this._domContainer = domContainer; this._tableContainer = m$(this._options.tableCnt, this._domContainer); } @@ -1759,17 +1683,13 @@ namespace spdevlab { } _initEvents() { - m$(this._options.addCnt, this._domContainer).click(() => { - if (m$.isDefinedAndNotNull(this._rowTemplateContent)) { - m$(this._tableContainer).append(this._rowTemplateContent); m$("tr:last-child " + this._options.removeCnt, this._tableContainer).click((e) => { - - var targetElement = e.currentTarget as HTMLElement; - var parentRow = m$(targetElement).parents("tr").first(); + const targetElement = e.currentTarget as HTMLElement; + const parentRow = m$(targetElement).parents("tr").first(); m$(parentRow).remove(); }); @@ -1780,7 +1700,7 @@ namespace spdevlab { } _initRowTemplate() { - var templateId = m$(this._tableContainer).attr("template-id"); + const templateId = m$(this._tableContainer).attr("template-id"); if (m$.isDefinedAndNotNull(templateId)) { this._rowTemplateId = templateId; @@ -1792,8 +1712,7 @@ namespace spdevlab { static initTables() { // init templates m$('script').forEach((template: HTMLElement) => { - - var id = m$(template).attr("dynamic-table-template-id"); + const id = m$(template).attr("dynamic-table-template-id"); if (m$.isDefinedAndNotNull(id)) { DynamicTable._templates[id] = template.innerHTML; @@ -1802,18 +1721,14 @@ namespace spdevlab { // init tables m$(".spdev-rep-tb-cnt").forEach(divContainer => { - - var dynamicTable = new DynamicTable(); + const dynamicTable = new DynamicTable(); dynamicTable.init(divContainer, { removeCnt: '.spdev-rep-tb-del-override' }); }); } - }; - - } } @@ -1821,16 +1736,14 @@ m$.ready(() => { spdevlab.mQuery.DynamicTable.initTables(); }); - // whoisapppart.ts - namespace _ { - var queryString = parseQueryString(); - var isIframe = queryString['DisplayMode'] === 'iframe'; - var spHostUrl = queryString['SPHostUrl']; - var editmode = Number(queryString['editmode']); - var includeDetails = queryString['boolProp'] === 'true'; + const queryString = parseQueryString(); + const isIframe = queryString['DisplayMode'] === 'iframe'; + const spHostUrl = queryString['SPHostUrl']; + const editmode = Number(queryString['editmode']); + const includeDetails = queryString['boolProp'] === 'true'; prepareVisual(); m$.ready(() => { @@ -1844,7 +1757,7 @@ namespace _ { // Load the people picker function loadPeoplePicker(peoplePickerElementId: string) { - var schema: ISPClientPeoplePickerSchema = { + const schema: ISPClientPeoplePickerSchema = { PrincipalAccountType: "User", AllowMultipleValues: false, Width: 300, @@ -1856,20 +1769,19 @@ namespace _ { function onUserResolvedClientScript(el: string, users: ISPClientPeoplePickerEntity[]) { if (users.length > 0) { - var person = users[0]; - var accountName = person.Key; + const person = users[0]; + const accountName = person.Key; - var context = SP.ClientContext.get_current(); + const context = SP.ClientContext.get_current(); - var peopleManager = new SP.UserProfiles.PeopleManager(context); - var personProperties = peopleManager.getPropertiesFor(accountName); + const peopleManager = new SP.UserProfiles.PeopleManager(context); + const personProperties = peopleManager.getPropertiesFor(accountName); context.load(personProperties); context.executeQueryAsync((sender, args) => { - $get("basicInfo").style.display = 'block'; - var userPic = personProperties.get_userProfileProperties()["PictureURL"]; + const userPic = personProperties.get_userProfileProperties()["PictureURL"]; $get("pic").innerHTML = ' + personProperties.get_displayName() + '; $get("name").innerHTML = '' + personProperties.get_displayName() + ''; @@ -1878,9 +1790,9 @@ namespace _ { $get("department").innerHTML = person.EntityData.Department; $get("phone").innerHTML = person.EntityData.MobilePhone; - var properties = personProperties.get_userProfileProperties(); - var messageText = ""; - for (var key in properties) { + const properties = personProperties.get_userProfileProperties(); + let messageText = ""; + for (const key in properties) { if (properties.hasOwnProperty(key)) continue; messageText += "
[" + key + "]: \"" + properties[key] + "\""; @@ -1890,14 +1802,11 @@ namespace _ { if (isIframe) { partResize(); } - }, (sender, args) => { alert('Error: ' + args.get_message()); }); - } } function partProperties() { - if (editmode === 1) { $get("editmodehdr").style.display = "inline"; $get("content").style.display = "none"; @@ -1910,23 +1819,22 @@ namespace _ { } function partResize() { - var bounds = Sys.UI.DomElement.getBounds(document.body); + const bounds = Sys.UI.DomElement.getBounds(document.body); parent.postMessage('resize(' + bounds.width + ',' + bounds.height + ')', '*'); } function prepareVisual() { if (isIframe) { // Create a Link element for the defaultcss.ashx resource - var linkElement = document.createElement('link'); + const linkElement = document.createElement('link'); linkElement.setAttribute('rel', 'stylesheet'); linkElement.setAttribute('href', spHostUrl + '/_layouts/15/defaultcss.ashx'); // Add the linkElement as a child to the head section of the html document.head.appendChild(linkElement); } else { - m$.ready(() => { - var nav = new SP.UI.Controls.Navigation('navigation', { + const nav = new SP.UI.Controls.Navigation('navigation', { appIconUrl: queryString['SPHostLogo'], appTitle: document.title }); @@ -1938,13 +1846,13 @@ namespace _ { } function parseQueryString() { - var result = {}; - var qs = document.location.search.split('?')[1]; + const result = {}; + const qs = document.location.search.split('?')[1]; if (qs) { - var parts = qs.split('&'); - for (var part of parts) { + const parts = qs.split('&'); + for (const part of parts) { if (part) { - var pair = part.split('='); + const pair = part.split('='); result[pair[0]] = decodeURIComponent(pair[1]); } } @@ -1955,12 +1863,11 @@ namespace _ { // taxonomy namespace MySP { - // Class export class ClientContextPromise extends SP.ClientContext { /** To use this function, you must ensure that jQuery and CSOMPromise js files are loaded to the page */ executeQueryPromise(): JQueryPromise { - var deferred = jQuery.Deferred(); + const deferred = jQuery.Deferred(); this.executeQueryAsync(function done(sender, args) { deferred.resolve(sender, args); }, @@ -1977,20 +1884,18 @@ namespace MySP { static get_current(): ClientContextPromise { return new ClientContextPromise(_spPageContextInfo.siteServerRelativeUrl); } - } - } SP.SOD.notifyScriptLoadedAndExecuteWaitingJobs("CSOMPromise.ts"); namespace _ { - var context: MySP.ClientContextPromise; - var web: SP.Web; - var site: SP.Site; - var session: SP.Taxonomy.TaxonomySession; - var termStore: SP.Taxonomy.TermStore; - var groups: SP.Taxonomy.TermGroupCollection; + let context: MySP.ClientContextPromise; + let web: SP.Web; + let site: SP.Site; + let session: SP.Taxonomy.TaxonomySession; + let termStore: SP.Taxonomy.TermStore; + let groups: SP.Taxonomy.TermGroupCollection; // This code runs when the DOM is ready and creates a context object // which is needed to use the SharePoint object model. @@ -2033,15 +1938,15 @@ namespace _ { function onRetrieveGroups() { $('#report').children().remove(); - var groupEnum = groups.getEnumerator(); + const groupEnum = groups.getEnumerator(); // For each group, we'll build a clickable div. while (groupEnum.moveNext()) { (() => { - var currentGroup = groupEnum.get_current(); - var groupName = document.createElement("div"); + const currentGroup = groupEnum.get_current(); + const groupName = document.createElement("div"); groupName.setAttribute("style", "float:none;cursor:pointer"); - var groupID = currentGroup.get_id(); + const groupID = currentGroup.get_id(); groupName.setAttribute("id", groupID.toString()); $(groupName).click(() => showTermSets(groupID)); groupName.appendChild(document.createTextNode(currentGroup.get_name())); @@ -2056,23 +1961,22 @@ namespace _ { // do is retrieve a reference to the group with the same ID as the div, and // then add the term sets that belong to that group under the div that was clicked. function showTermSets(groupID: SP.Guid) { - // First thing is to remnove the divs under the group DIV to ensure we have a clean place to write to. // The reason we don't clear them all is becuase we want to retain the text node of the // group div. I.E. that's why we use "parentDiv.childNodes.length>1" as our loop // controller. - var parentDiv = document.getElementById(groupID.toString()); + const parentDiv = document.getElementById(groupID.toString()); while (parentDiv.childNodes.length > 1) { parentDiv.removeChild(parentDiv.lastChild); } // For each term set, we'll build a clickable div - var currentGroup = groups.getById(groupID); + const currentGroup = groups.getById(groupID); // We need to load and populate the matching group first, or the // term sets that it contains will be inaccessible to our code. context.load(currentGroup); - var termSets: SP.Taxonomy.TermSetCollection; + let termSets: SP.Taxonomy.TermSetCollection; context.executeQueryPromise() .then( () => { @@ -2096,25 +2000,23 @@ namespace _ { // group ID. We also pass in the event object, so that we can cancel the bubble // because this clickable div will be inside a parent clickable div and we // don't want the parent's event to fire. - var termSetEnum = termSets.getEnumerator(); + const termSetEnum = termSets.getEnumerator(); while (termSetEnum.moveNext()) { (() => { - var currentTermSet = termSetEnum.get_current(); - var termSetName = document.createElement("div"); + const currentTermSet = termSetEnum.get_current(); + const termSetName = document.createElement("div"); termSetName.appendChild(document.createTextNode(" + " + currentTermSet.get_name())); termSetName.setAttribute("style", "float:none;cursor:pointer;"); - var termSetID = currentTermSet.get_id(); + const termSetID = currentTermSet.get_id(); termSetName.setAttribute("id", termSetID.toString()); $(termSetName).click(e => showTerms(e, groupID, termSetID)); parentDiv.appendChild(termSetName); })(); } - }) .fail(() => parentDiv.appendChild(document.createTextNode("An error occurred in loading the term sets for this group"))); } - // This is the function that runs when the user clicks one of the divs // that we created in the showTermSets function. We can know which // div was clicked by interrogating the termSetID parameter. So what we'll @@ -2122,7 +2024,6 @@ namespace _ { // then add the term that belong to that term set under the div that was clicked. function showTerms(event: JQueryEventObject, groupID: SP.Guid, termSetID: SP.Guid) { - // First, cancel the bubble so that the group div click handler does not also fire // because that removes all term set divs and we don't want that here. event.cancelBubble = true; @@ -2130,17 +2031,17 @@ namespace _ { // Get a reference to the term set div that was click and // remove its children (apart from the TextNode that is currently // showing the term set name. - var parentDiv = document.getElementById(termSetID.toString()); + const parentDiv = document.getElementById(termSetID.toString()); while (parentDiv.childNodes.length > 1) { parentDiv.removeChild(parentDiv.lastChild); } // We need to load and populate the matching group first, or the // term sets that it contains will be inaccessible to our code. - var currentGroup = groups.getById(groupID); - var termSets: SP.Taxonomy.TermSetCollection; - var currentTermSet: SP.Taxonomy.TermSet; - var terms: SP.Taxonomy.TermCollection; + const currentGroup = groups.getById(groupID); + let termSets: SP.Taxonomy.TermSetCollection; + let currentTermSet: SP.Taxonomy.TermSet; + let terms: SP.Taxonomy.TermCollection; context.load(currentGroup); context @@ -2166,11 +2067,11 @@ namespace _ { return context.executeQueryPromise(); }) .then(() => { - var termsEnum = terms.getEnumerator(); + const termsEnum = terms.getEnumerator(); while (termsEnum.moveNext()) { - var currentTerm = termsEnum.get_current(); + const currentTerm = termsEnum.get_current(); - var term = document.createElement("div"); + const term = document.createElement("div"); term.appendChild(document.createTextNode(" - " + currentTerm.get_name())); term.setAttribute("style", "float:none;margin-left:10px;"); parentDiv.appendChild(term); @@ -2193,7 +2094,6 @@ namespace _ { $('#report').append("Failed to get session. Error: " + args.get_message()); } - // When the createTerms button is clicked, start by loading // a TaxonomySession for the current context. Also get and load // the associated term store. @@ -2205,22 +2105,21 @@ namespace _ { context.executeQueryAsync(onGetTaxonomySession, onFailTaxonomySession); } - // This function is the success callback for loading the session and store from the createTerms function function onGetTaxonomySession() { // Create six GUIDs that we will need when we create a new group, term set, and associated terms - var guidGroupValue = SP.Guid.newGuid(); - var guidTermSetValue = SP.Guid.newGuid(); - var guidTerm1 = SP.Guid.newGuid(); - var guidTerm2 = SP.Guid.newGuid(); - var guidTerm3 = SP.Guid.newGuid(); - var guidTerm4 = SP.Guid.newGuid(); + const guidGroupValue = SP.Guid.newGuid(); + const guidTermSetValue = SP.Guid.newGuid(); + const guidTerm1 = SP.Guid.newGuid(); + const guidTerm2 = SP.Guid.newGuid(); + const guidTerm3 = SP.Guid.newGuid(); + const guidTerm4 = SP.Guid.newGuid(); // Create a new group - var myGroup = termStore.createGroup("CustomTerms", guidGroupValue); + const myGroup = termStore.createGroup("CustomTerms", guidGroupValue); // Create a new term set in the newly-created group - var myTermSet = myGroup.createTermSet("Privacy", guidTermSetValue, 1033); + const myTermSet = myGroup.createTermSet("Privacy", guidTermSetValue, 1033); // Create four new terms in the newly-created term set myTermSet.createTerm("Top Secret", 1033, guidTerm1); @@ -2235,7 +2134,6 @@ namespace _ { // Execute all the preceeding statements in this function context.executeQueryAsync(onAddTerms, onFailAddTerms); - } // If all is well with creating the terms, then this function will run. @@ -2258,7 +2156,6 @@ namespace _ { $('#report').children().remove(); $('#report').append("Failed to get session. Error: " + args.get_message()); } - }; // publishing.ts @@ -2266,46 +2163,43 @@ namespace _ { JSRequest.EnsureSetup(); SP.SOD.execute('mquery.js', 'm$.ready', () => { - var context = SP.ClientContext.get_current(); - var web = context.get_web(); + const context = SP.ClientContext.get_current(); + const web = context.get_web(); m$('#CreatePage').click(createPage); }); function createPage(evt) { SP.SOD.execute('sp.js', 'SP.ClientConext', () => { SP.SOD.execute('sp.publishing.js', 'SP.Publishing', () => { - var context = SP.ClientContext.get_current(); + const context = SP.ClientContext.get_current(); - - var hostUrl = decodeURIComponent(JSRequest.QueryString["SPHostUrl"]); - var hostcontext = new SP.AppContextSite(context, hostUrl); - var web = hostcontext.get_web(); - var pubWeb = SP.Publishing.PublishingWeb.getPublishingWeb(context, web); + const hostUrl = decodeURIComponent(JSRequest.QueryString["SPHostUrl"]); + const hostcontext = new SP.AppContextSite(context, hostUrl); + const web = hostcontext.get_web(); + const pubWeb = SP.Publishing.PublishingWeb.getPublishingWeb(context, web); context.load(web); context.load(pubWeb); context.executeQueryAsync( // Success callback after getting the host Web as a PublishingWeb. // We now want to add a new Publishing Page. function done() { - var pageInfo = new SP.Publishing.PublishingPageInformation(); - var newPage = pubWeb.addPublishingPage(pageInfo); + const pageInfo = new SP.Publishing.PublishingPageInformation(); + const newPage = pubWeb.addPublishingPage(pageInfo); context.load(newPage); context.executeQueryAsync( function done() { - // Success callback after adding a new Publishing Page. // We want to get the actual list item that is represented by the Publishing Page. - var listItem = newPage.get_listItem(); + const listItem = newPage.get_listItem(); context.load(listItem); context.executeQueryAsync( - // Success callback after getting the actual list item that is // represented by the Publishing Page. // We can now get its FieldValues, one of which is its FileLeafRef value. // We can then use that value to build the Url to the new page // and set the href or our link to that Url. function done() { - var link = document.getElementById("linkToPage"); + const link = document.getElementById("linkToPage"); link.setAttribute("href", web.get_url() + "/Pages/" + listItem.get_fieldValues().FileLeafRef); link.innerText = "Go to new page!"; }, @@ -2334,13 +2228,11 @@ function createPage(evt) { // likes namespace SampleReputation { - interface MyList extends SPClientTemplates.RenderContext_InView { listId: string; } class MyItem { - id: number; title: string; likesCount: number; @@ -2355,7 +2247,7 @@ namespace SampleReputation { private getLike(likedBy): boolean { if (likedBy && likedBy.length > 0) { - for (var likedByItem of likedBy) { + for (const likedByItem of likedBy) { if (likedByItem.id === _spPageContextInfo.userId) { return true; } @@ -2383,15 +2275,14 @@ namespace SampleReputation { RegisterModuleInit('/SPTypeScript/ReputationModule/likes.js', init); }); - SP.SOD.notifyScriptLoadedAndExecuteWaitingJobs('likes.js'); } function renderTemplate(ctx: MyList) { - var rows = ctx.ListData.Row; - var result = ''; - for (var row of rows) { - var item = new MyItem(row); + const rows = ctx.ListData.Row; + let result = ''; + for (const row of rows) { + const item = new MyItem(row); result += '\
  • ' + item.title + '\ \ @@ -2407,14 +2298,14 @@ namespace SampleReputation { } export function setLike(itemId: number, listId: string): void { - var context = SP.ClientContext.get_current(); - var isLiked = m$('#likesCountText' + itemId)[0].textContent === '\u2661'; + const context = SP.ClientContext.get_current(); + const isLiked = m$('#likesCountText' + itemId)[0].textContent === '\u2661'; SP.SOD.executeFunc('reputation.js', 'Microsoft.Office.Server.ReputationModel.Reputation', function fail() { Microsoft.Office.Server.ReputationModel.Reputation.setLike(context, listId, itemId, isLiked); context.executeQueryAsync( () => { m$('#likesCountText' + itemId)[0].textContent = getLikeText(isLiked); - var likesCount = parseInt(m$('#likesCount' + itemId)[0].textContent, 10); + const likesCount = parseInt(m$('#likesCount' + itemId)[0].textContent, 10); m$('#likesCount' + itemId)[0].textContent = (isLiked ? likesCount + 1 : likesCount - 1).toString(); }, (sender, args) => { @@ -2426,12 +2317,10 @@ namespace SampleReputation { init(); } - - // code from https://github.com/gandjustas/SharePointAngularTS namespace App { "use strict"; - var app = angular.module("app", []); + const app = angular.module("app", []); } // Install the angularjs.TypeScript.DefinitelyTyped NuGet package @@ -2440,7 +2329,7 @@ namespace App { interface Iappcontroller { title: string; - activate: () => void; + activate(): void; } class appcontroller implements Iappcontroller { @@ -2454,27 +2343,24 @@ namespace App { } activate() { - var loading = this.$n.showLoading(true); + const loading = this.$n.showLoading(true); this.$SharePoint .getLists() .then(l => this.lists = l) .catch((e: string) => this.$n.show(e, true)) .finally(() => this.$n.remove(loading)); ; - } } angular.module("app").controller("appcontroller", appcontroller); } - - namespace App { "use strict"; export interface SharePoint { - getLists: () => ng.IPromise; + getLists(): ng.IPromise; } class SharePointServcie implements SharePoint { @@ -2484,18 +2370,18 @@ namespace App { } getLists() { - var promise = this.$q.defer(); + const promise = this.$q.defer(); SP.SOD.executeFunc("sp.js", "SP.ClientContext", () => { - var ctx = SP.ClientContext.get_current(); - var hostUrl = decodeURIComponent(SP.ScriptHelpers.getDocumentQueryPairs()['SPHostUrl']); - var appCtx = new SP.AppContextSite(ctx, hostUrl); - var hostWeb = appCtx.get_web(); - var lists = hostWeb.get_lists(); + const ctx = SP.ClientContext.get_current(); + const hostUrl = decodeURIComponent(SP.ScriptHelpers.getDocumentQueryPairs()['SPHostUrl']); + const appCtx = new SP.AppContextSite(ctx, hostUrl); + const hostWeb = appCtx.get_web(); + const lists = hostWeb.get_lists(); ctx.load(lists); ctx.executeQueryAsync(() => { - var result: SP.List[] = []; - for (var e = lists.getEnumerator(); e.moveNext(); /* nothing */) { + const result: SP.List[] = []; + for (const e = lists.getEnumerator(); e.moveNext(); /* nothing */) { result.push(e.get_current()); } promise.resolve(result); @@ -2509,7 +2395,6 @@ namespace App { angular.module("app").service("$SharePoint", SharePointServcie); } - // Install the angularjs.TypeScript.DefinitelyTyped NuGet package namespace App { "use strict"; @@ -2523,7 +2408,6 @@ namespace App { class NotifyImpl implements SpNotify { static $inject: string[] = []; - showLoading(sticky: boolean = false) { return SP.UI.Notify.showLoadingNotification(sticky); } @@ -2539,4 +2423,3 @@ namespace App { angular.module("app").service("$spnotify", NotifyImpl); } - diff --git a/types/steed/tslint.json b/types/steed/tslint.json index 0f47deabb4..3bfbe8c142 100644 --- a/types/steed/tslint.json +++ b/types/steed/tslint.json @@ -1,6 +1,6 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false + "ban-types": false } } \ No newline at end of file diff --git a/types/tcomb/tslint.json b/types/tcomb/tslint.json index c3d18eb9dd..d3cce83dc9 100644 --- a/types/tcomb/tslint.json +++ b/types/tcomb/tslint.json @@ -2,7 +2,7 @@ "extends": "../tslint.json", "rules": { "callable-types": false, - "forbidden-types": false, + "ban-types": false, "no-empty-interface": false, "no-single-declare-module": false, "unified-signatures": false diff --git a/types/tedious/index.d.ts b/types/tedious/index.d.ts index 39d8664e0d..b89ac58beb 100644 --- a/types/tedious/index.d.ts +++ b/types/tedious/index.d.ts @@ -297,7 +297,7 @@ export interface ConnectionConfig { export interface ParameterOptions { // for VarChar, NVarChar, VarBinary - length?: number; + length?: number | 'max'; // precision for Numeric, Decimal precision?: number; // scale for Numeric, Decimal, Time, DateTime2, DateTimeOffset diff --git a/types/transducers-js/tslint.json b/types/transducers-js/tslint.json index f05741c59b..b0e7084e94 100644 --- a/types/transducers-js/tslint.json +++ b/types/transducers-js/tslint.json @@ -1,6 +1,6 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false + "ban-types": false } } diff --git a/types/tslint.json b/types/tslint.json index 56b31d320a..36eac22f51 100644 --- a/types/tslint.json +++ b/types/tslint.json @@ -1 +1,7 @@ -{ "extends": "../node_modules/types-publisher/tslint-definitions.json" } \ No newline at end of file +{ + "extends": "dtslint/dtslint.json", + "rules": { + // https://github.com/palantir/tslint/pull/2391 + "prefer-const": false + } +} diff --git a/types/tweezer.js/index.d.ts b/types/tweezer.js/index.d.ts new file mode 100644 index 0000000000..1144eed7de --- /dev/null +++ b/types/tweezer.js/index.d.ts @@ -0,0 +1,24 @@ +// Type definitions for tweezer.js 1.4 +// Project: https://github.com/jaxgeller/tweezer.js +// Definitions by: Lindsey Smith +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +interface Options { + duration?: number; + easing?: (currentTime: number, beginningTime: number, changeInValue: number, duration: number) => number; + start: number; + end: number; +} + +declare class Tweezer { + constructor(opts: Options); + + stop(): this; + + on(name: 'tick', handler: (v: number) => void): this; + on(name: 'done', handler: () => void): this; + + begin(): this; +} + +export default Tweezer; diff --git a/types/tweezer.js/tsconfig.json b/types/tweezer.js/tsconfig.json new file mode 100644 index 0000000000..801c03fe35 --- /dev/null +++ b/types/tweezer.js/tsconfig.json @@ -0,0 +1,22 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "tweezer.js-tests.ts" + ] +} \ No newline at end of file diff --git a/types/tweezer.js/tslint.json b/types/tweezer.js/tslint.json new file mode 100644 index 0000000000..2221e40e4a --- /dev/null +++ b/types/tweezer.js/tslint.json @@ -0,0 +1 @@ +{ "extends": "../tslint.json" } \ No newline at end of file diff --git a/types/tweezer.js/tweezer.js-tests.ts b/types/tweezer.js/tweezer.js-tests.ts new file mode 100644 index 0000000000..cd3218966f --- /dev/null +++ b/types/tweezer.js/tweezer.js-tests.ts @@ -0,0 +1,28 @@ +import Tweezer from 'tweezer.js'; + +const tweezer = new Tweezer({ + start: 100, + end: 200, +}); + +tweezer + .on('tick', (foo) => {foo.toFixed()}) + .on('done', () => {}) + .begin() + .stop(); + +function testEaser(currentTime: number, beginningTime: number, changeInValue: number, duration: number) { + return 42; +} + +const tweezer2 = new Tweezer({ + start: 100, + end: 200, + easing: testEaser +}); + +const tweezer3 = new Tweezer({ + start: 100, + end: 200, + duration: 42 +}); diff --git a/types/universal-router/tslint.json b/types/universal-router/tslint.json index f05741c59b..b0e7084e94 100644 --- a/types/universal-router/tslint.json +++ b/types/universal-router/tslint.json @@ -1,6 +1,6 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false + "ban-types": false } } diff --git a/types/vinyl-fs/index.d.ts b/types/vinyl-fs/index.d.ts index 52aa5cd506..84bcaf3533 100644 --- a/types/vinyl-fs/index.d.ts +++ b/types/vinyl-fs/index.d.ts @@ -101,7 +101,7 @@ interface SrcOptions extends globStream.Options { * fs.src(['!b*.js', '*.js']) would not exclude any files, but this would: fs.src(['*.js', '!b*.js']) * @param opt Options Vinyl source options, changes the way the files are read, found, or stored in the vinyl stream */ -declare function src(globs: string|string[], opt?: SrcOptions): NodeJS.ReadWriteStream; +export function src(globs: string|string[], opt?: SrcOptions): NodeJS.ReadWriteStream; /** * This is just a glob-watcher @@ -110,7 +110,7 @@ declare function src(globs: string|string[], opt?: SrcOptions): NodeJS.ReadWrite * Globs are executed in order, so negations should follow positive globs * fs.src(['!b*.js', '*.js']) would not exclude any files, but this would: fs.src(['*.js', '!b*.js']) */ -declare function watch(globs: string|string[], cb?: (outEvt: { type: any; path: any; old: any; }) => void): _events.EventEmitter; +export function watch(globs: string|string[], cb?: (outEvt: { type: any; path: any; old: any; }) => void): _events.EventEmitter; /** * This is just a glob-watcher @@ -119,13 +119,13 @@ declare function watch(globs: string|string[], cb?: (outEvt: { type: any; path: * Globs are executed in order, so negations should follow positive globs * fs.src(['!b*.js', '*.js']) would not exclude any files, but this would: fs.src(['*.js', '!b*.js']) */ -declare function watch( +export function watch( globs: string|string[], opt?: { interval?: number; debounceDelay?: number; cwd?: string; - maxListeners?: () => number; + maxListeners?(): number; }, cb?: (outEvt: { type: any; path: any; old: any; }) => void): _events.EventEmitter; @@ -138,7 +138,7 @@ declare function watch( * contents will have it's position reset to the beginning if it is a stream * @param folder destination folder */ -declare function dest(folder: string, opt?: { +export function dest(folder: string, opt?: { /** Specify the working directory the folder is relative to * Default is process.cwd() */ @@ -166,7 +166,7 @@ declare function dest(folder: string, opt?: { * contents will have it's position reset to the beginning if it is a stream * @param getFolderPath function that takes in a file and returns a folder path */ -declare function dest(getFolderPath: (file: File) => string): NodeJS.ReadWriteStream; +export function dest(getFolderPath: (file: File) => string): NodeJS.ReadWriteStream; /** * On write the stream will create a symbolic link (i.e. symlink) on disk at the folder/cwd specified. @@ -174,7 +174,7 @@ declare function dest(getFolderPath: (file: File) => string): NodeJS.ReadWriteSt * The file will be modified after being written to this stream: * cwd, base, and path will be overwritten to match the folder */ -declare function symlink(folder: string, opts?: { +export function symlink(folder: string, opts?: { /** * Specify the working directory the folder is relative to * Default is process.cwd() @@ -197,7 +197,7 @@ declare function symlink(folder: string, opts?: { * The file will be modified after being written to this stream: * cwd, base, and path will be overwritten to match the folder */ -declare function symlink(getFolderPath: (File: File) => string, opts?: +export function symlink(getFolderPath: (File: File) => string, opts?: { /** * Specify the working directory the folder is relative to @@ -210,5 +210,4 @@ declare function symlink(getFolderPath: (File: File) => string, opts?: * Default is the process mode */ dirMode?: number - }): NodeJS.ReadWriteStream; diff --git a/types/vinyl-fs/vinyl-fs-tests.ts b/types/vinyl-fs/vinyl-fs-tests.ts index 33d031f521..38585422c8 100644 --- a/types/vinyl-fs/vinyl-fs-tests.ts +++ b/types/vinyl-fs/vinyl-fs-tests.ts @@ -6,20 +6,20 @@ import * as path from 'path'; import * as fs from 'fs'; // require('graceful-fs'); // import bufEqual = require('buffer-equal'); -declare var bufEqual: any; +declare const bufEqual: any; // import through = require('through2'); -declare var through: any; +declare const through: any; import File = require('vinyl'); -// var spies = require('./spy'); -declare var spies: any; +// const spies = require('./spy'); +declare const spies: any; import * as should from 'should'; import 'mocha'; -declare var gulp: any; -declare var bufferStream: any; +declare const gulp: any; +let bufferStream: any; -var dataWrap = (fn: any) => { +let dataWrap = (fn: any) => { return (data: any, enc: any, cb: any) => { fn(data); cb(); @@ -27,9 +27,8 @@ var dataWrap = (fn: any) => { }; describe('source stream', () => { - it('should explode on invalid glob (empty)', done => { - var stream: any; + let stream: any; try { stream = gulp.src(); } catch (err) { @@ -40,7 +39,7 @@ describe('source stream', () => { }); it('should explode on invalid glob (number)', done => { - var stream: any; + let stream: any; try { stream = gulp.src(123); } catch (err) { @@ -51,7 +50,7 @@ describe('source stream', () => { }); it('should explode on invalid glob (empty array)', done => { - var stream: any; + let stream: any; try { stream = gulp.src([]); } catch (err) { @@ -62,26 +61,26 @@ describe('source stream', () => { }); it('should pass through writes', done => { - var expectedPath = path.join(__dirname, "./fixtures/test.coffee"); - var expectedContent = fs.readFileSync(expectedPath); + const expectedPath = path.join(__dirname, "./fixtures/test.coffee"); + const expectedContent = fs.readFileSync(expectedPath); - var expectedFile = new File({ + const expectedFile = new File({ base: __dirname, cwd: __dirname, path: expectedPath, contents: expectedContent }); - var onEnd = () => { + const onEnd = () => { buffered.length.should.equal(1); buffered[0].should.equal(expectedFile); bufEqual(buffered[0].contents, expectedContent).should.equal(true); done(); }; - var stream = vfs.src("./fixtures/nothing.coffee"); + const stream = vfs.src("./fixtures/nothing.coffee"); - var buffered: any[] = []; + const buffered: any[] = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); stream.write(expectedFile); @@ -89,10 +88,10 @@ describe('source stream', () => { }); it('should glob a file with default settings', done => { - var expectedPath = path.join(__dirname, "./fixtures/test.coffee"); - var expectedContent = fs.readFileSync(expectedPath); + const expectedPath = path.join(__dirname, "./fixtures/test.coffee"); + const expectedContent = fs.readFileSync(expectedPath); - var onEnd = () => { + const onEnd = () => { buffered.length.should.equal(1); should.exist(buffered[0].stat); buffered[0].path.should.equal(expectedPath); @@ -101,18 +100,18 @@ describe('source stream', () => { done(); }; - var stream = vfs.src("./fixtures/*.coffee", { cwd: __dirname }); + const stream = vfs.src("./fixtures/*.coffee", { cwd: __dirname }); - var buffered: any[] = []; + const buffered: any[] = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); }); it('should glob a file with default settings and relative cwd', done => { - var expectedPath = path.join(__dirname, "./fixtures/test.coffee"); - var expectedContent = fs.readFileSync(expectedPath); + const expectedPath = path.join(__dirname, "./fixtures/test.coffee"); + const expectedContent = fs.readFileSync(expectedPath); - var onEnd = () => { + const onEnd = () => { buffered.length.should.equal(1); should.exist(buffered[0].stat); buffered[0].path.should.equal(expectedPath); @@ -121,17 +120,17 @@ describe('source stream', () => { done(); }; - var stream = vfs.src("./fixtures/*.coffee", { cwd: path.relative(process.cwd(), __dirname) }); + const stream = vfs.src("./fixtures/*.coffee", { cwd: path.relative(process.cwd(), __dirname) }); - var buffered: any[] = []; + const buffered: any[] = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); }); it('should glob a directory with default settings', done => { - var expectedPath = path.join(__dirname, "./fixtures/wow"); + const expectedPath = path.join(__dirname, "./fixtures/wow"); - var onEnd = () => { + const onEnd = () => { buffered.length.should.equal(1); buffered[0].path.should.equal(expectedPath); buffered[0].isNull().should.equal(true); @@ -139,18 +138,18 @@ describe('source stream', () => { done(); }; - var stream = vfs.src("./fixtures/wow/", { cwd: __dirname }); + const stream = vfs.src("./fixtures/wow/", { cwd: __dirname }); - var buffered: any[] = []; + const buffered: any[] = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); }); it('should glob a file with with no contents', done => { - var expectedPath = path.join(__dirname, "./fixtures/test.coffee"); - var expectedContent = fs.readFileSync(expectedPath); + const expectedPath = path.join(__dirname, "./fixtures/test.coffee"); + const expectedContent = fs.readFileSync(expectedPath); - var onEnd = () => { + const onEnd = () => { buffered.length.should.equal(1); buffered[0].path.should.equal(expectedPath); buffered[0].isNull().should.equal(true); @@ -158,25 +157,25 @@ describe('source stream', () => { done(); }; - var stream = vfs.src("./fixtures/*.coffee", { cwd: __dirname, read: false }); + const stream = vfs.src("./fixtures/*.coffee", { cwd: __dirname, read: false }); - var buffered: any = []; + const buffered: any = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); }); it('should glob a file with streaming contents', done => { - var expectedPath = path.join(__dirname, "./fixtures/test.coffee"); - var expectedContent = fs.readFileSync(expectedPath); + const expectedPath = path.join(__dirname, "./fixtures/test.coffee"); + const expectedContent = fs.readFileSync(expectedPath); - var onEnd = () => { + const onEnd = () => { buffered.length.should.equal(1); should.exist(buffered[0].stat); buffered[0].path.should.equal(expectedPath); buffered[0].isStream().should.equal(true); - var contentBuffer = new Buffer([]); - var contentBufferStream = through(dataWrap((data: any) => { + let contentBuffer = new Buffer([]); + const contentBufferStream = through(dataWrap((data: any) => { contentBuffer = Buffer.concat([contentBuffer, data]); })); buffered[0].contents.pipe(contentBufferStream); @@ -186,41 +185,40 @@ describe('source stream', () => { }); }; - var stream = vfs.src("./fixtures/*.coffee", { cwd: __dirname, buffer: false }); + const stream = vfs.src("./fixtures/*.coffee", { cwd: __dirname, buffer: false }); - var buffered: any = []; + const buffered: any = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); }); - }); // from dest -// var vfs = require('../'); +// const vfs = require('../'); -// var path = require('path'); -// var fs = require('graceful-fs'); +// const path = require('path'); +// const fs = require('graceful-fs'); import rimraf = require('rimraf'); -// var bufEqual = require('buffer-equal'); -// var through = require('through2'); -// var File = require('vinyl'); +// const bufEqual = require('buffer-equal'); +// const through = require('through2'); +// const File = require('vinyl'); -// var should = require('should'); +// const should = require('should'); // require('mocha'); -var wipeOut = (cb: any) => { +let wipeOut = (cb: any) => { rimraf(path.join(__dirname, "./out-fixtures/"), cb); }; -var dataWrap = (fn: any) => { +dataWrap = (fn: any) => { return (data: any, enc: any, cb: any) => { fn(data); cb(); }; }; -var realMode = (n: any) => { +let realMode = (n: any) => { return n & parseInt("07777", 8); }; @@ -229,7 +227,7 @@ describe('dest stream', () => { afterEach(wipeOut); it('should explode on invalid folder', done => { - var stream: any; + let stream: any; try { stream = gulp.dest(); } catch (err) { @@ -240,24 +238,24 @@ describe('dest stream', () => { }); it('should pass through writes with cwd', done => { - var inputPath = path.join(__dirname, "./fixtures/test.coffee"); + const inputPath = path.join(__dirname, "./fixtures/test.coffee"); - var expectedFile = new File({ + const expectedFile = new File({ base: __dirname, cwd: __dirname, path: inputPath, contents: null }); - var onEnd = () => { + const onEnd = () => { buffered.length.should.equal(1); buffered[0].should.equal(expectedFile); done(); }; - var stream = vfs.dest("./out-fixtures/", { cwd: __dirname }); + const stream = vfs.dest("./out-fixtures/", { cwd: __dirname }); - var buffered: any[] = []; + const buffered: any[] = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); stream.write(expectedFile); @@ -265,24 +263,24 @@ describe('dest stream', () => { }); it('should pass through writes with default cwd', done => { - var inputPath = path.join(__dirname, "./fixtures/test.coffee"); + const inputPath = path.join(__dirname, "./fixtures/test.coffee"); - var expectedFile = new File({ + const expectedFile = new File({ base: __dirname, cwd: __dirname, path: inputPath, contents: null }); - var onEnd = () => { + const onEnd = () => { buffered.length.should.equal(1); buffered[0].should.equal(expectedFile); done(); }; - var stream = vfs.dest(path.join(__dirname, "./out-fixtures/")); + const stream = vfs.dest(path.join(__dirname, "./out-fixtures/")); - var buffered: any[] = []; + const buffered: any[] = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); stream.write(expectedFile); @@ -290,20 +288,20 @@ describe('dest stream', () => { }); it('should not write null files', done => { - var inputPath = path.join(__dirname, "./fixtures/test.coffee"); - var inputBase = path.join(__dirname, "./fixtures/"); - var expectedPath = path.join(__dirname, "./out-fixtures/test.coffee"); - var expectedCwd = __dirname; - var expectedBase = path.join(__dirname, "./out-fixtures"); + const inputPath = path.join(__dirname, "./fixtures/test.coffee"); + const inputBase = path.join(__dirname, "./fixtures/"); + const expectedPath = path.join(__dirname, "./out-fixtures/test.coffee"); + const expectedCwd = __dirname; + const expectedBase = path.join(__dirname, "./out-fixtures"); - var expectedFile = new File({ + const expectedFile = new File({ base: inputBase, cwd: __dirname, path: inputPath, contents: null }); - var onEnd = () => { + const onEnd = () => { buffered.length.should.equal(1); buffered[0].should.equal(expectedFile); buffered[0].cwd.should.equal(expectedCwd, 'cwd should have changed'); @@ -313,9 +311,9 @@ describe('dest stream', () => { done(); }; - var stream = vfs.dest("./out-fixtures/", { cwd: __dirname }); + const stream = vfs.dest("./out-fixtures/", { cwd: __dirname }); - var buffered: any[] = []; + const buffered: any[] = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); stream.write(expectedFile); @@ -323,21 +321,21 @@ describe('dest stream', () => { }); it('should write buffer files to the right folder with relative cwd', done => { - var inputPath = path.join(__dirname, "./fixtures/test.coffee"); - var inputBase = path.join(__dirname, "./fixtures/"); - var expectedPath = path.join(__dirname, "./out-fixtures/test.coffee"); - var expectedCwd = __dirname; - var expectedBase = path.join(__dirname, "./out-fixtures"); - var expectedContents = fs.readFileSync(inputPath); + const inputPath = path.join(__dirname, "./fixtures/test.coffee"); + const inputBase = path.join(__dirname, "./fixtures/"); + const expectedPath = path.join(__dirname, "./out-fixtures/test.coffee"); + const expectedCwd = __dirname; + const expectedBase = path.join(__dirname, "./out-fixtures"); + const expectedContents = fs.readFileSync(inputPath); - var expectedFile = new File({ + const expectedFile = new File({ base: inputBase, cwd: __dirname, path: inputPath, contents: expectedContents }); - var onEnd = () => { + const onEnd = () => { buffered.length.should.equal(1); buffered[0].should.equal(expectedFile); buffered[0].cwd.should.equal(expectedCwd, 'cwd should have changed'); @@ -348,9 +346,9 @@ describe('dest stream', () => { done(); }; - var stream = vfs.dest("./out-fixtures/", { cwd: path.relative(process.cwd(), __dirname) }); + const stream = vfs.dest("./out-fixtures/", { cwd: path.relative(process.cwd(), __dirname) }); - var buffered: any = []; + const buffered: any = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); stream.write(expectedFile); @@ -358,15 +356,15 @@ describe('dest stream', () => { }); it('should write buffer files to the right folder', done => { - var inputPath = path.join(__dirname, "./fixtures/test.coffee"); - var inputBase = path.join(__dirname, "./fixtures/"); - var expectedPath = path.join(__dirname, "./out-fixtures/test.coffee"); - var expectedContents = fs.readFileSync(inputPath); - var expectedCwd = __dirname; - var expectedBase = path.join(__dirname, "./out-fixtures"); - var expectedMode = parseInt("0655", 8); + const inputPath = path.join(__dirname, "./fixtures/test.coffee"); + const inputBase = path.join(__dirname, "./fixtures/"); + const expectedPath = path.join(__dirname, "./out-fixtures/test.coffee"); + const expectedContents = fs.readFileSync(inputPath); + const expectedCwd = __dirname; + const expectedBase = path.join(__dirname, "./out-fixtures"); + const expectedMode = parseInt("0655", 8); - var expectedFile = new File({ + const expectedFile = new File({ base: inputBase, cwd: __dirname, path: inputPath, @@ -376,7 +374,7 @@ describe('dest stream', () => { } }); - var onEnd = () => { + const onEnd = () => { buffered.length.should.equal(1); buffered[0].should.equal(expectedFile); buffered[0].cwd.should.equal(expectedCwd, 'cwd should have changed'); @@ -388,9 +386,9 @@ describe('dest stream', () => { done(); }; - var stream = vfs.dest("./out-fixtures/", { cwd: __dirname }); + const stream = vfs.dest("./out-fixtures/", { cwd: __dirname }); - var buffered: any[] = []; + const buffered: any[] = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); stream.write(expectedFile); @@ -398,16 +396,16 @@ describe('dest stream', () => { }); it('should write streaming files to the right folder', done => { - var inputPath = path.join(__dirname, "./fixtures/test.coffee"); - var inputBase = path.join(__dirname, "./fixtures/"); - var expectedPath = path.join(__dirname, "./out-fixtures/test.coffee"); - var expectedContents = fs.readFileSync(inputPath); - var expectedCwd = __dirname; - var expectedBase = path.join(__dirname, "./out-fixtures"); - var expectedMode = parseInt("0655", 8); + const inputPath = path.join(__dirname, "./fixtures/test.coffee"); + const inputBase = path.join(__dirname, "./fixtures/"); + const expectedPath = path.join(__dirname, "./out-fixtures/test.coffee"); + const expectedContents = fs.readFileSync(inputPath); + const expectedCwd = __dirname; + const expectedBase = path.join(__dirname, "./out-fixtures"); + const expectedMode = parseInt("0655", 8); - var contentStream = through.obj(); - var expectedFile = new File({ + const contentStream = through.obj(); + const expectedFile = new File({ base: inputBase, cwd: __dirname, path: inputPath, @@ -417,7 +415,7 @@ describe('dest stream', () => { } }); - var onEnd = () => { + const onEnd = () => { buffered.length.should.equal(1); buffered[0].should.equal(expectedFile); buffered[0].cwd.should.equal(expectedCwd, 'cwd should have changed'); @@ -429,9 +427,9 @@ describe('dest stream', () => { done(); }; - var stream = vfs.dest("./out-fixtures/", { cwd: __dirname }); + const stream = vfs.dest("./out-fixtures/", { cwd: __dirname }); - var buffered: any = []; + const buffered: any = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); stream.write(expectedFile); @@ -443,14 +441,14 @@ describe('dest stream', () => { }); it('should write directories to the right folder', done => { - var inputPath = path.join(__dirname, "./fixtures/test"); - var inputBase = path.join(__dirname, "./fixtures/"); - var expectedPath = path.join(__dirname, "./out-fixtures/test"); - var expectedCwd = __dirname; - var expectedBase = path.join(__dirname, "./out-fixtures"); - var expectedMode = parseInt("0655", 8); + const inputPath = path.join(__dirname, "./fixtures/test"); + const inputBase = path.join(__dirname, "./fixtures/"); + const expectedPath = path.join(__dirname, "./out-fixtures/test"); + const expectedCwd = __dirname; + const expectedBase = path.join(__dirname, "./out-fixtures"); + const expectedMode = parseInt("0655", 8); - var expectedFile = new File({ + const expectedFile = new File({ base: inputBase, cwd: __dirname, path: inputPath, @@ -461,7 +459,7 @@ describe('dest stream', () => { } }); - var onEnd = () => { + const onEnd = () => { buffered.length.should.equal(1); buffered[0].should.equal(expectedFile); buffered[0].cwd.should.equal(expectedCwd, 'cwd should have changed'); @@ -473,9 +471,9 @@ describe('dest stream', () => { done(); }; - var stream = vfs.dest("./out-fixtures/", { cwd: __dirname }); + const stream = vfs.dest("./out-fixtures/", { cwd: __dirname }); - var buffered: any[] = []; + const buffered: any[] = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); stream.write(expectedFile); @@ -483,14 +481,14 @@ describe('dest stream', () => { }); it('should allow piping multiple dests in streaming mode', done => { - var inputPath1 = path.join(__dirname, "./out-fixtures/multiple-first"); - var inputPath2 = path.join(__dirname, "./out-fixtures/multiple-second"); - var inputBase = path.join(__dirname, "./out-fixtures/"); - var srcPath = path.join(__dirname, "./fixtures/test.coffee"); - var stream1 = vfs.dest('./out-fixtures/', { cwd: __dirname }); - var stream2 = vfs.dest('./out-fixtures/', { cwd: __dirname }); - var content = fs.readFileSync(srcPath); - var rename = through.obj((file: any, _: any, next: any) => { + const inputPath1 = path.join(__dirname, "./out-fixtures/multiple-first"); + const inputPath2 = path.join(__dirname, "./out-fixtures/multiple-second"); + const inputBase = path.join(__dirname, "./out-fixtures/"); + const srcPath = path.join(__dirname, "./fixtures/test.coffee"); + const stream1 = vfs.dest('./out-fixtures/', { cwd: __dirname }); + const stream2 = vfs.dest('./out-fixtures/', { cwd: __dirname }); + const content = fs.readFileSync(srcPath); + const rename = through.obj((file: any, _: any, next: any) => { file.path = inputPath2; this.push(file); next(); @@ -509,7 +507,7 @@ describe('dest stream', () => { done(); }); - var file = new File({ + const file = new File({ base: inputBase, path: inputPath1, cwd: __dirname, @@ -519,32 +517,28 @@ describe('dest stream', () => { stream1.write(file); stream1.end(); }); - }); - - // This test is from +const chmodSpy = spies.chmodSpy; +const statSpy = spies.statSpy; -var chmodSpy = spies.chmodSpy; -var statSpy = spies.statSpy; - -var wipeOut = (cb: any) => { +wipeOut = (cb: any) => { rimraf(path.join(__dirname, './out-fixtures/'), cb); spies.setError('false'); statSpy.reset(); chmodSpy.reset(); }; -var dataWrap = (fn: any) => { +dataWrap = (fn: any) => { return (data: any, enc: any, cb: any) => { fn(data); cb(); }; }; -var realMode = (n: any) => { +realMode = (n: any) => { return n & parseInt("07777", 8); }; @@ -553,7 +547,7 @@ describe('symlink stream', () => { afterEach(wipeOut); it('should explode on invalid folder', (done: any) => { - var stream: any; + let stream: any; try { stream = gulp.symlink(); } catch (err) { @@ -564,24 +558,24 @@ describe('symlink stream', () => { }); it('should pass through writes with cwd', done => { - var inputPath = path.join(__dirname, './fixtures/test.coffee'); + const inputPath = path.join(__dirname, './fixtures/test.coffee'); - var expectedFile = new File({ + const expectedFile = new File({ base: __dirname, cwd: __dirname, path: inputPath, contents: null }); - var onEnd = () => { + const onEnd = () => { buffered.length.should.equal(1); buffered[0].should.equal(expectedFile); done(); }; - var stream = vfs.symlink('./out-fixtures/', { cwd: __dirname }); + const stream = vfs.symlink('./out-fixtures/', { cwd: __dirname }); - var buffered: any[] = []; + const buffered: any[] = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); stream.write(expectedFile); @@ -589,24 +583,24 @@ describe('symlink stream', () => { }); it('should pass through writes with default cwd', done => { - var inputPath = path.join(__dirname, './fixtures/test.coffee'); + const inputPath = path.join(__dirname, './fixtures/test.coffee'); - var expectedFile = new File({ + const expectedFile = new File({ base: __dirname, cwd: __dirname, path: inputPath, contents: null }); - var onEnd = () => { + const onEnd = () => { buffered.length.should.equal(1); buffered[0].should.equal(expectedFile); done(); }; - var stream = vfs.symlink(path.join(__dirname, './out-fixtures/')); + const stream = vfs.symlink(path.join(__dirname, './out-fixtures/')); - var buffered: any[] = []; + const buffered: any[] = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); stream.write(expectedFile); @@ -614,21 +608,21 @@ describe('symlink stream', () => { }); it('should make link to the right folder with relative cwd', done => { - var inputPath = path.join(__dirname, './fixtures/test.coffee'); - var inputBase = path.join(__dirname, './fixtures/'); - var expectedPath = path.join(__dirname, './out-fixtures/test.coffee'); - var expectedCwd = __dirname; - var expectedBase = path.join(__dirname, './out-fixtures'); - var expectedContents = fs.readFileSync(inputPath); + const inputPath = path.join(__dirname, './fixtures/test.coffee'); + const inputBase = path.join(__dirname, './fixtures/'); + const expectedPath = path.join(__dirname, './out-fixtures/test.coffee'); + const expectedCwd = __dirname; + const expectedBase = path.join(__dirname, './out-fixtures'); + const expectedContents = fs.readFileSync(inputPath); - var expectedFile = new File({ + const expectedFile = new File({ base: inputBase, cwd: __dirname, path: inputPath, contents: expectedContents }); - var onEnd = () => { + const onEnd = () => { buffered.length.should.equal(1); buffered[0].should.equal(expectedFile); buffered[0].cwd.should.equal(__dirname, 'cwd should have changed'); @@ -640,9 +634,9 @@ describe('symlink stream', () => { done(); }; - var stream = vfs.symlink('./out-fixtures/', { cwd: path.relative(process.cwd(), __dirname) }); + const stream = vfs.symlink('./out-fixtures/', { cwd: path.relative(process.cwd(), __dirname) }); - var buffered: any = []; + const buffered: any = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); stream.write(expectedFile); @@ -650,21 +644,21 @@ describe('symlink stream', () => { }); it('should write buffer files to the right folder with function and relative cwd', done => { - var inputPath = path.join(__dirname, './fixtures/test.coffee'); - var inputBase = path.join(__dirname, './fixtures/'); - var expectedPath = path.join(__dirname, './out-fixtures/test.coffee'); - var expectedCwd = __dirname; - var expectedBase = path.join(__dirname, './out-fixtures'); - var expectedContents = fs.readFileSync(inputPath); + const inputPath = path.join(__dirname, './fixtures/test.coffee'); + const inputBase = path.join(__dirname, './fixtures/'); + const expectedPath = path.join(__dirname, './out-fixtures/test.coffee'); + const expectedCwd = __dirname; + const expectedBase = path.join(__dirname, './out-fixtures'); + const expectedContents = fs.readFileSync(inputPath); - var expectedFile = new File({ + const expectedFile = new File({ base: inputBase, cwd: __dirname, path: inputPath, contents: expectedContents }); - var onEnd = () => { + const onEnd = () => { buffered.length.should.equal(1); buffered[0].should.equal(expectedFile); buffered[0].cwd.should.equal(__dirname, 'cwd should have changed'); @@ -676,13 +670,13 @@ describe('symlink stream', () => { done(); }; - var stream = vfs.symlink(file => { + const stream = vfs.symlink(file => { should.exist(file); file.should.equal(expectedFile); return './out-fixtures'; }, { cwd: path.relative(process.cwd(), __dirname) }); - var buffered: any[] = []; + const buffered: any[] = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); stream.write(expectedFile); @@ -690,15 +684,15 @@ describe('symlink stream', () => { }); it('should write buffer files to the right folder', done => { - var inputPath = path.join(__dirname, './fixtures/test.coffee'); - var inputBase = path.join(__dirname, './fixtures/'); - var expectedPath = path.join(__dirname, './out-fixtures/test.coffee'); - var expectedContents = fs.readFileSync(inputPath); - var expectedCwd = __dirname; - var expectedBase = path.join(__dirname, './out-fixtures'); - var expectedMode = parseInt("0655", 8); + const inputPath = path.join(__dirname, './fixtures/test.coffee'); + const inputBase = path.join(__dirname, './fixtures/'); + const expectedPath = path.join(__dirname, './out-fixtures/test.coffee'); + const expectedContents = fs.readFileSync(inputPath); + const expectedCwd = __dirname; + const expectedBase = path.join(__dirname, './out-fixtures'); + const expectedMode = parseInt("0655", 8); - var expectedFile = new File({ + const expectedFile = new File({ base: inputBase, cwd: __dirname, path: inputPath, @@ -708,7 +702,7 @@ describe('symlink stream', () => { } }); - var onEnd = () => { + const onEnd = () => { buffered.length.should.equal(1); buffered[0].should.equal(expectedFile); buffered[0].cwd.should.equal(__dirname, 'cwd should have changed'); @@ -720,9 +714,9 @@ describe('symlink stream', () => { done(); }; - var stream = vfs.symlink('./out-fixtures/', { cwd: __dirname }); + const stream = vfs.symlink('./out-fixtures/', { cwd: __dirname }); - var buffered: any[] = []; + const buffered: any[] = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); stream.write(expectedFile); @@ -730,16 +724,16 @@ describe('symlink stream', () => { }); it('should write streaming files to the right folder', done => { - var inputPath = path.join(__dirname, './fixtures/test.coffee'); - var inputBase = path.join(__dirname, './fixtures/'); - var expectedPath = path.join(__dirname, './out-fixtures/test.coffee'); - var expectedContents = fs.readFileSync(inputPath); - var expectedCwd = __dirname; - var expectedBase = path.join(__dirname, './out-fixtures'); - var expectedMode = parseInt("0655", 8); + const inputPath = path.join(__dirname, './fixtures/test.coffee'); + const inputBase = path.join(__dirname, './fixtures/'); + const expectedPath = path.join(__dirname, './out-fixtures/test.coffee'); + const expectedContents = fs.readFileSync(inputPath); + const expectedCwd = __dirname; + const expectedBase = path.join(__dirname, './out-fixtures'); + const expectedMode = parseInt("0655", 8); - var contentStream = through.obj(); - var expectedFile = new File({ + const contentStream = through.obj(); + const expectedFile = new File({ base: inputBase, cwd: __dirname, path: inputPath, @@ -749,7 +743,7 @@ describe('symlink stream', () => { } }); - var onEnd = () => { + const onEnd = () => { buffered.length.should.equal(1); buffered[0].should.equal(expectedFile); buffered[0].cwd.should.equal(__dirname, 'cwd should have changed'); @@ -761,9 +755,9 @@ describe('symlink stream', () => { done(); }; - var stream = vfs.symlink('./out-fixtures/', { cwd: __dirname }); + const stream = vfs.symlink('./out-fixtures/', { cwd: __dirname }); - var buffered: any[] = []; + const buffered: any[] = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); stream.write(expectedFile); @@ -775,14 +769,14 @@ describe('symlink stream', () => { }); it('should write directories to the right folder', done => { - var inputPath = path.join(__dirname, './fixtures/wow'); - var inputBase = path.join(__dirname, './fixtures/'); - var expectedPath = path.join(__dirname, './out-fixtures/wow'); - var expectedCwd = __dirname; - var expectedBase = path.join(__dirname, './out-fixtures'); - var expectedMode = parseInt("0655", 8); + const inputPath = path.join(__dirname, './fixtures/wow'); + const inputBase = path.join(__dirname, './fixtures/'); + const expectedPath = path.join(__dirname, './out-fixtures/wow'); + const expectedCwd = __dirname; + const expectedBase = path.join(__dirname, './out-fixtures'); + const expectedMode = parseInt("0655", 8); - var expectedFile = new File({ + const expectedFile = new File({ base: inputBase, cwd: __dirname, path: inputPath, @@ -793,7 +787,7 @@ describe('symlink stream', () => { } }); - var onEnd = () => { + const onEnd = () => { buffered.length.should.equal(1); buffered[0].should.equal(expectedFile); buffered[0].cwd.should.equal(__dirname, 'cwd should have changed'); @@ -805,9 +799,9 @@ describe('symlink stream', () => { done(); }; - var stream = vfs.symlink('./out-fixtures/', { cwd: __dirname }); + const stream = vfs.symlink('./out-fixtures/', { cwd: __dirname }); - var buffered: any[] = []; + const buffered: any[] = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); stream.write(expectedFile); @@ -815,32 +809,32 @@ describe('symlink stream', () => { }); it('should use different modes for files and directories', done => { - var inputBase = path.join(__dirname, './fixtures'); - var inputPath = path.join(__dirname, './fixtures/wow/suchempty'); - var expectedBase = path.join(__dirname, './out-fixtures/wow'); - var expectedDirMode = parseInt("0755", 8); - var expectedFileMode = parseInt("0655", 8); + const inputBase = path.join(__dirname, './fixtures'); + const inputPath = path.join(__dirname, './fixtures/wow/suchempty'); + const expectedBase = path.join(__dirname, './out-fixtures/wow'); + const expectedDirMode = parseInt("0755", 8); + const expectedFileMode = parseInt("0655", 8); - var firstFile = new File({ + const firstFile = new File({ base: inputBase, cwd: __dirname, path: inputPath, stat: fs.statSync(inputPath) }); - var onEnd = () => { + const onEnd = () => { realMode(fs.lstatSync(expectedBase).mode).should.equal(expectedDirMode); realMode(buffered[0].stat.mode).should.equal(expectedFileMode); done(); }; - var stream = vfs.symlink('./out-fixtures/', { + const stream = vfs.symlink('./out-fixtures/', { cwd: __dirname, mode: expectedFileMode, dirMode: expectedDirMode }); - var buffered: any[] = []; + const buffered: any[] = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); @@ -849,15 +843,15 @@ describe('symlink stream', () => { }); it('should report IO errors', done => { - var inputPath = path.join(__dirname, './fixtures/test.coffee'); - var inputBase = path.join(__dirname, './fixtures/'); - var expectedPath = path.join(__dirname, './out-fixtures/test.coffee'); - var expectedContents = fs.readFileSync(inputPath); - var expectedCwd = __dirname; - var expectedBase = path.join(__dirname, './out-fixtures'); - var expectedMode = parseInt("0722", 8); + const inputPath = path.join(__dirname, './fixtures/test.coffee'); + const inputBase = path.join(__dirname, './fixtures/'); + const expectedPath = path.join(__dirname, './out-fixtures/test.coffee'); + const expectedContents = fs.readFileSync(inputPath); + const expectedCwd = __dirname; + const expectedBase = path.join(__dirname, './out-fixtures'); + const expectedMode = parseInt("0722", 8); - var expectedFile = new File({ + const expectedFile = new File({ base: inputBase, cwd: __dirname, path: inputPath, @@ -870,7 +864,7 @@ describe('symlink stream', () => { fs.mkdirSync(expectedBase); fs.chmodSync(expectedBase, 0); - var stream = vfs.symlink('./out-fixtures/', { cwd: __dirname }); + const stream = vfs.symlink('./out-fixtures/', { cwd: __dirname }); stream.on('error', (err: any) => { err.code.should.equal('EACCES'); done(); @@ -880,14 +874,14 @@ describe('symlink stream', () => { ['end', 'finish'].forEach(eventName => { it('should emit ' + eventName + ' event', done => { - var srcPath = path.join(__dirname, './fixtures/test.coffee'); - var stream = vfs.symlink('./out-fixtures/', { cwd: __dirname }); + const srcPath = path.join(__dirname, './fixtures/test.coffee'); + const stream = vfs.symlink('./out-fixtures/', { cwd: __dirname }); stream.on(eventName, () => { done(); }); - var file = new File({ + const file = new File({ path: srcPath, cwd: __dirname, contents: new Buffer("1234567890") @@ -898,13 +892,13 @@ describe('symlink stream', () => { }); }); it('should check if it"s a vinyl file', () => { - var srcPath = path.join(__dirname, './fixtures/test.coffee'); - var options = { + const srcPath = path.join(__dirname, './fixtures/test.coffee'); + const options = { path: srcPath, cwd: __dirname, contents: new Buffer("1234567890") }; - var file = new File(options); + const file = new File(options); File.isVinyl(file).should.equal(true); File.isVinyl(options).should.equal(false); }); diff --git a/types/webpack/index.d.ts b/types/webpack/index.d.ts index ee9ebd8be2..81085d39d8 100644 --- a/types/webpack/index.d.ts +++ b/types/webpack/index.d.ts @@ -826,6 +826,10 @@ declare namespace webpack { constructor(options?: (percentage: number, msg: string) => void); } + class EnvironmentPlugin extends Plugin { + constructor(envs: string[] | {[key: string]: any}); + } + class ProvidePlugin extends Plugin { constructor(definitions: {[key: string]: any}); } diff --git a/types/webpack/webpack-tests.ts b/types/webpack/webpack-tests.ts index aeb17e5d4c..e29df7cefb 100644 --- a/types/webpack/webpack-tests.ts +++ b/types/webpack/webpack-tests.ts @@ -421,6 +421,8 @@ plugin = new webpack.WatchIgnorePlugin(paths); plugin = new webpack.LoaderOptionsPlugin({ debug: true }); +plugin = new webpack.EnvironmentPlugin(['a', 'b']); +plugin = new webpack.EnvironmentPlugin({a: true, b: 'c'}); plugin = new webpack.ProgressPlugin((percent: number, message: string) => {}); // diff --git a/types/xrm/index.d.ts b/types/xrm/index.d.ts index 67c5a8e778..956dc969a2 100644 --- a/types/xrm/index.d.ts +++ b/types/xrm/index.d.ts @@ -11,19 +11,16 @@ declare var Xrm: Xrm.XrmStatic; declare function GetGlobalContext(): Xrm.Context; -interface Window -{ +interface Window { Xrm: Xrm.XrmStatic; GetGlobalContext(): Xrm.Context; } -declare namespace Xrm -{ +declare namespace Xrm { /** * Static xRM object. */ - export interface XrmStatic - { + interface XrmStatic { /** * Provides a namespace container for the context, data and ui objects. */ @@ -58,7 +55,7 @@ declare namespace Xrm * * @return The attribute. */ - getAttribute( attributeName: string ): T; + getAttribute(attributeName: string): T; /** * Gets an attribute matching attributeName. @@ -67,7 +64,7 @@ declare namespace Xrm * * @return The attribute. */ - getAttribute( attributeName: string ): Page.Attribute; + getAttribute(attributeName: string): Page.Attribute; /** * Gets an attribute by index. @@ -76,7 +73,7 @@ declare namespace Xrm * * @return The attribute. */ - getAttribute( index: number ): Page.Attribute; + getAttribute(index: number): Page.Attribute; /** * Gets an attribute. @@ -85,7 +82,7 @@ declare namespace Xrm * * @return An array of attribute. */ - getAttribute( delegateFunction: Collection.MatchingDelegate ): Page.Attribute[]; + getAttribute(delegateFunction: Collection.MatchingDelegate): Page.Attribute[]; /** * Gets all controls. @@ -102,7 +99,7 @@ declare namespace Xrm * * @return The control. */ - getControl( controlName: string ): T; + getControl(controlName: string): T; /** * Gets a control matching controlName. @@ -111,7 +108,7 @@ declare namespace Xrm * * @return The control. */ - getControl( controlName: string ): Page.Control; + getControl(controlName: string): Page.Control; /** * Gets a control by index. @@ -121,7 +118,7 @@ declare namespace Xrm * * @return The control. */ - getControl( index: number ): T; + getControl(index: number): T; /** * Gets a control by index. @@ -130,7 +127,7 @@ declare namespace Xrm * * @return The control. */ - getControl( index: number ): Page.Control; + getControl(index: number): Page.Control; /** * Gets a control. @@ -139,7 +136,7 @@ declare namespace Xrm * * @return An array of control. */ - getControl( delegateFunction: Collection.MatchingDelegate ): Page.Control[]; + getControl(delegateFunction: Collection.MatchingDelegate): Page.Control[]; }; /** @@ -152,7 +149,7 @@ declare namespace Xrm * @param {string} message The message. * @param {function()} onCloseCallback The "OK" callback. */ - alertDialog( message: string, onCloseCallback: () => void ): void; + alertDialog(message: string, onCloseCallback: () => void): void; /** * Displays a confirmation dialog, with "OK" and "Cancel" buttons. @@ -161,7 +158,7 @@ declare namespace Xrm * @param {function()} yesCloseCallback The "OK" callback. * @param {function()} noCloseCallback The "Cancel" callback. */ - confirmDialog( message: string, yesCloseCallback: () => void, noCloseCallback: () => void ): void; + confirmDialog(message: string, yesCloseCallback: () => void, noCloseCallback: () => void): void; /** * Query if 'entityType' is an Activity entity. @@ -170,7 +167,7 @@ declare namespace Xrm * * @return true if the entity is an Activity, false if not. */ - isActivityType( entityType: string ): boolean; + isActivityType(entityType: string): boolean; /** * Opens quick create. @@ -183,7 +180,7 @@ declare namespace Xrm * error. * @return {Async.XrmPromise} Returns an asynchronous promise. */ - openQuickCreate( entityLogicalName: string, createFromEntity?: Page.LookupValue, parameters?: Utility.OpenParameters ): + openQuickCreate(entityLogicalName: string, createFromEntity?: Page.LookupValue, parameters?: Utility.OpenParameters): Async.XrmPromise; /** @@ -194,7 +191,7 @@ declare namespace Xrm * @param {FormParameters} parameters (Optional) A dictionary object that passes extra query string parameters to the form. * @param {WindowOptions} windowOptions (Optional) Options for controlling the window. */ - openEntityForm( name: string, id?: string, parameters?: Utility.FormOpenParameters, windowOptions?: Utility.WindowOptions ): void; + openEntityForm(name: string, id?: string, parameters?: Utility.FormOpenParameters, windowOptions?: Utility.WindowOptions): void; /** * Opens an HTML Web Resource in a new browser window. @@ -217,7 +214,7 @@ declare namespace Xrm * data (identical to this method's webResourceData parameter) * formid */ - openWebResource( webResourceName: string, webResourceData?: string, width?: number, height?: number ): Window; + openWebResource(webResourceName: string, webResourceData?: string, width?: number, height?: number): Window; }; /** @@ -246,23 +243,22 @@ declare namespace Xrm /** * Client Types for Xrm.Page.context.getClient(). */ - export type Client = "Web" | "Outlook" | "Mobile"; + type Client = "Web" | "Outlook" | "Mobile"; /** * Client States for Xrm.Page.context.getClientState(). */ - export type ClientState = "Online" | "Offline"; + type ClientState = "Online" | "Offline"; /** * Themes for Xrm.Page.context.getCurrentTheme(). */ - export type Theme = "default" | "Office12Blue" | "Office14Silver"; + type Theme = "default" | "Office12Blue" | "Office14Silver"; /** * Interface for the client context. */ - export interface ClientContext - { + interface ClientContext { /** * Returns a value to indicate which client the script is executing in. * @@ -281,8 +277,7 @@ declare namespace Xrm /** * Interface for the xRM application context. */ - export interface Context - { + interface Context { /** * The client's context instance. */ @@ -390,7 +385,7 @@ declare namespace Xrm * * @remarks Format: "/"+ OrgName + sPath */ - prependOrgName( sPath: string ): string; + prependOrgName(sPath: string): string; } /** @@ -398,8 +393,7 @@ declare namespace Xrm * * @see {@link https://msdn.microsoft.com/en-us/library/dn481607.aspx#Anchor_2} for details. */ - export interface SaveOptions - { + interface SaveOptions { /** * Indicates whether to use the Book or Reschedule messages rather than the Create or Update messages. * Applicable to appointment, recurring appointment, or service activity records. @@ -410,8 +404,7 @@ declare namespace Xrm /** * Interface for the Xrm.Page.data object. */ - export interface Data - { + interface Data { /** * Asynchronously refreshes data on the form, without reloading the page. * @@ -419,7 +412,7 @@ declare namespace Xrm * * @return {Async.XrmPromise} Returns an asynchronous promise. */ - refresh( save: boolean ): Async.XrmPromise; + refresh(save: boolean): Async.XrmPromise; /** * Asynchronously saves the record. @@ -435,7 +428,7 @@ declare namespace Xrm * * @return {Async.XrmPromise} Returns an asynchronous promise. */ - save( saveOptions: SaveOptions ): Async.XrmPromise; + save(saveOptions: SaveOptions): Async.XrmPromise; /** * The record context of the form. @@ -453,8 +446,7 @@ declare namespace Xrm /** * Interface for the Xrm.Page.ui object. */ - export interface Ui - { + interface Ui { /** * Displays a form level notification. Any number of notifications can be displayed and will remain until removed using clearFormNotification. * The height of the notification area is limited so each new message will be added to the top. @@ -469,7 +461,7 @@ declare namespace Xrm * WARNING Notification will use the system warning icon. * INFO Notification will use the system info icon. */ - setFormNotification( message: string, level: Page.ui.FormNotificationLevel, uniqueId: string ): boolean; + setFormNotification(message: string, level: Page.ui.FormNotificationLevel, uniqueId: string): boolean; /** * Clears the form notification described by uniqueId. @@ -478,7 +470,7 @@ declare namespace Xrm * * @return True if it succeeds, otherwise false. */ - clearFormNotification( uniqueId: string ): boolean; + clearFormNotification(uniqueId: string): boolean; /** * Closes the form. @@ -563,8 +555,7 @@ declare namespace Xrm /** * Interface for methods to create and manage records in the mobile clients (for phones tablets). */ - export interface Mobile - { + interface Mobile { /** * Provides methods to create and manage records in the mobile clients while working in the offline mode. * @@ -578,8 +569,7 @@ declare namespace Xrm * * @see {@link https://msdn.microsoft.com/en-us/library/mt787123.aspx} for details. */ - export interface MobileOffline - { + interface MobileOffline { /** * Returns whether an entity is offline enabled. * @@ -587,7 +577,7 @@ declare namespace Xrm * * @return {boolean} True if the entity is offline enabled; otherwise False. */ - isOfflineEnabled( entityType: string ): boolean; + isOfflineEnabled(entityType: string): boolean; /** * Creates an entity record in mobile clients while working in the offline mode. @@ -603,7 +593,7 @@ declare namespace Xrm * Integer, Lookup, Memo, Money, Owner, Picklist, String, State * Status, UniqueIdentifier */ - createRecord( entityType: string, data: { [attributeName: string]: any } ): Async.XrmPromise; + createRecord(entityType: string, data: { [attributeName: string]: any }): Async.XrmPromise; /** * Retrieves an entity record in mobile clients while working in the offline mode. @@ -621,7 +611,7 @@ declare namespace Xrm * Integer, Lookup, Memo, Money, Owner, Picklist, String, State * Status, UniqueIdentifier */ - retrieveRecord( entityType: string, id: string, options: string ): Async.XrmPromise; + retrieveRecord(entityType: string, id: string, options: string): Async.XrmPromise; /** * Retrieves a collection of entity records in mobile clients while working in the offline mode. @@ -644,7 +634,7 @@ declare namespace Xrm * Integer, Lookup, Memo, Money, Owner, Picklist, String, State * Status, UniqueIdentifier */ - retrieveMultipleRecords( entityType: string, options: string, maxPageSize: number ): Async.XrmPromise; + retrieveMultipleRecords(entityType: string, options: string, maxPageSize: number): Async.XrmPromise; /** * Updates an entity record in mobile clients while working in the offline mode. @@ -661,7 +651,7 @@ declare namespace Xrm * Integer, Lookup, Memo, Money, Owner, Picklist, String, State * Status, UniqueIdentifier */ - updateRecord( entityType: string, id: string, data: { [attributeName: string]: any } ): Async.XrmPromise; + updateRecord(entityType: string, id: string, data: { [attributeName: string]: any }): Async.XrmPromise; /** * Deletes an entity record in mobile clients while working in the offline mode. @@ -673,25 +663,24 @@ declare namespace Xrm * * @remarks You cannot delete intersect and activity party entities. */ - deleteRecord( entityType: string, id: string ): Async.XrmPromise; + deleteRecord(entityType: string, id: string): Async.XrmPromise; } /** * A definition module for asynchronous interface declarations. */ - export module Async - { + namespace Async { /** * Called when the operation is successful. */ - export type SuccessCallbackDelegate = () => void; + type SuccessCallbackDelegate = () => void; /** * Called when the operation fails. * * @param {ErrorCallbackObject} error The error object. */ - export type ErrorCallbackDelegate = ( error: ErrorCallbackObject ) => void; + type ErrorCallbackDelegate = (error: ErrorCallbackObject) => void; /** * Called when the Xrm.Utility.openQuickCreate operation is successful and a new record has been created. @@ -700,7 +689,7 @@ declare namespace Xrm * * @see {Xrm.Utility.openQuickCreate} */ - export type QuickCreateSuccessCallbackDelegate = ( record: OpenQuickCreateSuccessCallbackObject ) => void; + type QuickCreateSuccessCallbackDelegate = (record: OpenQuickCreateSuccessCallbackObject) => void; /** * Called when the offline operation is successful. @@ -709,7 +698,7 @@ declare namespace Xrm * * @see {Xrm.Mobile.offline} */ - export type OfflineOperationSuccessCallbackDelegate = ( record: OfflineOperationSuccessCallbackObject ) => void; + type OfflineOperationSuccessCallbackDelegate = (record: OfflineOperationSuccessCallbackObject) => void; /** * Called when the offline retrieve multiple operation is successful. @@ -718,7 +707,7 @@ declare namespace Xrm * * @see {Xrm.Mobile.offline.retrieveMultipleRecords} */ - export type OfflineRetrieveMultipleSuccessCallbackDelegate = (resultSet: Array<{ [key: string]: any }>) => void; + type OfflineRetrieveMultipleSuccessCallbackDelegate = (resultSet: Array<{ [key: string]: any }>) => void; /** * Called when the operation fails. @@ -727,13 +716,12 @@ declare namespace Xrm * * @see {Xrm.Mobile.offline} */ - export type OfflineErrorCallbackDelegate = (error: OfflineErrorCallbackObject) => void; + type OfflineErrorCallbackDelegate = (error: OfflineErrorCallbackObject) => void; /** * Object passed to ErrorCallbackDelegate. */ - export interface ErrorCallbackObject - { + interface ErrorCallbackObject { /** * The error code. */ @@ -748,8 +736,7 @@ declare namespace Xrm /** * Object passed to QuickCreateSuccessCallbackDelegate. */ - export interface OpenQuickCreateSuccessCallbackObject - { + interface OpenQuickCreateSuccessCallbackObject { /** * A lookup value which identifies the record which has been created. */ @@ -759,8 +746,7 @@ declare namespace Xrm /** * Object passed to OfflineOperationSuccessCallbackDelegate; */ - export interface OfflineOperationSuccessCallbackObject - { + interface OfflineOperationSuccessCallbackObject { /** * GUID of the record; */ @@ -775,8 +761,7 @@ declare namespace Xrm /** * Object passed to OfflineErrorCallbackDelegate. */ - export interface OfflineErrorCallbackObject extends ErrorCallbackObject - { + interface OfflineErrorCallbackObject extends ErrorCallbackObject { /** * An internal error message that might contain additional details about the issue. */ @@ -789,70 +774,51 @@ declare namespace Xrm * @tparam TSuccessCallback Generic success callback parameter. * @tparam TErrorCallback Generic error callback parameter. */ - export interface XrmPromise - { + interface XrmPromise { /** * A basic 'then' promise. * * @param {SuccessCallbackDelegate} successCallback The success callback. * @param {ErrorCallbackDelegate} errorCallback The error callback. */ - then( successCallback: TSuccessCallback, errorCallback: TErrorCallback ): void; + then(successCallback: TSuccessCallback, errorCallback: TErrorCallback): void; } } /** * A definition module for collection interface declarations. */ - export module Collection - { + namespace Collection { /** - * Interface for a matching delegate. + * Called for each item in an array * - * @tparam T Generic type parameter. + * @param {T} item The item. + * @param {number} index Zero-based index of the item array. + * + * @return true if the item matches, false if it does not. */ - export interface MatchingDelegate - { - /** - * Called for each item in an array - * - * @param {T} item The item. - * @param {number} index Zero-based index of the item array. - * - * @return true if the item matches, false if it does not. - */ - ( item: T, index?: number ): boolean; - } + type MatchingDelegate = (item: T, index?: number) => boolean; /** - * Interface for iterative delegate. + * Called for each item in an array * - * @tparam T Generic type parameter. + * @param {T} item The item. + * @param {number} index Zero-based index of the item array. */ - export interface IterativeDelegate - { - /** - * Called for each item in an array - * - * @param {T} item The item. - * @param {number} index Zero-based index of the item array. - */ - ( item: T, index?: number ): void; - } + type IterativeDelegate = (item: T, index?: number) => void; /** * Interface for an item collection. * * @tparam T Generic type parameter. */ - export interface ItemCollection - { + interface ItemCollection { /** * Applies an operation to all items in this collection. * * @param {IterativeDelegate{T}} delegate An iterative delegate function */ - forEach( delegate: IterativeDelegate ): void; + forEach(delegate: IterativeDelegate): void; /** * Gets. @@ -861,7 +827,7 @@ declare namespace Xrm * * @return A T[] whose members have been validated by delegate. */ - get( delegate: MatchingDelegate ): T[]; + get(delegate: MatchingDelegate): T[]; /** * Gets the item given by the index. @@ -870,7 +836,7 @@ declare namespace Xrm * * @return The T in the itemNumber-th place. */ - get( itemNumber: number ): T; + get(itemNumber: number): T; /** * Gets the item given by the key. @@ -881,7 +847,7 @@ declare namespace Xrm * * @see {@link Xrm.Page.Control.getName()} for Control-naming schemes. */ - get( itemName: string ): T; + get(itemName: string): T; /** * Gets the entire array of T. @@ -904,73 +870,71 @@ declare namespace Xrm * * @see {@link http://msdn.microsoft.com/en-us/library/gg328255.aspx|Documentation} for details. */ - export module Page - { + namespace Page { /** * Requirement Level for Xrm.Page.Attribute.getRequiredLevel() and Xrm.Page.Attribute.setRequiredLevel(). */ - export type RequirementLevel = "none" | "recommended" | "required"; + type RequirementLevel = "none" | "recommended" | "required"; /** * Save Modes for Xrm.Page.Entity.save(). */ - export type SaveMode = "saveandclose" | "saveandnew"; + type SaveMode = "saveandclose" | "saveandnew"; /** * Status for Xrm.Page.Stage.getStatus(). */ - export type Status = "active" | "inactive"; + type Status = "active" | "inactive"; /** * Submit Mode for Xrm.Page.Attribute.getSubmitMode() and Xrm.Page.Attribute.setSubmitMode(). */ - export type SubmitMode = "always" | "dirty" | "never"; + type SubmitMode = "always" | "dirty" | "never"; /** * Control type for Xrm.Page.ui.QuickForm.getControlType(). */ - export type ControlQuickFormType = "quickform"; + type ControlQuickFormType = "quickform"; /** * Control types for Xrm.Page.Control.getControlType(). */ - export type ControlType = "standard" | "iframe" | "lookup" | "optionset" | "subgrid" | "webresource" | "notes" | "timercontrol" | "kbsearch" | ControlQuickFormType; + type ControlType = "standard" | "iframe" | "lookup" | "optionset" | "subgrid" | "webresource" | "notes" | "timercontrol" | "kbsearch" | ControlQuickFormType; /** * Date attribute formats for Xrm.Page.Attribute.getFormat(), used by DateAttribute. */ - export type DateAttributeFormat = "date" | "datetime"; + type DateAttributeFormat = "date" | "datetime"; /** * Integer attribute formats for Xrm.Page.Attribute.getFormat(), used by NumberAttribute. */ - export type IntegerAttributeFormat = "duration" | "none"; + type IntegerAttributeFormat = "duration" | "none"; /** * OptionSet attribute formats for Xrm.Page.Attribute.getFormat(), used by OptionSetAttribute. */ - export type OptionSetAttributeFormat = "language" | "timezone"; + type OptionSetAttributeFormat = "language" | "timezone"; /** * String attribute formats for Xrm.Page.Attribute.getFormat(), used by StringAttribute. */ - export type StringAttributeFormat = "email" | "phone" | "text" | "textarea" | "tickersymbol" | "url"; + type StringAttributeFormat = "email" | "phone" | "text" | "textarea" | "tickersymbol" | "url"; /** * Attribute types for Xrm.ui.ProcessMonitor Xrm.Page.Attribute.setDisplayState(). */ - export type AttributeType = "boolean" | "datetime" | "decimal" | "double" | "integer" | "lookup" | "memo" | "money" | "optionset" | "string"; + type AttributeType = "boolean" | "datetime" | "decimal" | "double" | "integer" | "lookup" | "memo" | "money" | "optionset" | "string"; /** * Attribute formats for Xrm.Page.Attribute.getFormat(). */ - export type AttributeFormat = DateAttributeFormat | IntegerAttributeFormat | OptionSetAttributeFormat | StringAttributeFormat; + type AttributeFormat = DateAttributeFormat | IntegerAttributeFormat | OptionSetAttributeFormat | StringAttributeFormat; /** * Interface for a CRM Business Process Flow instance. */ - export interface Process - { + interface Process { /** * Returns the unique identifier of the process. * @@ -1005,8 +969,7 @@ declare namespace Xrm /** * Interface for CRM Business Process Flow stages. */ - export interface Stage - { + interface Stage { /** * Returns an object with a getValue method which will return the integer value of the business process flow * category. @@ -1055,8 +1018,7 @@ declare namespace Xrm getSteps(): Step[]; } - export interface Step - { + interface Step { /** * Returns the logical name of the attribute associated to the step. * @@ -1088,8 +1050,7 @@ declare namespace Xrm /** * Interface for the event context. */ - export interface EventContext - { + interface EventContext { /** * Gets the Xrm context. * @@ -1130,7 +1091,7 @@ declare namespace Xrm * * @remarks Used to pass values between handlers of an event. */ - getSharedVariable( key: string ): T; + getSharedVariable(key: string): T; /** * Sets a shared variable. @@ -1141,25 +1102,19 @@ declare namespace Xrm * * @remarks Used to pass values between handlers of an event. */ - setSharedVariable( key: string, value: T ): void; + setSharedVariable(key: string, value: T): void; } /** - * Interface for a context-sensitive handler. + * Type for a context-sensitive handler. + * @param {EventContext} context The context. */ - export interface ContextSensitiveHandler - { - /** - * @param {EventContext} context The context. - */ - ( context: EventContext ): void; - } + type ContextSensitiveHandler = (context: EventContext) => void; /** * Interface for UI elements with labels. */ - export interface UiLabelElement - { + interface UiLabelElement { /** * Gets the label. * @@ -1172,14 +1127,13 @@ declare namespace Xrm * * @param {string} label The label. */ - setLabel( label: string ): void; + setLabel(label: string): void; } /** * Interface for UI elements which can have the visibility value read. */ - export interface UiCanGetVisibleElement - { + interface UiCanGetVisibleElement { /** * Gets the visibility state. * @@ -1191,34 +1145,31 @@ declare namespace Xrm /** * Interface for UI elements which can have the visibility value updated. */ - export interface UiCanSetVisibleElement - { + interface UiCanSetVisibleElement { /** * Sets the visibility state. * * @param {boolean} visible true to show, false to hide. */ - setVisible( visible: boolean ): void; + setVisible(visible: boolean): void; } /** * Base interface for standard UI elements. */ - export interface UiStandardElement extends UiCanGetVisibleElement, UiLabelElement - { + interface UiStandardElement extends UiCanGetVisibleElement, UiLabelElement { /** * Sets the visibility state. * * @param {boolean} visible true to show, false to hide. */ - setVisible( visible: boolean ): void; + setVisible(visible: boolean): void; } /** * Interface for focusable UI elements. */ - export interface UiFocusable - { + interface UiFocusable { /** * Sets focus on the element. */ @@ -1229,15 +1180,14 @@ declare namespace Xrm * Interface for controls which methods provide immediate feedback or take actions as user types in a control. * Contains methods which can be used to perform data validations in a control even before the user commits (saves) the value in a form. */ - export interface UiKeyPressable - { + interface UiKeyPressable { /** * Use this to add a function as an event handler for the keypress event so that the function is called when you type a character in the specific text or number field. * For a sample JavaScript code that uses the addOnKeyPress method to configure the auto-completion experience, see Sample: Auto-complete in CRM controls. * * @param {ContextSensitiveHandler} handler The function reference. */ - addOnKeyPress( handler: ContextSensitiveHandler ): void; + addOnKeyPress(handler: ContextSensitiveHandler): void; /** * Use this to manually fire an event handler that you created for a specific text or number field to be executed on the keypress event. @@ -1250,14 +1200,13 @@ declare namespace Xrm * Remarks: If an anonymous function is set using addOnKeyPress, it can’t be removed using this method. * @param {ContextSensitiveHandler} handler The function reference. */ - removeOnKeyPress( handler: ContextSensitiveHandler ): void; + removeOnKeyPress(handler: ContextSensitiveHandler): void; } /** * Interface for Result value of AutoCompleteResultSet */ - export interface AutoCompleteResult - { + interface AutoCompleteResult { /** * The Identifier */ @@ -1277,8 +1226,7 @@ declare namespace Xrm /** * Interface for command of AutoCompleteResultSet. This is displayed at the bottom of the auto complete view */ - export interface AutoCompleteCommand - { + interface AutoCompleteCommand { /** * The Identifier */ @@ -1303,8 +1251,7 @@ declare namespace Xrm /** * Interface for showAutoComplete argument */ - export interface AutoCompleteResultSet - { + interface AutoCompleteResultSet { /** * Results to show */ @@ -1319,8 +1266,7 @@ declare namespace Xrm /** * Interface for a Lookup value. */ - export interface LookupValue - { + interface LookupValue { /** * The identifier. */ @@ -1340,8 +1286,7 @@ declare namespace Xrm /** * Interface for an OptionSet value. */ - export interface OptionSetValue - { + interface OptionSetValue { /** * The label text. */ @@ -1356,8 +1301,7 @@ declare namespace Xrm /** * Interface for a privilege. */ - export interface Privilege - { + interface Privilege { /** * True if the user can read. */ @@ -1377,14 +1321,13 @@ declare namespace Xrm /** * Interface for an Entity attribute. */ - export interface Attribute - { + interface Attribute { /** * Adds a handler to be called when the attribute's value is changed. * * @param {ContextSensitiveHandler} handler The function reference. */ - addOnChange( handler: ContextSensitiveHandler ): void; + addOnChange(handler: ContextSensitiveHandler): void; /** * Fire all "on change" event handlers. @@ -1480,14 +1423,14 @@ declare namespace Xrm * * @param {ContextSensitiveHandler} handler The handler. */ - removeOnChange( handler: ContextSensitiveHandler ): void; + removeOnChange(handler: ContextSensitiveHandler): void; /** * Sets the required level. * * @param {string} requirementLevel The requirement level, as either "none", "required", or "recommended" */ - setRequiredLevel( requirementLevel: RequirementLevel ): void; + setRequiredLevel(requirementLevel: RequirementLevel): void; /** * Sets the submit mode. @@ -1496,7 +1439,7 @@ declare namespace Xrm * * @remarks The default value is "dirty" */ - setSubmitMode( submitMode: SubmitMode ): void; + setSubmitMode(submitMode: SubmitMode): void; /** * A collection of all the controls on the form that interface with this attribute. @@ -1515,7 +1458,7 @@ declare namespace Xrm * * @param {any} value The value. */ - setValue( value: any ): void; + setValue(value: any): void; } /** @@ -1523,8 +1466,7 @@ declare namespace Xrm * * @sa Attribute */ - export interface NumberAttribute extends Attribute - { + interface NumberAttribute extends Attribute { /** * Gets the attribute format. * @@ -1570,7 +1512,7 @@ declare namespace Xrm * * @remarks Attributes on Quick Create Forms will not save values set with this method. */ - setValue( value: number ): void; + setValue(value: number): void; /** * A collection of all the controls on the form that interface with this attribute. @@ -1583,8 +1525,7 @@ declare namespace Xrm * * @sa Attribute */ - export interface StringAttribute extends Attribute - { + interface StringAttribute extends Attribute { /** * Gets the attribute format. * @@ -1624,7 +1565,7 @@ declare namespace Xrm * address formatting. Attributes on Quick Create Forms will not save values set * with this method. */ - setValue( value: string ): void; + setValue(value: string): void; /** * A collection of all the controls on the form that interface with this attribute. @@ -1637,8 +1578,7 @@ declare namespace Xrm * * @sa Attribute */ - export interface EnumAttribute extends Attribute - { + interface EnumAttribute extends Attribute { /** * Gets the initial value of the attribute. * @@ -1654,8 +1594,7 @@ declare namespace Xrm * * @sa EnumAttribute */ - export interface BooleanAttribute extends EnumAttribute - { + interface BooleanAttribute extends EnumAttribute { /** * Gets the value. * @@ -1670,7 +1609,7 @@ declare namespace Xrm * * @remarks Attributes on Quick Create Forms will not save values set with this method. */ - setValue( value: boolean ): void; + setValue(value: boolean): void; } /** @@ -1678,8 +1617,7 @@ declare namespace Xrm * * @sa Attribute */ - export interface DateAttribute extends Attribute - { + interface DateAttribute extends Attribute { /** * Gets the attribute format. * @@ -1704,7 +1642,7 @@ declare namespace Xrm * * @remarks Attributes on Quick Create Forms will not save values set with this method. */ - setValue( value: Date ): void; + setValue(value: Date): void; /** * A collection of all the controls on the form that interface with this attribute. @@ -1717,8 +1655,7 @@ declare namespace Xrm * * @sa EnumAttribute */ - export interface OptionSetAttribute extends EnumAttribute - { + interface OptionSetAttribute extends EnumAttribute { /** * Gets the attribute format. * @@ -1736,7 +1673,7 @@ declare namespace Xrm * * @return The option. */ - getOption( value: number ): OptionSetValue; + getOption(value: number): OptionSetValue; /** * Gets the option matching a label. @@ -1745,7 +1682,7 @@ declare namespace Xrm * * @return The option. */ - getOption( label: string ): OptionSetValue; + getOption(label: string): OptionSetValue; /** * Gets all of the options. @@ -1785,7 +1722,7 @@ declare namespace Xrm * OptionSet attribute. Attributes on Quick Create Forms will not save values set * with this method. */ - setValue( value: number ): void; + setValue(value: number): void; /** * A collection of all the controls on the form that interface with this attribute. @@ -1798,8 +1735,7 @@ declare namespace Xrm * * @sa Attribute */ - export interface LookupAttribute extends Attribute - { + interface LookupAttribute extends Attribute { /** * Gets a boolean value indicating whether the Lookup is a multi-value PartyList. * @@ -1821,7 +1757,7 @@ declare namespace Xrm * * @remarks Attributes on Quick Create Forms will not save values set with this method. */ - setValue( value: LookupValue[] ): void; + setValue(value: LookupValue[]): void; /** * A collection of all the controls on the form that interface with this attribute. @@ -1832,14 +1768,13 @@ declare namespace Xrm /** * Interface for the form's record context, Xrm.Page.data.entity */ - export interface Entity - { + interface Entity { /** * Adds a handler to be called when the record is saved. * * @param {ContextSensitiveHandler} handler The handler. */ - addOnSave( handler: ContextSensitiveHandler ): void; + addOnSave(handler: ContextSensitiveHandler): void; /** * Gets an serialized-XML string representing data that will be passed to the server upon saving @@ -1890,7 +1825,7 @@ declare namespace Xrm * * @param {ContextSensitiveHandler} handler The handler. */ - removeOnSave( handler: ContextSensitiveHandler ): void; + removeOnSave(handler: ContextSensitiveHandler): void; /** * Saves the record. @@ -1907,7 +1842,7 @@ declare namespace Xrm * @param {string} saveMode (Optional) the save mode to save, as either "saveandclose" or * "saveandnew". */ - save( saveMode: SaveMode ): void; + save(saveMode: SaveMode): void; /** * The collection of attributes for the record. @@ -1918,8 +1853,7 @@ declare namespace Xrm /** * Interface for save event arguments. */ - export interface SaveEventArguments - { + interface SaveEventArguments { /** * Gets save mode, as an integer. * @@ -1958,13 +1892,11 @@ declare namespace Xrm /** * Module for the Xrm.Page.data API. */ - export module data - { + namespace data { /** * Interface for the Xrm.Page.data.process API. */ - export interface ProcessManager - { + interface ProcessManager { /** * Returns a Process object representing the active process. * @@ -1978,7 +1910,7 @@ declare namespace Xrm * @param {string} processId The Id of the process to make the active process. * @param {function} callbackFunction (Optional) a function to call when the operation is complete. */ - setActiveProcess( processId: string, callbackFunction?: ProcessCallbackDelegate ): void; + setActiveProcess(processId: string, callbackFunction?: ProcessCallbackDelegate): void; /** * Returns a Stage object representing the active stage. @@ -1993,7 +1925,7 @@ declare namespace Xrm * @param {string} stageId the Id of the stage to make the active stage. * @param {function} callbackFunction (Optional) a function to call when the operation is complete. */ - setActiveStage( stageId: string, callbackFunction?: ProcessCallbackDelegate ): void; + setActiveStage(stageId: string, callbackFunction?: ProcessCallbackDelegate): void; /** * Use this method to get a collection of stages currently in the active path with methods to interact with the @@ -2020,7 +1952,7 @@ declare namespace Xrm * list of enabled processes is the same ones a user can see in the UI if they * want to change the process manually. */ - getEnabledProcesses( callbackFunction: ( enabledProcesses: ProcessDictionary ) => void ): void; + getEnabledProcesses(callbackFunction: (enabledProcesses: ProcessDictionary) => void): void; /** * Use this method to get the currently selected stage. @@ -2040,7 +1972,7 @@ declare namespace Xrm * anonymous function if you may later want to remove the * event handler. */ - addOnStageChange( handler: ContextSensitiveHandler ): void; + addOnStageChange(handler: ContextSensitiveHandler): void; /** * Use this to add a function as an event handler for the OnStageSelected event so that it will be called @@ -2070,7 +2002,7 @@ declare namespace Xrm * @param {ContextSensitiveHandler} handler If an anonymous function is set using the addOnStageChange method it * cannot be removed using this method. */ - removeOnStageSelected( handler: ContextSensitiveHandler ): void; + removeOnStageSelected(handler: ContextSensitiveHandler): void; /** * Progresses to the next stage. @@ -2078,7 +2010,7 @@ declare namespace Xrm * @param {ProcessCallbackDelegate} callbackFunction (Optional) A function to call when the operation is * complete. */ - moveNext( callbackFunction?: ProcessCallbackDelegate ): void; + moveNext(callbackFunction?: ProcessCallbackDelegate): void; /** * Moves to the previous stage. @@ -2086,7 +2018,7 @@ declare namespace Xrm * @param {ProcessCallbackDelegate} callbackFunction (Optional) A function to call when the operation is * complete. */ - movePrevious( callbackFunction?: ProcessCallbackDelegate ): void; + movePrevious(callbackFunction?: ProcessCallbackDelegate): void; } /** @@ -2101,12 +2033,12 @@ declare namespace Xrm * as the active stage.) * unreachable (The stage exists on a different path.) */ - export type ProcessCallbackDelegate = ( status: string ) => void; + type ProcessCallbackDelegate = (status: string) => void; /** * Represents a key-value pair, where the key is the Process Flow's ID, and the value is the name thereof. */ - export interface ProcessDictionary { [index: string]: string; } + interface ProcessDictionary { [index: string]: string; } } /** @@ -2114,8 +2046,7 @@ declare namespace Xrm * * @sa UiElement */ - export interface Control extends UiLabelElement, UiCanGetVisibleElement - { + interface Control extends UiLabelElement, UiCanGetVisibleElement { /** * Gets the controls type. * @@ -2167,8 +2098,7 @@ declare namespace Xrm * * @sa Control */ - export interface StandardControl extends Control, UiStandardElement, UiFocusable - { + interface StandardControl extends Control, UiStandardElement, UiFocusable { /** * Clears the notification identified by uniqueId. * @@ -2178,7 +2108,7 @@ declare namespace Xrm * * @remarks If the uniqueId parameter is not used, the current notification shown will be removed. */ - clearNotification( uniqueId?: string ): boolean; + clearNotification(uniqueId?: string): boolean; /** * Gets a boolean value, indicating whether the control is disabled. @@ -2192,7 +2122,7 @@ declare namespace Xrm * * @param {boolean} disabled true to disable, false to enable. */ - setDisabled( disabled: boolean ): void; + setDisabled(disabled: boolean): void; /** * Sets a control-local notification message. @@ -2205,7 +2135,7 @@ declare namespace Xrm * @remarks When this method is used on Microsoft Dynamics CRM for tablets a red "X" icon * appears next to the control. Tapping on the icon will display the message. */ - setNotification( message: string, uniqueId: string ): boolean; + setNotification(message: string, uniqueId: string): boolean; /** * Gets the control's bound attribute. @@ -2232,8 +2162,7 @@ declare namespace Xrm * * @sa StandardControl */ - export interface AutoLookupControl extends StandardControl, UiKeyPressable - { + interface AutoLookupControl extends StandardControl, UiKeyPressable { /** * Gets the latest value in a control as the user types characters in a specific text or number field. * This method helps you to build interactive experiences by validating data and alerting users as they type characters in a control. @@ -2260,8 +2189,7 @@ declare namespace Xrm * * @sa StandardControl */ - export interface StringControl extends AutoLookupControl - { + interface StringControl extends AutoLookupControl { /** * Gets the control's bound attribute. * @@ -2275,8 +2203,7 @@ declare namespace Xrm * * @sa StandardControl */ - export interface NumberControl extends AutoLookupControl - { + interface NumberControl extends AutoLookupControl { /** * Gets the control's bound attribute. * @@ -2290,8 +2217,7 @@ declare namespace Xrm * * @sa StandardControl */ - export interface DateControl extends StandardControl - { + interface DateControl extends StandardControl { /** * Gets the control's bound attribute. * @@ -2311,7 +2237,7 @@ declare namespace Xrm * * @param {boolean} showTimeValue true to show, false to hide the time value. */ - setShowTime( showTimeValue: boolean ): void; + setShowTime(showTimeValue: boolean): void; } /** @@ -2319,14 +2245,13 @@ declare namespace Xrm * * @sa StandardControl */ - export interface LookupControl extends StandardControl - { + interface LookupControl extends StandardControl { /** * Adds a handler to the "pre search" event of the Lookup control. * * @param {Function} handler The handler. */ - addPreSearch( handler: ContextSensitiveHandler ): void; + addPreSearch(handler: ContextSensitiveHandler): void; /** * Adds an additional custom filter to the lookup, with the "AND" filter operator. @@ -2344,7 +2269,7 @@ declare namespace Xrm * * */ - addCustomFilter( filter: string, entityLogicalName?: string ): void; + addCustomFilter(filter: string, entityLogicalName?: string): void; /** * Adds a custom view for the Lookup dialog. @@ -2362,7 +2287,7 @@ declare namespace Xrm * Example viewId value: "{00000000-0000-0000-0000-000000000001}" * Layout XML Reference: {@link http://msdn.microsoft.com/en-us/library/gg334522.aspx} */ - addCustomView( viewId: string, entityName: string, viewDisplayName: string, fetchXml: string, layoutXml: string, isDefault: boolean ): void; + addCustomView(viewId: string, entityName: string, viewDisplayName: string, fetchXml: string, layoutXml: string, isDefault: boolean): void; /** * Gets the control's bound attribute. @@ -2385,7 +2310,7 @@ declare namespace Xrm * * @param {Function} handler The handler. */ - removePreSearch( handler: () => void ): void; + removePreSearch(handler: () => void): void; /** * Sets the Lookup's default view. @@ -2394,7 +2319,7 @@ declare namespace Xrm * * @remarks Example viewGuid value: "{00000000-0000-0000-0000-000000000000}" */ - setDefaultView( viewGuid: string ): void; + setDefaultView(viewGuid: string): void; } /** @@ -2402,8 +2327,7 @@ declare namespace Xrm * * @sa StandardControl */ - export interface OptionSetControl extends StandardControl - { + interface OptionSetControl extends StandardControl { /** * Adds an option. * @@ -2413,7 +2337,7 @@ declare namespace Xrm * @remarks This method does not check that the values within the options you add are valid. * If index is not provided, the new option will be added to the end of the list. */ - addOption( option: OptionSetValue, index?: number ): void; + addOption(option: OptionSetValue, index?: number): void; /** * Clears all options. @@ -2432,7 +2356,7 @@ declare namespace Xrm * * @param {number} value The value. */ - removeOption( value: number ): void; + removeOption(value: number): void; } /** @@ -2440,14 +2364,13 @@ declare namespace Xrm * * @sa Control */ - export interface GridControl extends Control - { + interface GridControl extends Control { /** * Use this method to add event handlers to the GridControl's OnLoad event. * * @param {Function} handler The event handler. */ - addOnLoad( handler: () => void ): void; + addOnLoad(handler: () => void): void; /** * This method returns context information about the GridControl. @@ -2489,7 +2412,7 @@ declare namespace Xrm * * @param {Function} handler The handler. */ - removeOnLoad( handler: () => void ): void; + removeOnLoad(handler: () => void): void; } /** @@ -2500,8 +2423,7 @@ declare namespace Xrm * @remarks An Iframe control provides additional methods, so use {@link IframeControl} where * appropriate. Silverlight controls should use {@link SilverlightControl}. */ - export interface FramedControl extends Control - { + interface FramedControl extends Control { /** * Gets the DOM element containing the control. * @@ -2527,7 +2449,7 @@ declare namespace Xrm * * @remarks Unavailable for Microsoft Dynamics CRM for tablets. */ - setSrc( src: string ): void; + setSrc(src: string): void; } /** @@ -2535,8 +2457,7 @@ declare namespace Xrm * * @sa FramedControl */ - export interface IframeControl extends FramedControl, UiCanSetVisibleElement - { + interface IframeControl extends FramedControl, UiCanSetVisibleElement { /** * Gets initial URL defined for the Iframe. * @@ -2552,8 +2473,7 @@ declare namespace Xrm * * @sa Control */ - export interface SilverlightControl extends Control - { + interface SilverlightControl extends Control { /** * Gets the query string value passed to Silverlight. * @@ -2570,7 +2490,7 @@ declare namespace Xrm * * @remarks Unavailable for Microsoft Dynamics CRM for tablets. */ - setData( data: string ): void; + setData(data: string): void; /** * Gets the DOM element containing the control. @@ -2588,8 +2508,7 @@ declare namespace Xrm * @sa UiElement * @sa UiFocusable */ - export interface Tab extends UiStandardElement, UiFocusable - { + interface Tab extends UiStandardElement, UiFocusable { /** * Gets display state of the tab. * @@ -2616,7 +2535,7 @@ declare namespace Xrm * * @param {string} displayState Display state of the tab, as either "expanded" or "collapsed" */ - setDisplayState(displayState: ui.DisplayState ): void; + setDisplayState(displayState: ui.DisplayState): void; /** * A reference to the collection of form sections within this tab. @@ -2629,8 +2548,7 @@ declare namespace Xrm * * @sa UiElement */ - export interface Section extends UiStandardElement - { + interface Section extends UiStandardElement { /** * Gets the name of the section. * @@ -2654,44 +2572,41 @@ declare namespace Xrm /** * Module for Xrm.Page.ui API. */ - export module ui - { + namespace ui { /** * Form Notification Levels for Xrm.Ui.setFormNotification(). */ - export type FormNotificationLevel = "ERROR" | "INFO" | "WARNING"; + type FormNotificationLevel = "ERROR" | "INFO" | "WARNING"; /** * Display States for Xrm.ui.ProcessMonitor.setDisplayState(). */ - export type DisplayState = "collapsed" | "expanded"; + type DisplayState = "collapsed" | "expanded"; /** * Interface for Xrm.Page.ui.process API */ - export interface ProcessManager - { + interface ProcessManager { /** * Sets display state of the process flow control. * * @param {string} displayState Display state of the process flow control, as either "expanded" or "collapsed" */ - setDisplayState( displayState: ui.DisplayState ): void; + setDisplayState(displayState: ui.DisplayState): void; /** * Sets the visibility state. * * @param {boolean} visible true to show, false to hide. */ - setVisible( visible: boolean ): void; + setVisible(visible: boolean): void; } /** * Interface for a grid. Use Grid methods to access information about data in the grid. Grid is returned by the * GridControl.getGrid method. */ - export interface Grid - { + interface Grid { /** * Returns a collection of every GridRow in the Grid. * @@ -2718,8 +2633,7 @@ declare namespace Xrm * Interface for a grid row. Use the GridRow.getData method to access the GridRowData. A collection of GridRow is * returned by Grid.getRows and Grid.getSelectedRows methods. */ - export interface GridRow - { + interface GridRow { /** * Returns the GridRowData for the GridRow. * @@ -2732,8 +2646,7 @@ declare namespace Xrm * Interface for grid row data. Use the GridRowData.getEntity method to access the GridEntity. GridRowData is * returned by the GridRow.getData method. */ - export interface GridRowData - { + interface GridRowData { /** * Returns the GridEntity for the GridRowData. * @@ -2746,8 +2659,7 @@ declare namespace Xrm * Interface for a grid entity. Use the GridEntity methods to access data about the specific records in the rows. * GridEntity is returned by the GridRowData.getEntity method. */ - export interface GridEntity - { + interface GridEntity { /** * Returns the logical name for the record in the row. * @@ -2783,8 +2695,7 @@ declare namespace Xrm * Interface for the view selector. Use the ViewSelector methods to get or set information about the view selector * of the grid control. */ - export interface ViewSelector - { + interface ViewSelector { /** * Use this method to get a reference to the current view. * @@ -2804,15 +2715,14 @@ declare namespace Xrm * * @param {ViewSelectorItem} viewSelectorItem The view selector item. */ - setCurrentView( viewSelectorItem: ViewSelectorItem ): void; + setCurrentView(viewSelectorItem: ViewSelectorItem): void; } /** * Interface for a view selector item. This object contains data that identifies a view. Use this as a parameter to * the ViewSelector.setCurrentView method. */ - export interface ViewSelectorItem - { + interface ViewSelectorItem { /** * Returns a LookupValue that references this view. * @@ -2826,8 +2736,7 @@ declare namespace Xrm * * @see {@link https://msdn.microsoft.com/en-us/library/mt736908.aspx#bkmk_isLoaded} for details. */ - export interface QuickForm extends Control, UiLabelElement, UiCanGetVisibleElement - { + interface QuickForm extends Control, UiLabelElement, UiCanGetVisibleElement { /** * Gets the constituent controls in a quick view control. * @@ -2847,7 +2756,7 @@ declare namespace Xrm * * @remarks Constituent controls in a quick view control are read only. */ - getControl( controlName: string ): T; + getControl(controlName: string): T; /** * Gets the constituent controls in a quick view control. @@ -2858,7 +2767,7 @@ declare namespace Xrm * * @remarks Constituent controls in a quick view control are read only. */ - getControl( controlName: string ): Page.Control; + getControl(controlName: string): Page.Control; /** * Gets a control by index. @@ -2870,7 +2779,7 @@ declare namespace Xrm * * @remarks Constituent controls in a quick view control are read only. */ - getControl( index: number ): T; + getControl(index: number): T; /** * Gets a control by index. @@ -2881,7 +2790,7 @@ declare namespace Xrm * * @remarks Constituent controls in a quick view control are read only. */ - getControl( index: number ): Page.Control; + getControl(index: number): Page.Control; /** * Gets the controls type. @@ -2915,8 +2824,7 @@ declare namespace Xrm * @sa UiElement * @sa UiFocusable */ - export interface NavigationItem extends UiStandardElement, UiFocusable - { + interface NavigationItem extends UiStandardElement, UiFocusable { /** * Gets the name of the item. * @@ -2928,8 +2836,7 @@ declare namespace Xrm /** * Interface for Xrm.Page.ui.navigation. */ - export interface Navigation - { + interface Navigation { /** * A reference to the collection of available navigation items. */ @@ -2939,8 +2846,7 @@ declare namespace Xrm /** * Interface for an entity's form selector item. */ - export interface FormItem - { + interface FormItem { /** * Gets the unique identifier of the form. * @@ -2964,8 +2870,7 @@ declare namespace Xrm /** * Interface for the form selector API. */ - export interface FormSelector - { + interface FormSelector { /** * Gets current form. * @@ -2987,22 +2892,21 @@ declare namespace Xrm * * @see {@link http://msdn.microsoft.com/en-us/library/gg328483.aspx} for details. */ - export module Url - { + namespace Url { /** * Command Bar Display options for Xrm.Url.FormOpenParameters.cmdbar, Xrm.Url.ViewOpenParameters.cmdbar, and Xrm.Utility.FormOpenParameters.cmdbar. */ - export type CmdBarDisplay = "true" | "false"; + type CmdBarDisplay = "true" | "false"; /** * Navigation Bar Display options for Xrm.Url.FormOpenParameters.navbar, Xrm.Url.ViewOpenParameters.navbar, and Xrm.Utility.FormOpenParameters.navbar. */ - export type NavBarDisplay = "entity" | "off" | "on"; + type NavBarDisplay = "entity" | "off" | "on"; /** * Report Open Action options for Xrm.Url.ReportOpenParameters.actions. */ - export type ReportAction = "filter" | "run"; + type ReportAction = "filter" | "run"; /** * Interface for defining parameters on a request to open a form with main.aspx (as with @@ -3014,8 +2918,7 @@ declare namespace Xrm * @remarks A member for "pagetype" is not provided. The value "entityrecord" is required in * the URL, for forms. Example: "pagetype=entityrecord" */ - export interface FormOpenParameters - { + interface FormOpenParameters { /** * The logical name of the entity. */ @@ -3026,7 +2929,7 @@ declare namespace Xrm * default field values for the form, or pass data to custom parameters that have been * customized for the form. See example below for setting the selected form. * - * @remarks Example: encodeURIComponent( "formid={8c9f3e6f-7839-e211-831e-00155db7d98f}" ); + * @remarks Example: encodeURIComponent("formid={8c9f3e6f-7839-e211-831e-00155db7d98f}"); */ extraqs?: string; @@ -3057,8 +2960,7 @@ declare namespace Xrm * @remarks A member for "pagetype" is not provided. The value "entitylist" is required in * the URL, for views. Example: "pagetype=entitylist" */ - export interface ViewOpenParameters - { + interface ViewOpenParameters { /** * The logical name of the entity. */ @@ -3102,8 +3004,7 @@ declare namespace Xrm * * @see {@link http://msdn.microsoft.com/en-us/library/gg328483.aspx} for details. */ - export interface DialogOpenParameters - { + interface DialogOpenParameters { /** * The unique identifier of the dialog, in Guid format, which is valid for the entity described * by: {@link EntityName} @@ -3128,8 +3029,7 @@ declare namespace Xrm * * @see {@link http://msdn.microsoft.com/en-us/library/gg328483.aspx} for details. */ - export interface ReportOpenParameters - { + interface ReportOpenParameters { /** * The action to perform, as either "run" or "filter". * @@ -3156,10 +3056,8 @@ declare namespace Xrm * * @see {@link http://msdn.microsoft.com/en-us/library/gg328255.aspx|Documentation} for details. */ - export module Utility - { - export interface OpenParameters - { + namespace Utility { + interface OpenParameters { /** * Additional parameters can be provided to the request, by overloading * this object with additional key and value pairs. This can only be used @@ -3172,8 +3070,7 @@ declare namespace Xrm /** * Interface for defining parameters on a Xrm.Utility.openEntityForm() request. */ - export interface FormOpenParameters extends OpenParameters - { + interface FormOpenParameters extends OpenParameters { /** * The identifier of the form to use, when several are available. */ @@ -3199,8 +3096,7 @@ declare namespace Xrm /** * Interface for window options. */ - export interface WindowOptions - { + interface WindowOptions { /** * Direct the form to open in a new window. */ @@ -3209,13 +3105,11 @@ declare namespace Xrm } } -declare namespace XrmEnum -{ +declare namespace XrmEnum { /** * Enumeration of entity form states/types. */ - export const enum FormType - { + const enum FormType { Undefined = 0, Create = 1, Update = 2, @@ -3227,8 +3121,7 @@ declare namespace XrmEnum /** * Enumeration of entity form save modes. */ - export const enum SaveMode - { + const enum SaveMode { Save = 1, SaveAndClose = 2, SaveAndNew = 59, @@ -3245,8 +3138,7 @@ declare namespace XrmEnum /** * Enumeration of stage categories. */ - export const enum StageCategory - { + const enum StageCategory { Qualify = 0, Develop = 1, Propose = 2, @@ -3259,8 +3151,7 @@ declare namespace XrmEnum /** * Enumeration of grid control context resolutions. */ - export const enum GridControlContext - { + const enum GridControlContext { Unknown = 0, RibbonContextForm = 1, RibbonContextListing = 2, @@ -3271,9 +3162,8 @@ declare namespace XrmEnum /** * An enumeration for view types. */ - export const enum ViewType - { + const enum ViewType { SystemView = 1039, UserView = 4230 } -} \ No newline at end of file +} diff --git a/types/xrm/tslint.json b/types/xrm/tslint.json index a11cf19d39..51ae1b527a 100644 --- a/types/xrm/tslint.json +++ b/types/xrm/tslint.json @@ -2,63 +2,16 @@ "extends": "../tslint.json", "rules": { // TODOs - "callable-types": false, "unified-signatures": false, "class-name": true, - "comment-format": [ - true, - "check-space" - ], "indent": [ true, "spaces" ], - "no-duplicate-variable": true, - "no-eval": true, - "no-internal-module": false, - "no-trailing-whitespace": false, - "no-var-keyword": true, - "one-line": [ - true, - "check-whitespace" - ], "quotemark": [ true, "double" ], - "semicolon": true, - "triple-equals": [ - true, - "allow-null-check" - ], - "align": [ - true, - "parameters", - "statements" - ], - "jsdoc-format": true, - "no-consecutive-blank-lines": true, - "typedef-whitespace": [ - true, - { - "call-signature": "nospace", - "index-signature": "nospace", - "parameter": "nospace", - "property-declaration": "nospace", - "variable-declaration": "nospace" - } - ], - "variable-name": [ - true, - "ban-keywords" - ], - "whitespace": [ - true, - "check-branch", - "check-decl", - "check-operator", - "check-separator", - "check-type" - ] + "jsdoc-format": true } } diff --git a/types/xrm/xrm-tests.ts b/types/xrm/xrm-tests.ts index 0ef578aac0..5d9d99b644 100644 --- a/types/xrm/xrm-tests.ts +++ b/types/xrm/xrm-tests.ts @@ -1,23 +1,18 @@ - /// Demonstrate usage in the browser's window object -window.Xrm.Utility.alertDialog( "message", () => {} ); +window.Xrm.Utility.alertDialog("message", () => {}); parent.Xrm.Page.context.getOrgLcid(); /// Demonstrate clientglobalcontext.d.ts -function _getContext() -{ +function _getContext() { const errorMessage = "Context is not available."; - if ( typeof GetGlobalContext !== "undefined" ) - { return GetGlobalContext(); } - else - { - if ( typeof Xrm !== "undefined" ) - { - return Xrm.Page.context; - } - else { throw new Error( errorMessage ); } + if (typeof GetGlobalContext !== "undefined") { + return GetGlobalContext(); + } else if (typeof Xrm !== "undefined") { + return Xrm.Page.context; + } else { + throw new Error(errorMessage); } } @@ -25,8 +20,7 @@ const crmContext = _getContext(); /// Demonstrate iterator typing -const grids = Xrm.Page.getControl(( control ) => -{ +const grids = Xrm.Page.getControl((control) => { return control.getControlType() === "subgrid"; }); @@ -34,8 +28,7 @@ const selectedGridReferences: Xrm.Page.LookupValue[] = []; /// Demonstrate iterator typing with v7.1 additions -grids.forEach(( gridControl: Xrm.Page.GridControl ) => -{ +grids.forEach((gridControl: Xrm.Page.GridControl) => { gridControl.getGrid().getSelectedRows().forEach((row) => { selectedGridReferences.push(row.getData().getEntity().getEntityReference()); }); @@ -43,72 +36,69 @@ grids.forEach(( gridControl: Xrm.Page.GridControl ) => /// Demonstrate generic overload vs typecast -const lookupAttribute = Xrm.Page.getControl( "customerid" ); -const lookupAttribute2 = Xrm.Page.getControl( "customerid" ); +const lookupAttribute = Xrm.Page.getControl("customerid"); +const lookupAttribute2 = Xrm.Page.getControl("customerid"); /// Demonstrate ES6 String literal syntax -lookupAttribute.addCustomFilter( ` +lookupAttribute.addCustomFilter(` -`, "account" ); +`, "account"); -lookupAttribute.addPreSearch(() => { alert( "A search was performed." ); }); +lookupAttribute.addPreSearch(() => { alert("A search was performed."); }); /// Demonstrate strong-typed attribute association with strong-typed control const lookupValues = lookupAttribute.getAttribute().getValue(); -if ( lookupValues !== null ) - if ( !lookupValues[0].id || !lookupValues[0].entityType ) +if (lookupValues !== null) + if (!lookupValues[0].id || !lookupValues[0].entityType) throw new Error("Invalid value in Lookup control."); /// Demonstrate v7.0 BPF API if (Xrm.Page.data.process != null) - Xrm.Page.data.process.moveNext(( status ) => { alert( `Process moved forward with status: ${status}` ); }); + Xrm.Page.data.process.moveNext((status) => { alert(`Process moved forward with status: ${status}`); }); /// Demonstrate v7.1 Quick Create form Xrm.Utility.openQuickCreate("account").then( - (object) => { if (object) alert( `Newly created record Id: ${object.savedEntityReference.id}` ); }, + (object) => { if (object) alert(`Newly created record Id: ${object.savedEntityReference.id}`); }, (error) => {console.log(`Code: ${error.errorCode}, Message: ${error.message}`); }); /// Make all controls visible. -// Xrm.Page.ui.controls.forEach(( control ) => { control.setVisible( true ); }); // No longer works +// Xrm.Page.ui.controls.forEach((control) => { control.setVisible(true); }); // No longer works Xrm.Page.ui.controls.forEach((control: Xrm.Page.StandardControl) => { control.setVisible(true); }); // Must cast to StandardControl /// Make all tabs and sections visible. -Xrm.Page.ui.tabs.forEach(( tab ) => -{ - tab.setVisible( true ); +Xrm.Page.ui.tabs.forEach((tab) => { + tab.setVisible(true); - tab.sections.forEach(( section ) => - { - section.setVisible( true ); + tab.sections.forEach((section) => { + section.setVisible(true); }); }); /// Demonstrate OnSave event context. -Xrm.Page.data.entity.addOnSave(( context ) => -{ +Xrm.Page.data.entity.addOnSave((context) => { const eventArgs = context.getEventArgs(); - if ( eventArgs.getSaveMode() === XrmEnum.SaveMode.AutoSave || eventArgs.getSaveMode() === XrmEnum.SaveMode.SaveAndClose ) + if (eventArgs.getSaveMode() === XrmEnum.SaveMode.AutoSave || eventArgs.getSaveMode() === XrmEnum.SaveMode.SaveAndClose) eventArgs.preventDefault(); }); /// Demonstrate ES6 String literal with templates -alert( `The current form type is: ${Xrm.Page.ui.getFormType() }` ); +alert(`The current form type is: ${Xrm.Page.ui.getFormType() }`); -alert( `The current entity type is: ${Xrm.Page.data.entity.getEntityName() }` ); +alert(`The current entity type is: ${Xrm.Page.data.entity.getEntityName() }`); /// Demonstrate Optionset Value as int in Turbo Forms -const optionSetAttribute = Xrm.Page.getAttribute( "statuscode" ); +const optionSetAttribute = Xrm.Page.getAttribute("statuscode"); const optionValue: number = optionSetAttribute.getOptions()[0].value; /// Demonstrate Control.setFocus();